logger

README

logger - Normalize various logger interfaces to zerolog.

Documentation

Index

• func NewLogger(logOutput Writer, errorOutput ErrWriter, cfg *Config) (*zerolog.Logger, error)
• func NewSTDLogger(logger *zerolog.Logger) *log.Logger
• func SetGRPCLogger(log *zerolog.Logger, level zerolog.Level)
• func TestLogger(logOutput io.Writer) *zerolog.Logger
• type Config
  • func (c *Config) ParseLogLevel(defaultLevel zerolog.Level) error
• type ErrWriter
• type GRPCZeroLogger
  • func NewGRPCZeroLogger(log *zerolog.Logger, level zerolog.Level) GRPCZeroLogger
  • func (l GRPCZeroLogger) Error(args ...any)
  • func (l GRPCZeroLogger) Errorf(format string, args ...any)
  • func (l GRPCZeroLogger) Errorln(args ...any)
  • func (l GRPCZeroLogger) Fatal(args ...any)
  • func (l GRPCZeroLogger) Fatalf(format string, args ...any)
  • func (l GRPCZeroLogger) Fatalln(args ...any)
  • func (l GRPCZeroLogger) Info(args ...any)
  • func (l GRPCZeroLogger) Infof(format string, args ...any)
  • func (l GRPCZeroLogger) Infoln(args ...any)
  • func (l GRPCZeroLogger) Print(args ...any)
  • func (l GRPCZeroLogger) Printf(format string, args ...any)
  • func (l GRPCZeroLogger) Println(args ...any)
  • func (l GRPCZeroLogger) V(_ int) bool
  • func (l GRPCZeroLogger) Warning(args ...any)
  • func (l GRPCZeroLogger) Warningf(format string, args ...any)
  • func (l GRPCZeroLogger) Warningln(args ...any)
• type LevelWriter
  • func (lw *LevelWriter) WriteLevel(l zerolog.Level, p []byte) (int, error)
• type Writer
• type ZerologWriter
  • func NewZerologWriter(logger *zerolog.Logger) *ZerologWriter
  • func NewZerologWriterWithLevel(logger *zerolog.Logger, level zerolog.Level) *ZerologWriter
  • func (z *ZerologWriter) Write(p []byte) (int, error)

Functions

func NewLogger

func NewLogger(logOutput Writer, errorOutput ErrWriter, cfg *Config) (*zerolog.Logger, error)

NewLogger returns a new logger.

func NewSTDLogger

func NewSTDLogger(logger *zerolog.Logger) *log.Logger

NewSTDLogger creates a standard logger that writes to a zerolog logger.

func SetGRPCLogger

func SetGRPCLogger(log *zerolog.Logger, level zerolog.Level)

func TestLogger

func TestLogger(logOutput io.Writer) *zerolog.Logger

TestLogger creates a logger useful for unit tests it has a trace level.

Types

type Config

type Config struct {
	Prod           bool          `json:"prod"`
	LogLevelParsed zerolog.Level `json:"-"`
	LogLevel       string        `json:"log_level"`
	GrpcLogLevel   string        `json:"grpc_log_level"`
}

Config represents logging configuration.

func (*Config) ParseLogLevel

func (c *Config) ParseLogLevel(defaultLevel zerolog.Level) error

ParseLogLevel parses the log level in the config and sets the appropriate value for `LogLevelParsed`.

type ErrWriter

type ErrWriter io.Writer

type GRPCZeroLogger

type GRPCZeroLogger struct {
	// contains filtered or unexported fields
}

GRPCZeroLogger is a GRPC logger that uses zerolog.

func NewGRPCZeroLogger

func NewGRPCZeroLogger(log *zerolog.Logger, level zerolog.Level) GRPCZeroLogger

NewGRPCZeroLogger creates a GRPCZeroLogger.

func (GRPCZeroLogger) Error

func (l GRPCZeroLogger) Error(args ...any)

Error logs an error message.

func (GRPCZeroLogger) Errorf

func (l GRPCZeroLogger) Errorf(format string, args ...any)

Errorf formats and logs an error message.

func (GRPCZeroLogger) Errorln

func (l GRPCZeroLogger) Errorln(args ...any)

Errorln logs an error message and a newline.

func (GRPCZeroLogger) Fatal

func (l GRPCZeroLogger) Fatal(args ...any)

Fatal logs a fatal message.

func (GRPCZeroLogger) Fatalf

func (l GRPCZeroLogger) Fatalf(format string, args ...any)

Fatalf formats and logs a fatal message.

func (GRPCZeroLogger) Fatalln

func (l GRPCZeroLogger) Fatalln(args ...any)

Fatalln logs a fatal message and a newline.

func (GRPCZeroLogger) Info

func (l GRPCZeroLogger) Info(args ...any)

Info logs an info message.

func (GRPCZeroLogger) Infof

func (l GRPCZeroLogger) Infof(format string, args ...any)

Infof formats and logs an info message.

func (GRPCZeroLogger) Infoln

func (l GRPCZeroLogger) Infoln(args ...any)

Infoln formats and logs an info message and a newline.

func (GRPCZeroLogger) Print

func (l GRPCZeroLogger) Print(args ...any)

Print prints a message.

func (GRPCZeroLogger) Printf

func (l GRPCZeroLogger) Printf(format string, args ...any)

Printf formats and prints a message.

func (GRPCZeroLogger) Println

func (l GRPCZeroLogger) Println(args ...any)

Println prints a message and a newline.

func (GRPCZeroLogger) V

func (l GRPCZeroLogger) V(_ int) bool

V always returns true.

func (GRPCZeroLogger) Warning

func (l GRPCZeroLogger) Warning(args ...any)

Warning logs a warning message.

func (GRPCZeroLogger) Warningf

func (l GRPCZeroLogger) Warningf(format string, args ...any)

Warningf formats and logs a warning message.

func (GRPCZeroLogger) Warningln

func (l GRPCZeroLogger) Warningln(args ...any)

Warningln formats and logs a warning message and a newline.

type LevelWriter

type LevelWriter struct {
	io.Writer
	ErrorWriter io.Writer
}

func (*LevelWriter) WriteLevel

func (lw *LevelWriter) WriteLevel(l zerolog.Level, p []byte) (int, error)

type Writer

type Writer io.Writer

type ZerologWriter

type ZerologWriter struct {
	// contains filtered or unexported fields
}

ZerologWriter implements io.Writer for a zerolog logger.

func NewZerologWriter

func NewZerologWriter(logger *zerolog.Logger) *ZerologWriter

NewZerologWriter creates a new ZerologWriter.

func NewZerologWriterWithLevel

func NewZerologWriterWithLevel(logger *zerolog.Logger, level zerolog.Level) *ZerologWriter

func (*ZerologWriter) Write

func (z *ZerologWriter) Write(p []byte) (int, error)