logging

Documentation

Overview

Package logging provides loggers for Kopia.

Index

• func AlsoLogTo(ctx context.Context, loggers ...Logger) context.Context
• func DebugMessageWithKeyValuePairs(msg string, keyValuePairs []interface{}) string
• func Module(module string) func(ctx context.Context) Logger
• func WithLogger(ctx context.Context, l LoggerFactory) context.Context
• type Broadcast
  • func (b Broadcast) Debugf(msg string, args ...interface{})
  • func (b Broadcast) Debugw(msg string, keyValuePairs ...interface{})
  • func (b Broadcast) Errorf(msg string, args ...interface{})
  • func (b Broadcast) Infof(msg string, args ...interface{})
  • func (b Broadcast) Warnf(msg string, args ...interface{})
• type Logger
  • func NullLogger() Logger
  • func Printf(printf func(msg string, args ...interface{}), prefix string) Logger
  • func WithPrefix(prefix string, logger Logger) Logger
• type LoggerFactory
  • func PrintfFactory(printf func(msg string, args ...interface{})) LoggerFactory
  • func Writer(w io.Writer) LoggerFactory

Functions

func AlsoLogTo

func AlsoLogTo(ctx context.Context, loggers ...Logger) context.Context

AlsoLogTo returns a context where all logging is emitted the the original output plus the provided loggers.

func DebugMessageWithKeyValuePairs

func DebugMessageWithKeyValuePairs(msg string, keyValuePairs []interface{}) string

DebugMessageWithKeyValuePairs returns a debug string consisting of alternating key:value separated by spaces and prefixed with a space.

func Module

func Module(module string) func(ctx context.Context) Logger

Module returns an function that returns a logger for a given module when provided with a context.

func WithLogger

func WithLogger(ctx context.Context, l LoggerFactory) context.Context

WithLogger returns a derived context with associated logger.

Types

type Broadcast

type Broadcast []Logger

Broadcast is a logger that broadcasts each log message to multiple loggers.

func (Broadcast) Debugf

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

Debugf implements Logger.

func (Broadcast) Debugw

func (b Broadcast) Debugw(msg string, keyValuePairs ...interface{})

Debugw implements Logger.

func (Broadcast) Errorf

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

Errorf implements Logger.

func (Broadcast) Infof

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

Infof implements Logger.

func (Broadcast) Warnf

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

Warnf implements Logger.

type Logger

type Logger interface {
	Debugf(msg string, args ...interface{})
	Debugw(msg string, keyValuePairs ...interface{})
	Infof(msg string, args ...interface{})
	Warnf(msg string, args ...interface{})
	Errorf(msg string, args ...interface{})
}

Logger is an interface used by Kopia to output logs.

func NullLogger

func NullLogger() Logger

NullLogger is a null logger that discards all log messages.

func Printf

func Printf(printf func(msg string, args ...interface{}), prefix string) Logger

Printf returns a logger that uses given printf-style function to print log output.

func WithPrefix

func WithPrefix(prefix string, logger Logger) Logger

WithPrefix returns a wrapper logger that attaches given prefix to each message.

type LoggerFactory

type LoggerFactory func(module string) Logger

LoggerFactory retrieves logger for a given module.

func PrintfFactory

func PrintfFactory(printf func(msg string, args ...interface{})) LoggerFactory

PrintfFactory returns LoggerForModuleFunc that uses given printf-style function to print log output.

func Writer

func Writer(w io.Writer) LoggerFactory

Writer returns LoggerForModuleFunc that uses given writer for log output.