logging

Documentation

Index

• func GetRequestID(logger TraceLogger) string
• type Level
• type LogFormatter
  • func NewLogFormatter() *LogFormatter
  • func (formatter *LogFormatter) Format(entry *log.Entry) ([]byte, error)
  • func (formatter *LogFormatter) Register()
• type TraceLogger
  • func NewTraceLogger(subsystem string) TraceLogger
  • func NewTraceLoggerFromLogger(subsystem string, logger TraceLogger) TraceLogger
  • func NewTraceLoggerWithRequestID(subsystem string, requestID string) TraceLogger

Functions

func GetRequestID

func GetRequestID(logger TraceLogger) string

GetRequestID returns the logger request ID.

Types

type Level

type Level = log.Level

const (
	PanicLevel Level = Level(log.PanicLevel)
	FatalLevel Level = Level(log.FatalLevel)
	ErrorLevel Level = Level(log.ErrorLevel)
	WarnLevel  Level = Level(log.WarnLevel)
	InfoLevel  Level = Level(log.InfoLevel)
	DebugLevel Level = Level(log.DebugLevel)
	TraceLevel Level = Level(log.TraceLevel)
)

type LogFormatter

type LogFormatter struct{}

LogFormatter is a custom standard formatter. It implements logrus.Formatter interface. Note that the formatter is automatically registered by default.

func NewLogFormatter

func NewLogFormatter() *LogFormatter

NewLogFormatter creates a new trace logging output formatter. Note that the formatter is automatically registered by default.

func (*LogFormatter) Format

func (formatter *LogFormatter) Format(entry *log.Entry) ([]byte, error)

Format perform custom logger formatting.

func (*LogFormatter) Register

func (formatter *LogFormatter) Register()

Register sets the formatter in the log system. Note that the formatter is automatically registered by default.

type TraceLogger

type TraceLogger interface {
	Log(level Level, args ...interface{})

	// Trace logs a message at level Trace.
	Trace(args ...interface{})

	// Debug logs a message at level Debug.
	Debug(args ...interface{})

	// Print logs a message at level Info.
	Print(args ...interface{})

	// Info logs a message at level Info.
	Info(args ...interface{})

	// Warn logs a message at level Warn.
	Warn(args ...interface{})

	// Warning logs a message at level Warn.
	Warning(args ...interface{})

	// Error logs a message at level Error.
	Error(args ...interface{})

	// Panic logs a message at level Panic.
	Panic(args ...interface{})

	// Fatal logs a message at level Fatal.
	Fatal(args ...interface{})

	Logf(level Level, format string, args ...interface{})

	// Tracef logs a message at level Trace.
	Tracef(format string, args ...interface{})

	// Debugf logs a message at level Debug.
	Debugf(format string, args ...interface{})

	// Printf logs a message at level Info.
	Printf(format string, args ...interface{})

	// Infof logs a message at level Info.
	Infof(format string, args ...interface{})

	// Warnf logs a message at level Warn.
	Warnf(format string, args ...interface{})

	// Warningf logs a message at level Warn.
	Warningf(format string, args ...interface{})

	// Errorf logs a message at level Error.
	Errorf(format string, args ...interface{})

	// Panicf logs a message at level Panic.
	Panicf(format string, args ...interface{})

	// Fatalf logs a message at level Fatal.
	Fatalf(format string, args ...interface{})

	// Debugln logs a message at level Debug.
	Debugln(args ...interface{})

	// Println logs a message at level Info.
	Println(args ...interface{})

	// Infoln logs a message at level Info.
	Infoln(args ...interface{})

	// Warnln logs a message at level Warn.
	Warnln(args ...interface{})

	// Warningln logs a message at level Warn.
	Warningln(args ...interface{})

	// Errorln logs a message at level Error.
	Errorln(args ...interface{})

	// Panicln logs a message at level Panic.
	Panicln(args ...interface{})

	// Fatalln logs a message at level Fatal.
	Fatalln(args ...interface{})
}

TraceLogger is an interface for a logger that can be used for tracing using an identifer.

func NewTraceLogger

func NewTraceLogger(subsystem string) TraceLogger

NewTraceLogger creates a new logger given a subsystem and UUID generated requestID.

func NewTraceLoggerFromLogger

func NewTraceLoggerFromLogger(subsystem string, logger TraceLogger) TraceLogger

NewTraceLogger creates a new logger given a subsystem and UUID generated requestID.

func NewTraceLoggerWithRequestID

func NewTraceLoggerWithRequestID(subsystem string, requestID string) TraceLogger

NewTraceLoggerWithRequestID creates a new logger with a subsystem and given requestID.