logger

Documentation

Overview

Package logger 日志包，用于日志输出和打印

Package logger 日志包，用于日志输出和打印

Index

• func ReadLogLevelFromEnv() (zapcore.Level, error)
• func SetCallFrame(entry *logrus.Entry, namespace string, skip int)
• func SetCallerFrameWithFileAndLine(entry *logrus.Entry, namespace, functionName, file string, line int)
• type LogFileFormatter
  • func NewLogFileFormatter() *LogFileFormatter
  • func (f *LogFileFormatter) Format(entry *logrus.Entry) ([]byte, error)
• type Logger
  • func NewLogger(callOpts ...NewLoggerCallOption) (*Logger, error)
  • func (l *Logger) Debug(msg string, fields ...zapcore.Field)
  • func (l *Logger) Error(msg string, fields ...zapcore.Field)
  • func (l *Logger) Fatal(msg string, fields ...zapcore.Field)
  • func (l *Logger) Info(msg string, fields ...zapcore.Field)
  • func (l *Logger) Warn(msg string, fields ...zapcore.Field)
  • func (l *Logger) With(fields ...zapcore.Field) *Logger
  • func (l *Logger) WithAndSkip(skip int, fields ...zapcore.Field) *Logger
• type NewLoggerCallOption
  • func WithAppName(appName string) NewLoggerCallOption
  • func WithCallFrameSkip(skip int) NewLoggerCallOption
  • func WithHook(hook logrus.Hook) NewLoggerCallOption
  • func WithInitialFields(fields map[string]any) NewLoggerCallOption
  • func WithLevel(level zapcore.Level) NewLoggerCallOption
  • func WithLogFilePath(logFilePath string) NewLoggerCallOption
  • func WithNamespace(namespace string) NewLoggerCallOption
• type ZapField
  • func (f ZapField) MatchValue() any

Functions

func ReadLogLevelFromEnv

func ReadLogLevelFromEnv() (zapcore.Level, error)

func SetCallFrame

func SetCallFrame(entry *logrus.Entry, namespace string, skip int)

SetCallFrame 设定调用栈。

func SetCallerFrameWithFileAndLine

func SetCallerFrameWithFileAndLine(entry *logrus.Entry, namespace, functionName, file string, line int)

SetCallerFrameWithFileAndLine 设定调用栈。

Types

type LogFileFormatter

type LogFileFormatter struct {
	logrus.TextFormatter
	MinimumCallerDepth int
}

LogFileFormatter defines the format for log file.

func NewLogFileFormatter

func NewLogFileFormatter() *LogFileFormatter

NewLogFileFormatter return the log format for log file.

eg: 2023-06-01T12:00:00 [info] [controllers/some_controller/code_file.go:99] foo key=value

func (*LogFileFormatter) Format

func (f *LogFileFormatter) Format(entry *logrus.Entry) ([]byte, error)

Format renders a single log entry for log file

the original file log format is defined here: github.com/sirupsen/logrus/text_formatter.TextFormatter{}.Format().

type Logger

type Logger struct {
	LogrusLogger *logrus.Entry
	ZapLogger    *zap.Logger
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(callOpts ...NewLoggerCallOption) (*Logger, error)

NewLogger 按需创建 logger 实例。

func (*Logger) Debug

func (l *Logger) Debug(msg string, fields ...zapcore.Field)

Debug 打印 debug 级别日志。

func (*Logger) Error

func (l *Logger) Error(msg string, fields ...zapcore.Field)

Error 打印错误日志。

func (*Logger) Fatal

func (l *Logger) Fatal(msg string, fields ...zapcore.Field)

Fatal 打印致命错误日志，打印后立即退出程序。

NOTICE: 该方法会调用 os.Exit(1) 退出程序。而且会优先执行 logrus 的 Fatal 方法，然后再执行 zap 的 Fatal 方法。

func (*Logger) Info

func (l *Logger) Info(msg string, fields ...zapcore.Field)

Info 打印 info 级别日志。

func (*Logger) Warn

func (l *Logger) Warn(msg string, fields ...zapcore.Field)

Warn 打印 warn 级别日志。

func (*Logger) With

func (l *Logger) With(fields ...zapcore.Field) *Logger

With 创建一个新的 logger 实例，该实例会继承当前 logger 的上下文信息。 添加到新 logger 实例的字段，不会影响当前 logger 实例。

func (*Logger) WithAndSkip

func (l *Logger) WithAndSkip(skip int, fields ...zapcore.Field) *Logger

With 创建一个新的 logger 实例，该实例会继承当前 logger 的上下文信息。 添加到新 logger 实例的字段，不会影响当前 logger 实例。

type NewLoggerCallOption

type NewLoggerCallOption func(*newLoggerOptions)

func WithAppName

func WithAppName(appName string) NewLoggerCallOption

func WithCallFrameSkip

func WithCallFrameSkip(skip int) NewLoggerCallOption

func WithHook

func WithHook(hook logrus.Hook) NewLoggerCallOption

func WithInitialFields

func WithInitialFields(fields map[string]any) NewLoggerCallOption

func WithLevel

func WithLevel(level zapcore.Level) NewLoggerCallOption

func WithLogFilePath

func WithLogFilePath(logFilePath string) NewLoggerCallOption

func WithNamespace

func WithNamespace(namespace string) NewLoggerCallOption

type ZapField

type ZapField zapcore.Field

func (ZapField) MatchValue

func (f ZapField) MatchValue() any