mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
1b67322fb9
MM-27744 disable Zap for unit tests. Zap has no concept of shutdown or close. Zap is only shutdown when the app exits. Not a problem for console logging, but when creating a new Zap logger that outputs to files on every unit test, that leaves no easy way to clean up until process exit. Depending on what else is running this can exhaust all file handles and cause unit tests to fail. Zap is now disabled unit tests and uses Logr instead, regardless of config settings. `make test-server` peak file handle usage dropped from ~5K to less than 100.
96 lines
2.6 KiB
Go
96 lines
2.6 KiB
Go
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
|
// See LICENSE.txt for license information.
|
|
|
|
package mlog
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/mattermost/logr"
|
|
)
|
|
|
|
// defaultLog manually encodes the log to STDERR, providing a basic, default logging implementation
|
|
// before mlog is fully configured.
|
|
func defaultLog(level, msg string, fields ...Field) {
|
|
log := struct {
|
|
Level string `json:"level"`
|
|
Message string `json:"msg"`
|
|
Fields []Field `json:"fields,omitempty"`
|
|
}{
|
|
level,
|
|
msg,
|
|
fields,
|
|
}
|
|
|
|
if b, err := json.Marshal(log); err != nil {
|
|
fmt.Fprintf(os.Stderr, `{"level":"error","msg":"failed to encode log message"}%s`, "\n")
|
|
} else {
|
|
fmt.Fprintf(os.Stderr, "%s\n", b)
|
|
}
|
|
}
|
|
|
|
func defaultDebugLog(msg string, fields ...Field) {
|
|
defaultLog("debug", msg, fields...)
|
|
}
|
|
|
|
func defaultInfoLog(msg string, fields ...Field) {
|
|
defaultLog("info", msg, fields...)
|
|
}
|
|
|
|
func defaultWarnLog(msg string, fields ...Field) {
|
|
defaultLog("warn", msg, fields...)
|
|
}
|
|
|
|
func defaultErrorLog(msg string, fields ...Field) {
|
|
defaultLog("error", msg, fields...)
|
|
}
|
|
|
|
func defaultCriticalLog(msg string, fields ...Field) {
|
|
// We map critical to error in zap, so be consistent.
|
|
defaultLog("error", msg, fields...)
|
|
}
|
|
|
|
func defaultCustomLog(lvl LogLevel, msg string, fields ...Field) {
|
|
// custom log levels are only output once log targets are configured.
|
|
}
|
|
|
|
func defaultCustomMultiLog(lvl []LogLevel, msg string, fields ...Field) {
|
|
// custom log levels are only output once log targets are configured.
|
|
}
|
|
|
|
func defaultFlush(ctx context.Context) error {
|
|
return nil
|
|
}
|
|
|
|
func defaultAdvancedConfig(cfg LogTargetCfg) error {
|
|
// mlog.ConfigAdvancedConfig should not be called until default
|
|
// logger is replaced with mlog.Logger instance.
|
|
return errors.New("cannot config advanced logging on default logger")
|
|
}
|
|
|
|
func defaultAdvancedShutdown(ctx context.Context) error {
|
|
return nil
|
|
}
|
|
|
|
func defaultAddTarget(targets ...logr.Target) error {
|
|
// mlog.AddTarget should not be called until default
|
|
// logger is replaced with mlog.Logger instance.
|
|
return errors.New("cannot AddTarget on default logger")
|
|
}
|
|
|
|
func defaultRemoveTargets(ctx context.Context, f func(TargetInfo) bool) error {
|
|
// mlog.RemoveTargets should not be called until default
|
|
// logger is replaced with mlog.Logger instance.
|
|
return errors.New("cannot RemoveTargets on default logger")
|
|
}
|
|
|
|
func defaultEnableMetrics(collector logr.MetricsCollector) error {
|
|
// mlog.EnableMetrics should not be called until default
|
|
// logger is replaced with mlog.Logger instance.
|
|
return errors.New("cannot EnableMetrics on default logger")
|
|
}
|