logger

Documentation

Index

• Constants
• func Level(l LogLevel) int
• type LogContext
• type LogLevel
• type Logger
  • func New(api common.LogAPI) Logger
  • func NewNilLogger() Logger
  • func NewTestLogger() Logger

Constants

const (
	// LogLevelDebug denotes debug messages
	LogLevelDebug = "debug"
	// LogLevelInfo denotes info messages
	LogLevelInfo = "info"
	// LogLevelWarn denotes warn messages
	LogLevelWarn = "warn"
	// LogLevelError denotes error messages
	LogLevelError = "error"
)

const (
	ErrorKey = "error"
)

Functions

func Level

func Level(l LogLevel) int

Level assigns an integer to the LogLevel string

Types

type LogContext

type LogContext map[string]interface{}

LogContext defines the context for the logs.

type LogLevel

type LogLevel string

LogLevel defines the level of log messages

type Logger

type Logger interface {
	// With adds a logContext to the logger.
	With(LogContext) Logger
	// WithError adds an Error to the logger.
	WithError(error) Logger
	// Context returns the current context
	Context() LogContext
	// Timed add a timed log context.
	Timed() Logger
	// Debugf logs a formatted string as a debug message.
	Debugf(format string, args ...interface{})
	// Errorf logs a formatted string as an error message.
	Errorf(format string, args ...interface{})
	// Infof logs a formatted string as an info message.
	Infof(format string, args ...interface{})
	// Warnf logs a formatted string as an warning message.
	Warnf(format string, args ...interface{})
}

Logger defines an object able to log messages.

func New

func New(api common.LogAPI) Logger

New creates a new logger.

- api: LogAPI implementation

func NewNilLogger

func NewNilLogger() Logger

NewNilLogger returns a logger that performs no action.

func NewTestLogger

func NewTestLogger() Logger

NewTestLogger creates a logger for testing purposes.