log

Documentation

Index

• Constants
• Variables
• func Debug(kv ...interface{})
• func Error(kv ...interface{})
• func Info(kv ...interface{})
• func NewContextWithLogger(ctx context.Context, logger Logger) context.Context
• func Warn(kv ...interface{})
• type Format
  • func ToFormat(f string) Format
• type Level
  • func ToLevel(l string) Level
• type Logger
  • func LoggerFromContext(ctx context.Context) Logger
  • func New(opts ...Option) (Logger, error)
  • func (l Logger) Debug(kv ...interface{})
  • func (l Logger) Error(kv ...interface{})
  • func (l Logger) Info(kv ...interface{})
  • func (l Logger) Level() Level
  • func (l Logger) Warn(kv ...interface{})
  • func (l Logger) With(kv ...interface{}) Logger
• type Option
  • func AsDefault() Option
  • func WithFormat(format Format) Option
  • func WithLevel(level Level) Option
  • func WithOutput(writer io.Writer) Option
  • func WithoutTimestamp() Option
• type StringBuffer
  • func NewStringBuffer() *StringBuffer
  • func (l *StringBuffer) Index(i int) string
  • func (l *StringBuffer) Len() int
  • func (l *StringBuffer) Write(p []byte) (int, error)

Constants

const (
	// LevelDebug provides the most verbose logging, allowing logs for debug, info,
	// warn, and error.
	LevelDebug Level = iota

	// LevelInfo is the default log level. It allows logs for info, warn, and
	// error.
	LevelInfo

	// LevelWarn is reserved for logging warnings and errors.
	LevelWarn

	// LevelError provides the least verbose logging, allowing logs only for
	// errors.
	LevelError

	// LevelInvalid indicates and invalid log level.
	LevelInvalid

	// FormatJSON encodes each log entry as a single JSON object.
	FormatJSON Format = iota

	// FormatLogfmt encodes each log entry in logfmt format.
	FormatLogfmt

	// FormatNop will suppress logging output entirely.
	FormatNop

	// FormatInvalid indicates an invalid log format.
	FormatInvalid
)

Variables

var (
	// ErrInvalidLevel will be returned when the level given to the WirhLevel
	// option is invalid.
	ErrInvalidLevel = errors.New("invalid level")

	// ErrInvalidFormat will be returned when the format given to the WithFormat
	// options is invalid.
	ErrInvalidFormat = errors.New("invalid format")

	// ErrInvalidOutput will be returned when the output writer given to WithOuput
	// is nil.
	ErrInvalidOutput = errors.New("invalid output")
)

Functions

func Debug

func Debug(kv ...interface{})

Debug logs an debug level message to the default logger.

func Error

func Error(kv ...interface{})

Error logs an error level message to the default logger.

func Info

func Info(kv ...interface{})

Info logs an info level message to the default logger.

func NewContextWithLogger

func NewContextWithLogger(ctx context.Context, logger Logger) context.Context

NewContextWithLogger returns a new context with the given logger.

func Warn

func Warn(kv ...interface{})

Warn logs a warn level message to the default logger.

Types

type Format

type Format uint

Format defines the output formats of the logger. Supported formats are FormatLogfmt (the default), FormatJSON, and FormatNop (no logging).

func ToFormat

func ToFormat(f string) Format

ToFormat translates the given format as a string to a Format.

type Level

type Level uint

Level defines the logging levels available to the Logger, with a level of debug logging all message and error logging only error message.

func ToLevel

func ToLevel(l string) Level

ToLevel translates the given level as a string to a Level.

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger is the interface for all logging operations.

var (
	DefaultLogger Logger
)

func LoggerFromContext

func LoggerFromContext(ctx context.Context) Logger

LoggerFromContext returns the logger for the current request.

func New

func New(opts ...Option) (Logger, error)

New returns a Logger.

func (Logger) Debug

func (l Logger) Debug(kv ...interface{})

Debug logs a debug level message.

func (Logger) Error

func (l Logger) Error(kv ...interface{})

Error logs an error level message.

func (Logger) Info

func (l Logger) Info(kv ...interface{})

Info logs an info level message.

func (Logger) Level

func (l Logger) Level() Level

Level returns the log level.

func (Logger) Warn

func (l Logger) Warn(kv ...interface{})

Warn logs a warn level message.

func (Logger) With

func (l Logger) With(kv ...interface{}) Logger

With returns a new contextual logger with keyvals prepended to those passed to calls to log.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option provides for Logger configuration.

func AsDefault

func AsDefault() Option

As default sets the DefaultLogger.

func WithFormat

func WithFormat(format Format) Option

WithFormat allows the format to be configured. The default format is FormatLogfmt.

func WithLevel

func WithLevel(level Level) Option

WithLevel allows the level to be configured. The default level is LevelInfo.

func WithOutput

func WithOutput(writer io.Writer) Option

WithOutput allows the format to be configured. The default writer is os.Stdout.

func WithoutTimestamp

func WithoutTimestamp() Option

WithoutTimestamp disables the use of a timestamp for logs. Useful for unit tests.

type StringBuffer

type StringBuffer struct {
	// contains filtered or unexported fields
}

StringBuffer implements a simple buffer that can be used in tests. It implements the io.Writer interface. Each write will append a string to the Buffer.

func NewStringBuffer

func NewStringBuffer() *StringBuffer

NewStringBuffer returns a StringBuffer.

func (*StringBuffer) Index

func (l *StringBuffer) Index(i int) string

func (*StringBuffer) Len

func (l *StringBuffer) Len() int

func (*StringBuffer) Write

func (l *StringBuffer) Write(p []byte) (int, error)

Write implements the io.Writer interface.