zerolog

Documentation

Overview

Package zerolog provides a zerolog based logger we use in our servers

Index

• func DefaultLogWriter() zerolog.ConsoleWriter
• func New(w io.Writer, level slog.LogLevel) slog.Logger
• func NewZerolog(w io.Writer) *zerolog.Logger
• type Config
  • func (c Config) New() slog.Logger
  • func (c *Config) SetConsoleWriter(options ...func(*zerolog.ConsoleWriter))
  • func (c *Config) SetLevel(level slog.LogLevel)
  • func (c *Config) SetLogger(zlog *zerolog.Logger)
  • func (c *Config) SetWriter(w io.Writer)
• type ConsoleWriter

Functions

func DefaultLogWriter

func DefaultLogWriter() zerolog.ConsoleWriter

DefaultLogWriter returns a zerolog.ConsoleWriter set to use os.Stderr as io.Writer.

func New

func New(w io.Writer, level slog.LogLevel) slog.Logger

New creates a new slog.Logger wrapper for a zerolog.Logger using the given io.Writer and restricted to entries above the given slog.LogLevel threshold.

func NewZerolog

func NewZerolog(w io.Writer) *zerolog.Logger

NewZerolog is a shortcut to zerolog.New() that allows us to bypass zerolog shadowing, and use DefaultLogWriter if none is specified.

Types

type Config

type Config struct {
	// Level is the threshold for the created slog.Logger
	Level slog.LogLevel

	// Logger optionally defines a zerolog.Logger to use
	Logger *zerolog.Logger

	// Writer defines where the zerolog.Logger would write,
	// if no Logger is specified
	Writer io.Writer
}

Config describes how the Zerolog wrapper will be created.

func (Config) New

func (c Config) New() slog.Logger

New creates a new slog.Logger from the Config.

func (*Config) SetConsoleWriter

func (c *Config) SetConsoleWriter(options ...func(*zerolog.ConsoleWriter))

SetConsoleWriter binds the Config to a new zerolog.ConsoleWriter.

func (*Config) SetLevel

func (c *Config) SetLevel(level slog.LogLevel)

SetLevel sets the threshold level for the created slog.Logger.

func (*Config) SetLogger

func (c *Config) SetLogger(zlog *zerolog.Logger)

SetLogger specifies the zerolog.Logger to use.

func (*Config) SetWriter

func (c *Config) SetWriter(w io.Writer)

SetWriter binds the Config to a zerolog.Logger using a given writer or the DefaultLogWriter if none specified.

type ConsoleWriter

type ConsoleWriter = zerolog.ConsoleWriter

ConsoleWriter is an alias of zerolog.ConsoleWriter.