logging

Documentation

Index

• func Command(ctx context.Context, cfg CommandLogger, name string, arg ...string) *exec.Cmd
• func GetLogger(ctx context.Context) *zap.Logger
• func NewLoggerWriter(logger *zap.Logger, level zapcore.Level) io.Writer
• func TimeOffsetFormatter(start time.Time, color bool) zapcore.TimeEncoder
• func WithLogger(ctx context.Context, logger *zap.Logger) context.Context
• type CategoryWriter
  • func NewCategoryWriter(enc zapcore.Encoder, logRootPath string) *CategoryWriter
  • func (c *CategoryWriter) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
  • func (c *CategoryWriter) Enabled(lvl zapcore.Level) bool
  • func (c *CategoryWriter) Sync() error
  • func (c *CategoryWriter) With(fields []zapcore.Field) zapcore.Core
  • func (c *CategoryWriter) Write(ent zapcore.Entry, fields []zapcore.Field) error
• type CommandLogger
• type EntryLeveller
  • func NewEntryLeveller(core zapcore.Core, levels map[string]zapcore.Level) *EntryLeveller
  • func (el *EntryLeveller) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
  • func (el *EntryLeveller) With(f []zapcore.Field) zapcore.Core
• type LogOpts
  • func (opts LogOpts) CategoryCore(core zapcore.Core) zapcore.Core
  • func (opts LogOpts) Encoder() zapcore.Encoder
  • func (opts LogOpts) EntryLeveller(core zapcore.Core) zapcore.Core
  • func (opts LogOpts) NewCore(w zapcore.WriteSyncer) zapcore.Core
  • func (opts LogOpts) NewLogger() *zap.Logger

Functions

func Command

func Command(ctx context.Context, cfg CommandLogger, name string, arg ...string) *exec.Cmd

func GetLogger

func GetLogger(ctx context.Context) *zap.Logger

func NewLoggerWriter

func NewLoggerWriter(logger *zap.Logger, level zapcore.Level) io.Writer

func TimeOffsetFormatter

func TimeOffsetFormatter(start time.Time, color bool) zapcore.TimeEncoder

TimeOffsetFormatter returns a time encoder that formats the time as an offset from the start time. This is mostly useful for CLI logging not long-standing services as times beyond a few minutes will be less readable.

func WithLogger

func WithLogger(ctx context.Context, logger *zap.Logger) context.Context

Types

type CategoryWriter

type CategoryWriter struct {
	Encoder     zapcore.Encoder
	LogRootPath string
	// contains filtered or unexported fields
}

func NewCategoryWriter

func NewCategoryWriter(enc zapcore.Encoder, logRootPath string) *CategoryWriter

func (*CategoryWriter) Check

func (c *CategoryWriter) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry

func (*CategoryWriter) Enabled

func (c *CategoryWriter) Enabled(lvl zapcore.Level) bool

func (*CategoryWriter) Sync

func (c *CategoryWriter) Sync() error

func (*CategoryWriter) With

func (c *CategoryWriter) With(fields []zapcore.Field) zapcore.Core

func (*CategoryWriter) Write

func (c *CategoryWriter) Write(ent zapcore.Entry, fields []zapcore.Field) error

type CommandLogger

type CommandLogger struct {
	RootLogger  *zap.Logger
	StdoutLevel zapcore.Level
	StderrLevel zapcore.Level
}

type EntryLeveller

type EntryLeveller struct {
	zapcore.Core
	// contains filtered or unexported fields
}

EntryLeveller is a zapcore.Core that filters log entries based on the module name similar to Log4j or python's logging module.

func NewEntryLeveller

func NewEntryLeveller(core zapcore.Core, levels map[string]zapcore.Level) *EntryLeveller

func (*EntryLeveller) Check

func (el *EntryLeveller) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry

func (*EntryLeveller) With

func (el *EntryLeveller) With(f []zapcore.Field) zapcore.Core

type LogOpts

type LogOpts struct {
	Verbose         bool
	Color           string
	CategoryLogsDir string
	Encoding        string
	DefaultLevels   map[string]zapcore.Level
}

func (LogOpts) CategoryCore

func (opts LogOpts) CategoryCore(core zapcore.Core) zapcore.Core

func (LogOpts) Encoder

func (opts LogOpts) Encoder() zapcore.Encoder

func (LogOpts) EntryLeveller

func (opts LogOpts) EntryLeveller(core zapcore.Core) zapcore.Core

func (LogOpts) NewCore

func (opts LogOpts) NewCore(w zapcore.WriteSyncer) zapcore.Core

func (LogOpts) NewLogger

func (opts LogOpts) NewLogger() *zap.Logger