logging

Documentation

Overview

Package logging parses and applies logging configuration

Index

• Constants
• type LoggerConfig
  • func NewLoggerConfig(configPath string) (*LoggerConfig, error)
  • func (l *LoggerConfig) Options() ([]zap.Option, error)

Constants

const DefaultConfigPath = "./logging.yaml"

DefaultConfigPath is the relative path to the default logging.yaml

Types

type LoggerConfig

type LoggerConfig struct {
	Output string             `yaml:"output"`
	Level  zapcore.Level      `yaml:"level"`
	File   *lumberjack.Logger `yaml:"file,omitempty"`
}

LoggerConfig is the configuration of a logger.

func NewLoggerConfig

func NewLoggerConfig(configPath string) (*LoggerConfig, error)

NewLoggerConfig returns a logger config. If configPath is not set, stdout logging will be enabled, and a default configuration will be written to ./logging.yaml

func (*LoggerConfig) Options

func (l *LoggerConfig) Options() ([]zap.Option, error)

Options returns the LoggerConfig's zap logging options.