logger

Documentation

Overview

Package logger is intended to abstract our concrete logging backend, to not litter all the code base with "sirupsen/logrus" imports; also makes it easier to eventually switch out the logging library.

Index

• func ParseZapEncoding(enc string) string
• func ParseZapLevel(level string) zapcore.Level
• func WrapZapGRPC(l *zap.Logger) grpclog.LoggerV2
• type KV
• type Logger
  • func NewLogger(format, level string) (Logger, error)
  • func NewLoggerWithOut(format, level string, out io.Writer) (Logger, error)
  • func NewLogrusStandardLogger() Logger
  • func NewTestLogger() Logger

Functions

func ParseZapEncoding

func ParseZapEncoding(enc string) string

ParseZapEncoding takes a string and returns a valid Zap encoding, defaulting to "console".

func ParseZapLevel

func ParseZapLevel(level string) zapcore.Level

ParseZapLevel takes a string and returns a zap.Level. It the level is unrecognized, it returns the default level.

func WrapZapGRPC

func WrapZapGRPC(l *zap.Logger) grpclog.LoggerV2

Types

type KV

type KV = logrus.Fields

KV is the type for field literals. These are key/value pairs, hence "KV". We declare it as an alias to the logrus.Fields type which is a type defined as map[string]interface{}.

type Logger

type Logger interface {
	// grpclog uses this to determine log levels
	V(i int) bool

	// NewEntry returns a new logrus.Entry to be used with grpc_logrus middleware
	NewEntry() *logrus.Entry

	logrus.FieldLogger
}

Logger is the interface provided by our logger abstraction

func NewLogger

func NewLogger(format, level string) (Logger, error)

NewLogger initializes a new logger with the passed format and level

func NewLoggerWithOut

func NewLoggerWithOut(format, level string, out io.Writer) (Logger, error)

func NewLogrusStandardLogger

func NewLogrusStandardLogger() Logger

NewLogrusStandardLogger returns a new logger.Logger wrapping the logrus standard logger (i.e. what you get when calling the package-level methods, like `logrus.Info(...)`).

func NewTestLogger

func NewTestLogger() Logger

NewTestLogger returns a logger that discards all output -- to keep test output undisturbed.