logger

Documentation

Overview

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 Format
  • func ReadLogFormatFromEnv() (Format, error)
• type LogPrettyFormatter
  • func NewLogPrettyFormatter() *LogPrettyFormatter
  • func (f *LogPrettyFormatter) 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) DebugContext(ctx context.Context, msg string, fields ...zapcore.Field)
  • func (l *Logger) Error(msg string, fields ...zapcore.Field)
  • func (l *Logger) ErrorContext(ctx context.Context, msg string, fields ...zapcore.Field)
  • func (l *Logger) Fatal(msg string, fields ...zapcore.Field)
  • func (l *Logger) FatalContext(ctx context.Context, msg string, fields ...zapcore.Field)
  • func (l *Logger) Info(msg string, fields ...zapcore.Field)
  • func (l *Logger) InfoContext(ctx context.Context, msg string, fields ...zapcore.Field)
  • func (l *Logger) Warn(msg string, fields ...zapcore.Field)
  • func (l *Logger) WarnContext(ctx context.Context, 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 WithFormat(format Format) 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 WithLokiRemoteConfig(config *loki.Config) NewLoggerCallOption
  • func WithNamespace(namespace string) NewLoggerCallOption
  • func WithOpenTelemetryDisabled() 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 set the caller information for the log entry.

func SetCallerFrameWithFileAndLine

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

SetCallerFrameWithFileAndLine set the caller information for the log entry.

Types

type Format

type Format string

const (
	FormatJSON   Format = "json"
	FormatPretty Format = "pretty"
)

func ReadLogFormatFromEnv

func ReadLogFormatFromEnv() (Format, error)

type LogPrettyFormatter

type LogPrettyFormatter struct {
	logrus.TextFormatter
	MinimumCallerDepth int
}

LogPrettyFormatter defines the format for log file.

func NewLogPrettyFormatter

func NewLogPrettyFormatter() *LogPrettyFormatter

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 (*LogPrettyFormatter) Format

func (f *LogPrettyFormatter) 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 logs a message at DebugLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger.

func (*Logger) DebugContext

func (l *Logger) DebugContext(ctx context.Context, msg string, fields ...zapcore.Field)

DebugContext logs a message at DebugLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger. Besides that, it also logs the message to the OpenTelemetry span.

func (*Logger) Error

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

Error logs a message at ErrorLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger.

func (*Logger) ErrorContext

func (l *Logger) ErrorContext(ctx context.Context, msg string, fields ...zapcore.Field)

ErrorContext logs a message at ErrorLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger. Besides that, it also logs the message to the OpenTelemetry span.

func (*Logger) Fatal

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

Fatal logs a message at FatalLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger.

NOTICE: This method calls os.Exit(1) to exit the program. It also prioritizes the execution of logrus' Fatal method over zap's Fatal method.

func (*Logger) FatalContext

func (l *Logger) FatalContext(ctx context.Context, msg string, fields ...zapcore.Field)

FatalContext logs a message at FatalLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger. Besides that, it also logs the message to the OpenTelemetry span.

func (*Logger) Info

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

Info logs a message at InfoLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger.

func (*Logger) InfoContext

func (l *Logger) InfoContext(ctx context.Context, msg string, fields ...zapcore.Field)

InfoContext logs a message at InfoLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger. Besides that, it also logs the message to the OpenTelemetry span.

func (*Logger) Warn

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

Warn logs a message at WarnLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger. Besides that, it also logs the message to the OpenTelemetry span.

func (*Logger) WarnContext

func (l *Logger) WarnContext(ctx context.Context, msg string, fields ...zapcore.Field)

WarnContext logs a message at WarnLevel. The message includes any fields passed at the log site, as well as any fields accumulated on the logger. Besides that, it also logs the message to the OpenTelemetry span.

func (*Logger) With

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

With creates a new logger instance that inherits the context information from the current logger. Fields added to the new logger instance do not affect the current logger instance.

func (*Logger) WithAndSkip

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

WithAndSkip creates a new logger instance that inherits the context information from the current logger. Fields added to the new logger instance do not affect the current logger instance. The skip parameter is used to determine the number of stack frames to skip when retrieving the caller information.

type NewLoggerCallOption

type NewLoggerCallOption func(*newLoggerOptions)

func WithAppName

func WithAppName(appName string) NewLoggerCallOption

func WithCallFrameSkip

func WithCallFrameSkip(skip int) NewLoggerCallOption

func WithFormat

func WithFormat(format Format) 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 WithLokiRemoteConfig

func WithLokiRemoteConfig(config *loki.Config) NewLoggerCallOption

func WithNamespace

func WithNamespace(namespace string) NewLoggerCallOption

func WithOpenTelemetryDisabled

func WithOpenTelemetryDisabled() NewLoggerCallOption

type ZapField

type ZapField zapcore.Field

func (ZapField) MatchValue

func (f ZapField) MatchValue() any