log

Documentation

Overview

The package log provides an abstraction above a specific logger implementation.

Index

• Constants
• Variables
• type ConfigurableLogger
  • func NewLogger() (ConfigurableLogger, error)
• type Level
  • func ParseLevel(lvl string) (Level, error)
• type Logger
• type OutputFormat
  • func ParseFormat(format string) (OutputFormat, error)

Constants

const (
	DebugLevel                 = Level(zap.DebugLevel)
	InfoLevel                  = Level(zap.InfoLevel)
	WarnLevel                  = Level(zap.WarnLevel)
	ErrorLevel                 = Level(zap.ErrorLevel)
	OutputConsole OutputFormat = "console"
	OutputJSON    OutputFormat = "json"
)

Variables

var (
	ErrInvalidLevelValue  = errors.New("invalid_level_value")
	ErrInvalidFormatValue = errors.New("invalid_format_value")
)

Types

type ConfigurableLogger

type ConfigurableLogger interface {
	Logger
	Configure(OutputFormat, Level) error // Configure the logger output format and level.
}

Configurable logger to define additional settings.

func NewLogger

func NewLogger() (ConfigurableLogger, error)

Builds a new logger.

type Level

type Level int8 // Log level used by the logger.

func ParseLevel

func ParseLevel(lvl string) (Level, error)

Try to parse the given raw level string into a valid log.Level.

type Logger

type Logger interface {
	Error(args ...any)
	Errorw(msg string, keysAndValues ...any)

	Debug(args ...any)
	Debugw(msg string, keysAndValues ...any)

	Info(args ...any)
	Infow(msg string, keysAndValues ...any)

	Warn(args ...any)
	Warnw(msg string, keysAndValues ...any)
}

Logger used to log things out

type OutputFormat

type OutputFormat string // Output format used by the logger.

func ParseFormat

func ParseFormat(format string) (OutputFormat, error)

Try to parse the given raw format string into a valid log.OutputFormat.