logger

Documentation

Index

• func SetSeverityLevel(level string) error
• type LogFormat
• type LogIDGenerator
• type Logger
  • func New(wr io.Writer, gen LogIDGenerator, f LogFormat) *Logger
  • func NewWithPrefix(wr io.Writer, gen LogIDGenerator, prefix string, f LogFormat) *Logger
  • func (l *Logger) BaseLogger() *zerolog.Logger
  • func (l *Logger) Run(e *zerolog.Event, _ zerolog.Level, _ string)
  • func (l *Logger) WithPrefix(prefix string) *Logger

Functions

func SetSeverityLevel

func SetSeverityLevel(level string) error

SetSeverityLevel sets the minimal severity level which the logs will be produced.

Types

type LogFormat

type LogFormat string

LogFormat defines the log format.

const (
	// Pretty defines the log format in human-friendly format.
	Pretty LogFormat = "pretty"

	// JSON defines the log format in JSON format.
	JSON LogFormat = "json"
)

type LogIDGenerator

type LogIDGenerator interface {
	// NextID generates a new log ID.
	NextID() uint64
}

LogIDGenerator is responsible for generate log IDs.

type Logger

type Logger struct {
	// Unexported fields.
	zerolog.Logger
	// contains filtered or unexported fields
}

Logger represents a logging object responsible to generate outputs to an io.Writer.

func New

func New(wr io.Writer, gen LogIDGenerator, f LogFormat) *Logger

New creates a new logger.

func NewWithPrefix

func NewWithPrefix(wr io.Writer, gen LogIDGenerator, prefix string, f LogFormat) *Logger

NewWithPrefix creates a new logger with a prefix.

func (*Logger) BaseLogger

func (l *Logger) BaseLogger() *zerolog.Logger

BaseLogger returns the zerolog.Logger.

func (*Logger) Run

func (l *Logger) Run(e *zerolog.Event, _ zerolog.Level, _ string)

Run implements the zerolog.Hook interface to add log ID into the log event.

func (*Logger) WithPrefix

func (l *Logger) WithPrefix(prefix string) *Logger

WithPrefix creates a new logger from the existing one with a prefix.