// Copyright © 2023 OpenIM. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package log import ( "context" "fmt" "os" "path/filepath" "time" "github.com/OpenIMSDK/Open-IM-Server/pkg/common/config" "github.com/OpenIMSDK/Open-IM-Server/pkg/common/constant" "github.com/OpenIMSDK/Open-IM-Server/pkg/common/mcontext" rotatelogs "github.com/lestrrat-go/file-rotatelogs" "go.uber.org/zap" "go.uber.org/zap/zapcore" ) var ( pkgLogger Logger sp = string(filepath.Separator) logLevelMap = map[int]zapcore.Level{ 6: zapcore.DebugLevel, 5: zapcore.DebugLevel, 4: zapcore.InfoLevel, 3: zapcore.WarnLevel, 2: zapcore.ErrorLevel, 1: zapcore.FatalLevel, 0: zapcore.PanicLevel, } ) // InitFromConfig initializes a Zap-based logger func InitFromConfig(loggerPrefixName, moduleName string, logLevel int, isStdout bool, isJson bool, logLocation string, rotateCount uint) error { l, err := NewZapLogger(loggerPrefixName, moduleName, logLevel, isStdout, isJson, logLocation, rotateCount) if err != nil { return err } pkgLogger = l.WithCallDepth(2) if isJson { pkgLogger = pkgLogger.WithName(moduleName) } return nil } func ZDebug(ctx context.Context, msg string, keysAndValues ...interface{}) { if pkgLogger == nil { return } pkgLogger.Debug(ctx, msg, keysAndValues...) } func ZInfo(ctx context.Context, msg string, keysAndValues ...interface{}) { if pkgLogger == nil { return } pkgLogger.Info(ctx, msg, keysAndValues...) } func ZWarn(ctx context.Context, msg string, err error, keysAndValues ...interface{}) { if pkgLogger == nil { return } pkgLogger.Warn(ctx, msg, err, keysAndValues...) } func ZError(ctx context.Context, msg string, err error, keysAndValues ...interface{}) { if pkgLogger == nil { return } pkgLogger.Error(ctx, msg, err, keysAndValues...) } type ZapLogger struct { zap *zap.SugaredLogger level zapcore.Level loggerName string loggerPrefixName string } func NewZapLogger(loggerPrefixName, loggerName string, logLevel int, isStdout bool, isJson bool, logLocation string, rotateCount uint) (*ZapLogger, error) { zapConfig := zap.Config{ Level: zap.NewAtomicLevelAt(logLevelMap[logLevel]), // EncoderConfig: zap.NewProductionEncoderConfig(), // InitialFields: map[string]interface{}{"PID": os.Getegid()}, DisableStacktrace: true, } if isJson { zapConfig.Encoding = "json" } else { zapConfig.Encoding = "console" } // if isStdout { // zapConfig.OutputPaths = append(zapConfig.OutputPaths, "stdout", "stderr") // } zl := &ZapLogger{level: logLevelMap[logLevel], loggerName: loggerName, loggerPrefixName: loggerPrefixName} opts, err := zl.cores(isStdout, isJson, logLocation, rotateCount) if err != nil { return nil, err } l, err := zapConfig.Build(opts) if err != nil { return nil, err } zl.zap = l.Sugar() return zl, nil } func (l *ZapLogger) cores(isStdout bool, isJson bool, logLocation string, rotateCount uint) (zap.Option, error) { c := zap.NewProductionEncoderConfig() c.EncodeTime = l.timeEncoder c.EncodeDuration = zapcore.SecondsDurationEncoder c.MessageKey = "msg" c.LevelKey = "level" c.TimeKey = "time" c.CallerKey = "caller" c.NameKey = "logger" var fileEncoder zapcore.Encoder if isJson { c.EncodeLevel = zapcore.CapitalLevelEncoder fileEncoder = zapcore.NewJSONEncoder(c) fileEncoder.AddInt("PID", os.Getpid()) } else { c.EncodeLevel = l.capitalColorLevelEncoder c.EncodeCaller = l.customCallerEncoder fileEncoder = zapcore.NewConsoleEncoder(c) } writer, err := l.getWriter(logLocation, rotateCount) if err != nil { return nil, err } var cores []zapcore.Core // if logLocation == "" && !isStdout { // return nil, errors.New("log storage location is empty and not stdout") // } if logLocation != "" { cores = []zapcore.Core{ zapcore.NewCore(fileEncoder, writer, zap.NewAtomicLevelAt(l.level)), } } if isStdout { cores = append(cores, zapcore.NewCore(fileEncoder, zapcore.Lock(os.Stdout), zap.NewAtomicLevelAt(l.level))) // cores = append(cores, zapcore.NewCore(fileEncoder, zapcore.Lock(os.Stderr), zap.NewAtomicLevelAt(l.level))) } return zap.WrapCore(func(c zapcore.Core) zapcore.Core { return zapcore.NewTee(cores...) }), nil } func (l *ZapLogger) customCallerEncoder(caller zapcore.EntryCaller, enc zapcore.PrimitiveArrayEncoder) { s := "[" + caller.TrimmedPath() + "]" // color, ok := _levelToColor[l.level] // if !ok { // color = _levelToColor[zapcore.ErrorLevel] // } enc.AppendString(s) } func (l *ZapLogger) timeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) { layout := "2006-01-02 15:04:05.000" type appendTimeEncoder interface { AppendTimeLayout(time.Time, string) } if enc, ok := enc.(appendTimeEncoder); ok { enc.AppendTimeLayout(t, layout) return } enc.AppendString(t.Format(layout)) } func (l *ZapLogger) getWriter(logLocation string, rorateCount uint) (zapcore.WriteSyncer, error) { logf, err := rotatelogs.New(logLocation+sp+l.loggerPrefixName+".%Y-%m-%d", rotatelogs.WithRotationCount(rorateCount), rotatelogs.WithRotationTime(time.Duration(config.Config.Log.RotationTime)*time.Hour), ) if err != nil { return nil, err } return zapcore.AddSync(logf), nil } func (l *ZapLogger) capitalColorLevelEncoder(level zapcore.Level, enc zapcore.PrimitiveArrayEncoder) { s, ok := _levelToCapitalColorString[level] if !ok { s = _unknownLevelColor[zapcore.ErrorLevel] } pid := fmt.Sprintf("["+"PID:"+"%d"+"]", os.Getpid()) color := _levelToColor[level] enc.AppendString(s) enc.AppendString(color.Add(pid)) if l.loggerName != "" { enc.AppendString(color.Add(l.loggerName)) } } func (l *ZapLogger) ToZap() *zap.SugaredLogger { return l.zap } func (l *ZapLogger) Debug(ctx context.Context, msg string, keysAndValues ...interface{}) { keysAndValues = l.kvAppend(ctx, keysAndValues) l.zap.Debugw(msg, keysAndValues...) } func (l *ZapLogger) Info(ctx context.Context, msg string, keysAndValues ...interface{}) { keysAndValues = l.kvAppend(ctx, keysAndValues) l.zap.Infow(msg, keysAndValues...) } func (l *ZapLogger) Warn(ctx context.Context, msg string, err error, keysAndValues ...interface{}) { if err != nil { keysAndValues = append(keysAndValues, "error", err.Error()) } keysAndValues = l.kvAppend(ctx, keysAndValues) l.zap.Warnw(msg, keysAndValues...) } func (l *ZapLogger) Error(ctx context.Context, msg string, err error, keysAndValues ...interface{}) { if err != nil { keysAndValues = append(keysAndValues, "error", err.Error()) } keysAndValues = l.kvAppend(ctx, keysAndValues) l.zap.Errorw(msg, keysAndValues...) } func (l *ZapLogger) kvAppend(ctx context.Context, keysAndValues []interface{}) []interface{} { if ctx == nil { return keysAndValues } operationID := mcontext.GetOperationID(ctx) opUserID := mcontext.GetOpUserID(ctx) connID := mcontext.GetConnID(ctx) triggerID := mcontext.GetTriggerID(ctx) opUserPlatform := mcontext.GetOpUserPlatform(ctx) remoteAddr := mcontext.GetRemoteAddr(ctx) if opUserID != "" { keysAndValues = append([]interface{}{constant.OpUserID, opUserID}, keysAndValues...) } if operationID != "" { keysAndValues = append([]interface{}{constant.OperationID, operationID}, keysAndValues...) } if connID != "" { keysAndValues = append([]interface{}{constant.ConnID, connID}, keysAndValues...) } if triggerID != "" { keysAndValues = append([]interface{}{constant.TriggerID, triggerID}, keysAndValues...) } if opUserPlatform != "" { keysAndValues = append([]interface{}{constant.OpUserPlatform, opUserPlatform}, keysAndValues...) } if remoteAddr != "" { keysAndValues = append([]interface{}{constant.RemoteAddr, remoteAddr}, keysAndValues...) } return keysAndValues } func (l *ZapLogger) WithValues(keysAndValues ...interface{}) Logger { dup := *l dup.zap = l.zap.With(keysAndValues...) return &dup } func (l *ZapLogger) WithName(name string) Logger { dup := *l dup.zap = l.zap.Named(name) return &dup } func (l *ZapLogger) WithCallDepth(depth int) Logger { dup := *l dup.zap = l.zap.WithOptions(zap.AddCallerSkip(depth)) return &dup }