logging

Documentation

Index

• func GetLogger(c *Config) *zap.Logger
• func GetSugaredLogger(c *Config) *zap.SugaredLogger
• func GetSugaredLoggerForTest() *zap.SugaredLogger
• func GetSugaredLoggerWithoutConfig() (*zap.SugaredLogger, error)
• func GetZapConfig(c *Config) zap.Config
• type Config
  • func NewConfig(lvl string) (*Config, error)

Functions

func GetLogger

func GetLogger(c *Config) *zap.Logger

GetLogger returns the zap logger object. This can be used to customize the logger object.

func GetSugaredLogger

func GetSugaredLogger(c *Config) *zap.SugaredLogger

GetSugaredLogger returns the zap sugared logger which can be used to emit log messages from the app.

func GetSugaredLoggerForTest

func GetSugaredLoggerForTest() *zap.SugaredLogger

GetSugardLoggerForTest returns a generic zap sugared logger without configuration that should be used during testing. Namely, this initializes the logger to maximize logging output.

func GetSugaredLoggerWithoutConfig

func GetSugaredLoggerWithoutConfig() (*zap.SugaredLogger, error)

GetSugardLoggerWithoutConfig returns a generic zap sugared logger without configuration. This is useful for emitting log messages before the initialization stage.

func GetZapConfig

func GetZapConfig(c *Config) zap.Config

GetZapConfig returns the configuration for zap.

Types

type Config

type Config struct {
	Level          zap.AtomicLevel
	Encoding       string
	NoColor        bool
	WithStackTrace bool
}

func NewConfig

func NewConfig(lvl string) (*Config, error)