// Licensed to the LF AI & Data foundation under one // or more contributor license agreements. See the NOTICE file // distributed with this work for additional information // regarding copyright ownership. The ASF licenses this file // to you 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 logutil import ( "context" "sync" "github.com/milvus-io/milvus/internal/log" "go.uber.org/zap/zapcore" "google.golang.org/grpc/grpclog" "go.uber.org/zap" ) const ( // infoLog indicates Info severity. infoLog int = iota // warningLog indicates Warning severity. warningLog // errorLog indicates Error severity. errorLog ) type zapWrapper struct { logger *zap.Logger logLevel int } // Info logs a message at InfoLevel. func (w *zapWrapper) Info(args ...interface{}) { if infoLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Info(args...) } } func (w *zapWrapper) Infoln(args ...interface{}) { if infoLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Info(args...) } } func (w zapWrapper) Infof(format string, args ...interface{}) { if infoLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Infof(format, args...) } } func (w zapWrapper) Warning(args ...interface{}) { if warningLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Warn(args...) } } func (w zapWrapper) Warningln(args ...interface{}) { if warningLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Warn(args...) } } func (w *zapWrapper) Warningf(format string, args ...interface{}) { if warningLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Warnf(format, args...) } } func (w zapWrapper) Error(args ...interface{}) { if errorLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Error(args...) } } func (w *zapWrapper) Errorln(args ...interface{}) { if errorLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Error(args...) } } func (w zapWrapper) Errorf(format string, args ...interface{}) { if errorLog >= w.logLevel { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Errorf(format, args...) } } func (w *zapWrapper) Fatal(args ...interface{}) { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Fatal(args...) } func (w zapWrapper) Fatalln(args ...interface{}) { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Fatal(args...) } func (w *zapWrapper) Fatalf(format string, args ...interface{}) { w.logger.WithOptions(zap.AddCallerSkip(1)).Sugar().Fatalf(format, args...) } // V reports whether verbosity level l is at least the requested verbose level. // grpc LoggerV2 // 0=info, 1=warning, 2=error, 3=fatal // zap // -1=debug, 0=info, 1=warning, 2=error, 3=dpanic, 4=panic, 5=fatal func (w *zapWrapper) V(l int) bool { if l < w.logLevel { return false } zapLevel := l if l == 3 { zapLevel = 5 } return w.logger.Core().Enabled(zapcore.Level(zapLevel)) } // LogPanic logs the panic reason and stack, then exit the process. // Commonly used with a `defer`. func LogPanic() { if e := recover(); e != nil { log.Fatal("panic", zap.Reflect("recover", e)) } } var once sync.Once // SetupLogger is used to initialize the log with config. func SetupLogger(cfg *log.Config) { once.Do(func() { // Initialize logger. logger, p, err := log.InitLogger(cfg, zap.AddStacktrace(zap.ErrorLevel)) if err == nil { log.ReplaceGlobals(logger, p) } else { log.Fatal("initialize logger error", zap.Error(err)) } // Initialize grpc log wrapper logLevel := 0 switch cfg.GrpcLevel { case "", "ERROR": // If env is unset, set level to ERROR. logLevel = 2 case "WARNING": logLevel = 1 case "INFO": logLevel = 0 } wrapper := &zapWrapper{logger, logLevel} grpclog.SetLoggerV2(wrapper) log.Info("Log directory", zap.String("configDir", cfg.File.RootPath)) log.Info("Set log file to ", zap.String("path", cfg.File.Filename)) }) } type logKey int const logCtxKey logKey = iota // WithField adds given kv field to the logger in ctx func WithField(ctx context.Context, key string, value string) context.Context { logger := log.L() if ctxLogger, ok := ctx.Value(logCtxKey).(*zap.Logger); ok { logger = ctxLogger } return context.WithValue(ctx, logCtxKey, logger.With(zap.String(key, value))) } // WithReqID adds given reqID field to the logger in ctx func WithReqID(ctx context.Context, reqID int64) context.Context { logger := log.L() if ctxLogger, ok := ctx.Value(logCtxKey).(*zap.Logger); ok { logger = ctxLogger } return context.WithValue(ctx, logCtxKey, logger.With(zap.Int64("reqID", reqID))) } // WithModule adds given module field to the logger in ctx func WithModule(ctx context.Context, module string) context.Context { logger := log.L() if ctxLogger, ok := ctx.Value(logCtxKey).(*zap.Logger); ok { logger = ctxLogger } return context.WithValue(ctx, logCtxKey, logger.With(zap.String("module", module))) } func WithLogger(ctx context.Context, logger *zap.Logger) context.Context { if logger == nil { logger = log.L() } return context.WithValue(ctx, logCtxKey, logger) } func Logger(ctx context.Context) *zap.Logger { if ctxLogger, ok := ctx.Value(logCtxKey).(*zap.Logger); ok { return ctxLogger } return log.L() } func BgLogger() *zap.Logger { return log.L() }