logutils

Documentation

Index

• func FileHandlerWithRotation(opts FileOptions, format log.Format) log.Handler
• func NewStdHandler(fmtr log.Format) log.Handler
• func NewZapAdapter(logger log.Logger, enab zapcore.LevelEnabler) zapcore.Core
• func NewZapLoggerWithAdapter(logger log.Logger) (*zap.Logger, error)
• func OverrideRootLog(enabled bool, levelStr string, fileOpts FileOptions, terminal bool) error
• func OverrideRootLogWithConfig(settings LogSettings, colors bool) error
• func OverrideWithStdLogger(logLevel string) error
• func WakuMessageTimestamp(key string, value *int64) zap.Field
• func ZapLogger() *zap.Logger
• type FileOptions
• type LogSettings

Functions

func FileHandlerWithRotation

func FileHandlerWithRotation(opts FileOptions, format log.Format) log.Handler

FileHandlerWithRotation instantiates log.Handler with a configured rotation

func NewStdHandler

func NewStdHandler(fmtr log.Format) log.Handler

NewStdHandler returns handler that uses logger from golang std lib.

func NewZapAdapter

func NewZapAdapter(logger log.Logger, enab zapcore.LevelEnabler) zapcore.Core

NewZapAdapter returns a new zapcore.Core interface which forwards logs to log.Logger.

func NewZapLoggerWithAdapter

func NewZapLoggerWithAdapter(logger log.Logger) (*zap.Logger, error)

NewZapLoggerWithAdapter returns a logger forwarding all logs with level info and above.

func OverrideRootLog

func OverrideRootLog(enabled bool, levelStr string, fileOpts FileOptions, terminal bool) error

OverrideRootLog overrides root logger with file handler, if defined, and log level (defaults to INFO).

func OverrideRootLogWithConfig

func OverrideRootLogWithConfig(settings LogSettings, colors bool) error

OverrideRootLogWithConfig derives all configuration from params.NodeConfig and configures logger using it.

func OverrideWithStdLogger

func OverrideWithStdLogger(logLevel string) error

OverrideWithStdLogger overwrites ethereum's root logger with a logger from golang std lib.

func WakuMessageTimestamp

func WakuMessageTimestamp(key string, value *int64) zap.Field

func ZapLogger

func ZapLogger() *zap.Logger

ZapLogger creates a custom zap.Logger which will forward logs to status-go logger.

Types

type FileOptions

type FileOptions struct {
	// Base name for log file.
	Filename string
	// Size in megabytes.
	MaxSize int
	// Number of rotated log files.
	MaxBackups int
	// If true rotated log files will be gzipped.
	Compress bool
}

FileOptions are all options supported by internal rotation module.

type LogSettings

type LogSettings struct {
	Enabled         bool   `json:"Enabled"`
	MobileSystem    bool   `json:"MobileSystem"`
	Level           string `json:"Level"`
	File            string `json:"File"`
	MaxSize         int    `json:"MaxSize"`
	MaxBackups      int    `json:"MaxBackups"`
	CompressRotated bool   `json:"CompressRotated"`
}