log

Documentation

Overview

Package log provides logging abstractions.

Index

• func Debug(args ...interface{})
• func Debugf(msg string, args ...interface{})
• func Enabled(l Level) bool
• func Error(args ...interface{})
• func Errorf(msg string, args ...interface{})
• func Fatal(args ...interface{})
• func Fatalf(msg string, args ...interface{})
• func IncreaseDebugCounter()
• func IncreaseErrorCounter()
• func IncreaseFatalCounter()
• func IncreaseInfoCounter()
• func IncreasePanicCounter()
• func IncreaseWarnCounter()
• func Info(args ...interface{})
• func Infof(msg string, args ...interface{})
• func LevelCount(level string) prometheus.Counter
• func LevelOrder(lvl Level) int
• func Panic(args ...interface{})
• func Panicf(msg string, args ...interface{})
• func ResetLogCounter()
• func Setup(l Logger) error
• func Warn(args ...interface{})
• func Warnf(msg string, args ...interface{})
• func WithContext(ctx context.Context, l Logger) context.Context
• type Level
• type Logger
  • func FromContext(ctx context.Context) Logger
  • func Sub(ff map[string]interface{}) Logger

Functions

func Debug

func Debug(args ...interface{})

Debug logging.

func Debugf

func Debugf(msg string, args ...interface{})

Debugf logging.

func Enabled

func Enabled(l Level) bool

Enabled shows if the logger logs for the given level.

func Error

func Error(args ...interface{})

Error logging.

func Errorf

func Errorf(msg string, args ...interface{})

Errorf logging.

func Fatal

func Fatal(args ...interface{})

Fatal logging.

func Fatalf

func Fatalf(msg string, args ...interface{})

Fatalf logging.

func IncreaseDebugCounter

func IncreaseDebugCounter()

IncreaseDebugCounter increases the debug counter.

func IncreaseErrorCounter

func IncreaseErrorCounter()

IncreaseErrorCounter increases the error counter.

func IncreaseFatalCounter

func IncreaseFatalCounter()

IncreaseFatalCounter increases the fatal counter.

func IncreaseInfoCounter

func IncreaseInfoCounter()

IncreaseInfoCounter increases the info counter.

func IncreasePanicCounter

func IncreasePanicCounter()

IncreasePanicCounter increases the panic counter.

func IncreaseWarnCounter

func IncreaseWarnCounter()

IncreaseWarnCounter increases the warn counter.

func Info

func Info(args ...interface{})

Info logging.

func Infof

func Infof(msg string, args ...interface{})

Infof logging.

func LevelCount

func LevelCount(level string) prometheus.Counter

LevelCount returns the total level count.

func LevelOrder

func LevelOrder(lvl Level) int

LevelOrder returns the numerical order of the level.

func Panic

func Panic(args ...interface{})

Panic logging.

func Panicf

func Panicf(msg string, args ...interface{})

Panicf logging.

func ResetLogCounter

func ResetLogCounter()

ResetLogCounter resets the log counter.

func Setup

func Setup(l Logger) error

Setup logging by providing a logger factory.

func Warn

func Warn(args ...interface{})

Warn logging.

func Warnf

func Warnf(msg string, args ...interface{})

Warnf logging.

func WithContext

func WithContext(ctx context.Context, l Logger) context.Context

WithContext associates a logger with a context for later reuse.

Types

type Level

type Level string

The Level type definition.

const (
	// DebugLevel level.
	DebugLevel Level = "debug"
	// InfoLevel level.
	InfoLevel Level = "info"
	// WarnLevel level.
	WarnLevel Level = "warn"
	// ErrorLevel level.
	ErrorLevel Level = "error"
	// FatalLevel level.
	FatalLevel Level = "fatal"
	// PanicLevel level.
	PanicLevel Level = "panic"
	// NoLevel level.
	NoLevel Level = ""
)

type Logger

type Logger interface {
	Sub(map[string]interface{}) Logger
	Fatal(...interface{})
	Fatalf(string, ...interface{})
	Panic(...interface{})
	Panicf(string, ...interface{})
	Error(...interface{})
	Errorf(string, ...interface{})
	Warn(...interface{})
	Warnf(string, ...interface{})
	Info(...interface{})
	Infof(string, ...interface{})
	Debug(...interface{})
	Debugf(string, ...interface{})
	Level() Level
}

Logger interface definition of a logger.

func FromContext

func FromContext(ctx context.Context) Logger

FromContext returns the logger in the context or a nil logger.

func Sub

func Sub(ff map[string]interface{}) Logger

Sub returns a sub logger with new fields attached.