mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
bb659d03fd
Fix an issue where context fields logged by server on behalf of plugins didn't contain correct name/value pairs:
- bump Logr version to add key/value methods to sugar logger
- expose factory args when configuring logging with custom target types (needed for FocalBoard to create log target adapter that converts typed fields into slices of interface{} as per plugin logging API)
108 lines
2.9 KiB
Go
108 lines
2.9 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package audit
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/mattermost/mattermost-server/v6/shared/mlog"
|
|
)
|
|
|
|
type Audit struct {
|
|
logger *mlog.Logger
|
|
|
|
// OnQueueFull is called on an attempt to add an audit record to a full queue.
|
|
// Return true to drop record, or false to block until there is room in queue.
|
|
OnQueueFull func(qname string, maxQueueSize int) bool
|
|
|
|
// OnError is called when an error occurs while writing an audit record.
|
|
OnError func(err error)
|
|
}
|
|
|
|
func (a *Audit) Init(maxQueueSize int) {
|
|
a.logger, _ = mlog.NewLogger(
|
|
mlog.MaxQueueSize(maxQueueSize),
|
|
mlog.OnLoggerError(a.onLoggerError),
|
|
mlog.OnQueueFull(a.onQueueFull),
|
|
mlog.OnTargetQueueFull(a.onTargetQueueFull),
|
|
)
|
|
}
|
|
|
|
// LogRecord emits an audit record with complete info.
|
|
func (a *Audit) LogRecord(level mlog.Level, rec Record) {
|
|
flds := []mlog.Field{
|
|
mlog.String(KeyAPIPath, rec.APIPath),
|
|
mlog.String(KeyEvent, rec.Event),
|
|
mlog.String(KeyStatus, rec.Status),
|
|
mlog.String(KeyUserID, rec.UserID),
|
|
mlog.String(KeySessionID, rec.SessionID),
|
|
mlog.String(KeyClient, rec.Client),
|
|
mlog.String(KeyIPAddress, rec.IPAddress),
|
|
}
|
|
|
|
for k, v := range rec.Meta {
|
|
flds = append(flds, mlog.Any(k, v))
|
|
}
|
|
a.logger.Log(level, "", flds...)
|
|
}
|
|
|
|
// Log emits an audit record based on minimum required info.
|
|
func (a *Audit) Log(level mlog.Level, path string, evt string, status string, userID string, sessionID string, meta Meta) {
|
|
a.LogRecord(level, Record{
|
|
APIPath: path,
|
|
Event: evt,
|
|
Status: status,
|
|
UserID: userID,
|
|
SessionID: sessionID,
|
|
Meta: meta,
|
|
})
|
|
}
|
|
|
|
// Configure sets zero or more target to output audit logs to.
|
|
func (a *Audit) Configure(cfg mlog.LoggerConfiguration) error {
|
|
return a.logger.ConfigureTargets(cfg, nil)
|
|
}
|
|
|
|
// Flush attempts to write all queued audit records to all targets.
|
|
func (a *Audit) Flush() error {
|
|
err := a.logger.Flush()
|
|
if err != nil {
|
|
a.onLoggerError(err)
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Shutdown cleanly stops the audit engine after making best efforts to flush all targets.
|
|
func (a *Audit) Shutdown() error {
|
|
err := a.logger.Shutdown()
|
|
if err != nil {
|
|
a.onLoggerError(err)
|
|
}
|
|
return err
|
|
}
|
|
|
|
func (a *Audit) onQueueFull(rec *mlog.LogRec, maxQueueSize int) bool {
|
|
if a.OnQueueFull != nil {
|
|
return a.OnQueueFull("main", maxQueueSize)
|
|
}
|
|
mlog.Error("Audit logging queue full, dropping record.", mlog.Int("queueSize", maxQueueSize))
|
|
return true
|
|
}
|
|
|
|
func (a *Audit) onTargetQueueFull(target mlog.Target, rec *mlog.LogRec, maxQueueSize int) bool {
|
|
if a.OnQueueFull != nil {
|
|
return a.OnQueueFull(fmt.Sprintf("%v", target), maxQueueSize)
|
|
}
|
|
mlog.Error("Audit logging queue full for target, dropping record.", mlog.Any("target", target), mlog.Int("queueSize", maxQueueSize))
|
|
return true
|
|
}
|
|
|
|
func (a *Audit) onLoggerError(err error) {
|
|
if a.OnError != nil {
|
|
a.OnError(err)
|
|
return
|
|
}
|
|
mlog.Error("Auditing error", mlog.Err(err))
|
|
}
|