logging

Documentation

Index

• func NewApplicationZerologLogger(cfg application.Config, writer io.Writer) zerolog.Logger
• func NewZerologDefaultLogger() zerolog.Logger
• type Event
• type Level
• type Logger
• type StdEvent
  • func (s *StdEvent) WithField(field string, val any) Event
  • func (s *StdEvent) Write(msg string)
  • func (s *StdEvent) WriteWithCtx(ctx context.Context, msg string)
• type StdLoggerAdapter
  • func NewStdLoggerAdapter(l *log.Logger) StdLoggerAdapter
  • func (s StdLoggerAdapter) Debug() Event
  • func (s StdLoggerAdapter) Error() Event
  • func (s StdLoggerAdapter) Info() Event
  • func (s StdLoggerAdapter) Level(lvl Level) Event
  • func (s StdLoggerAdapter) Module(name string) Logger
  • func (s StdLoggerAdapter) Trace() Event
  • func (s StdLoggerAdapter) Warn() Event
  • func (s StdLoggerAdapter) WithError(err error) Event
• type TracerZerologHook
  • func (t TracerZerologHook) Run(e *zerolog.Event, _ zerolog.Level, _ string)
• type ZerologEvent
  • func (z ZerologEvent) WithField(field string, val any) Event
  • func (z ZerologEvent) Write(msg string)
  • func (z ZerologEvent) WriteWithCtx(ctx context.Context, msg string)
• type ZerologLoggerAdapter
  • func NewZerologLoggerAdapter(l zerolog.Logger) ZerologLoggerAdapter
  • func (z ZerologLoggerAdapter) Debug() Event
  • func (z ZerologLoggerAdapter) Error() Event
  • func (z ZerologLoggerAdapter) Info() Event
  • func (z ZerologLoggerAdapter) Level(lvl Level) Event
  • func (z ZerologLoggerAdapter) Module(name string) Logger
  • func (z ZerologLoggerAdapter) Trace() Event
  • func (z ZerologLoggerAdapter) Warn() Event
  • func (z ZerologLoggerAdapter) WithError(err error) Event

Functions

func NewApplicationZerologLogger

func NewApplicationZerologLogger(cfg application.Config, writer io.Writer) zerolog.Logger

NewApplicationZerologLogger allocates a zerolog.Logger instance with configuration.Application fields.

func NewZerologDefaultLogger

func NewZerologDefaultLogger() zerolog.Logger

NewZerologDefaultLogger allocates a zerolog.Logger instance with preconfigurations like tracing. Writes to os.Stdout.

Types

type Event

type Event interface {
	// WithField appends a field to the context.
	WithField(field string, val any) Event
	// Write writes a new log entry into the Logger instance (most probably will write to an underlying io.Writer instance).
	Write(msg string)
	// WriteWithCtx writes a new log entry into the Logger instance (most probably will write to an underlying io.Writer instance).
	//
	// Uses context.Context to retrieve (and possibly append) useful information like trace identifiers.
	WriteWithCtx(ctx context.Context, msg string)
}

An Event represents a logging context instance. Use it to write a new log entry.

type Level

type Level uint8

Level is a piece of information telling how important a given log message is.

const (

	// DebugLevel DEBUG log level.
	DebugLevel Level
	// InfoLevel INFO log level.
	InfoLevel
	// WarnLevel WARN log level.
	WarnLevel
	// TraceLevel TRACE log level.
	TraceLevel
	// ErrorLevel ERROR log level.
	ErrorLevel
)

type Logger

type Logger interface {
	// Level creates an Event context to write a new log entry.
	Level(lvl Level) Event
	// Module allocates a Logger instance with a module field.
	Module(name string) Logger
	// Debug creates an Event context to write a new log entry with DebugLevel.
	Debug() Event
	// Info creates an Event context to write a new log entry with InfoLevel.
	Info() Event
	// Warn creates an Event context to write a new log entry with WarnLevel.
	Warn() Event
	// Trace creates an Event context to write a new log entry with TraceLevel.
	Trace() Event
	// Error creates an Event context to write a new log entry with ErrorLevel.
	Error() Event
	// WithError creates an Event context to write a new log entry with ErrorLevel and appends an `error` field.
	WithError(err error) Event
}

A Logger is used to log messages for a specific system or application component.

type StdEvent

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

StdEvent is standard library (log.Logger) the implementation of Event.

func (*StdEvent) WithField

func (s *StdEvent) WithField(field string, val any) Event

WithField appends a field to the context.

func (*StdEvent) Write

func (s *StdEvent) Write(msg string)

Write writes a new log entry into the Logger instance (most probably will write to an underlying io.Writer instance).

func (*StdEvent) WriteWithCtx

func (s *StdEvent) WriteWithCtx(ctx context.Context, msg string)

WriteWithCtx writes a new log entry into the Logger instance (most probably will write to an underlying io.Writer instance).

Uses context.Context to retrieve (and possibly append) useful information like trace identifiers.

type StdLoggerAdapter

type StdLoggerAdapter struct {
	ModuleName string
	Logger     *log.Logger
}

StdLoggerAdapter is the standard library (log.Logger) implementation of Logger.

func NewStdLoggerAdapter

func NewStdLoggerAdapter(l *log.Logger) StdLoggerAdapter

NewStdLoggerAdapter allocates a new StdLoggerAdapter instance.

func (StdLoggerAdapter) Debug

func (s StdLoggerAdapter) Debug() Event

Debug creates an Event context to write a new log entry with DebugLevel.

func (StdLoggerAdapter) Error

func (s StdLoggerAdapter) Error() Event

Error creates an Event context to write a new log entry with ErrorLevel.

func (StdLoggerAdapter) Info

func (s StdLoggerAdapter) Info() Event

Info creates an Event context to write a new log entry with InfoLevel.

func (StdLoggerAdapter) Level

func (s StdLoggerAdapter) Level(lvl Level) Event

Level creates an Event context to write a new log entry.

func (StdLoggerAdapter) Module

func (s StdLoggerAdapter) Module(name string) Logger

Module allocates a Logger instance with a module field.

func (StdLoggerAdapter) Trace

func (s StdLoggerAdapter) Trace() Event

Trace creates an Event context to write a new log entry with TraceLevel.

func (StdLoggerAdapter) Warn

func (s StdLoggerAdapter) Warn() Event

Warn creates an Event context to write a new log entry with WarnLevel.

func (StdLoggerAdapter) WithError

func (s StdLoggerAdapter) WithError(err error) Event

WithError creates an Event context to write a new log entry with ErrorLevel and appends an `error` field.

type TracerZerologHook

type TracerZerologHook struct {
}

func (TracerZerologHook) Run

func (t TracerZerologHook) Run(e *zerolog.Event, _ zerolog.Level, _ string)

type ZerologEvent

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

ZerologEvent is zerolog the implementation of Event.

func (ZerologEvent) WithField

func (z ZerologEvent) WithField(field string, val any) Event

WithField appends a field to the context.

func (ZerologEvent) Write

func (z ZerologEvent) Write(msg string)

Write writes a new log entry into the Logger instance (most probably will write to an underlying io.Writer instance).

func (ZerologEvent) WriteWithCtx

func (z ZerologEvent) WriteWithCtx(ctx context.Context, msg string)

WriteWithCtx writes a new log entry into the Logger instance (most probably will write to an underlying io.Writer instance).

Uses context.Context to retrieve (and possibly append) useful information like trace identifiers.

type ZerologLoggerAdapter

type ZerologLoggerAdapter struct {
	ModuleName string
	Logger     zerolog.Logger
}

ZerologLoggerAdapter is the zerolog implementation of Logger.

func NewZerologLoggerAdapter

func NewZerologLoggerAdapter(l zerolog.Logger) ZerologLoggerAdapter

NewZerologLoggerAdapter allocates a new ZerologLoggerAdapter instance.

func (ZerologLoggerAdapter) Debug

func (z ZerologLoggerAdapter) Debug() Event

Debug creates an Event context to write a new log entry with DebugLevel.

func (ZerologLoggerAdapter) Error

func (z ZerologLoggerAdapter) Error() Event

Error creates an Event context to write a new log entry with ErrorLevel.

func (ZerologLoggerAdapter) Info

func (z ZerologLoggerAdapter) Info() Event

Info creates an Event context to write a new log entry with InfoLevel.

func (ZerologLoggerAdapter) Level

func (z ZerologLoggerAdapter) Level(lvl Level) Event

Level creates an Event context to write a new log entry.

func (ZerologLoggerAdapter) Module

func (z ZerologLoggerAdapter) Module(name string) Logger

Module allocates a Logger instance with a module field.

func (ZerologLoggerAdapter) Trace

func (z ZerologLoggerAdapter) Trace() Event

Trace creates an Event context to write a new log entry with TraceLevel.

func (ZerologLoggerAdapter) Warn

func (z ZerologLoggerAdapter) Warn() Event

Warn creates an Event context to write a new log entry with WarnLevel.

func (ZerologLoggerAdapter) WithError

func (z ZerologLoggerAdapter) WithError(err error) Event

WithError creates an Event context to write a new log entry with ErrorLevel and appends an `error` field.