logging

Documentation

Overview

Package logging provides loggers for Kopia.

Index

• Variables
• func Module(module string) func(ctx context.Context) Logger
• func WithAdditionalLogger(ctx context.Context, fact LoggerFactory) context.Context
• func WithLogger(ctx context.Context, l LoggerFactory) context.Context
• type Buffer
  • func GetBuffer() *Buffer
  • func (b *Buffer) AppendBoolean(val bool) *Buffer
  • func (b *Buffer) AppendByte(val byte) *Buffer
  • func (b *Buffer) AppendBytes(val []byte) *Buffer
  • func (b *Buffer) AppendInt(val int64, base int) *Buffer
  • func (b *Buffer) AppendInt32(val int32) *Buffer
  • func (b *Buffer) AppendInt64(val int64) *Buffer
  • func (b *Buffer) AppendString(val string) *Buffer
  • func (b *Buffer) AppendTime(val time.Time, layout string) *Buffer
  • func (b *Buffer) AppendUint(val uint64, base int) *Buffer
  • func (b *Buffer) AppendUint32(val uint32) *Buffer
  • func (b *Buffer) AppendUint64(val uint64) *Buffer
  • func (b *Buffer) Release()
  • func (b *Buffer) Reset()
  • func (b *Buffer) String() string
• type Logger
  • func Broadcast(logger ...Logger) Logger
• type LoggerFactory
  • func ToWriter(w io.Writer) LoggerFactory

Variables

var NullLogger = zap.NewNop().Sugar()

NullLogger represents a singleton logger that discards all output.

Functions

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 WithAdditionalLogger

func WithAdditionalLogger(ctx context.Context, fact LoggerFactory) context.Context

WithAdditionalLogger returns a context where all logging is emitted the original output plus the provided logger factory.

func WithLogger

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

WithLogger returns a derived context with associated logger.

Types

type Buffer

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

Buffer is a specialized buffer that can be kept in a pool used for constructing logging messages without allocation.

func GetBuffer

func GetBuffer() *Buffer

GetBuffer gets a logging buffer.

func (*Buffer) AppendBoolean

func (b *Buffer) AppendBoolean(val bool) *Buffer

AppendBoolean appends boolean string ("true" or "false").

func (*Buffer) AppendByte

func (b *Buffer) AppendByte(val byte) *Buffer

AppendByte appends a single byte/character.

func (*Buffer) AppendBytes

func (b *Buffer) AppendBytes(val []byte) *Buffer

AppendBytes appends a slice of bytes.

func (*Buffer) AppendInt

func (b *Buffer) AppendInt(val int64, base int) *Buffer

AppendInt appends integer value formatted as a string in a given base.

func (*Buffer) AppendInt32

func (b *Buffer) AppendInt32(val int32) *Buffer

AppendInt32 appends int32 value formatted as a decimal string.

func (*Buffer) AppendInt64

func (b *Buffer) AppendInt64(val int64) *Buffer

AppendInt64 appends int64 value formatted as a decimal string.

func (*Buffer) AppendString

func (b *Buffer) AppendString(val string) *Buffer

AppendString appends a string of characters.

func (*Buffer) AppendTime

func (b *Buffer) AppendTime(val time.Time, layout string) *Buffer

AppendTime appends a time representation.

func (*Buffer) AppendUint

func (b *Buffer) AppendUint(val uint64, base int) *Buffer

AppendUint appends unsigned integer value formatted as a string in a given base.

func (*Buffer) AppendUint32

func (b *Buffer) AppendUint32(val uint32) *Buffer

AppendUint32 appends uint32 value formatted as a decimal string.

func (*Buffer) AppendUint64

func (b *Buffer) AppendUint64(val uint64) *Buffer

AppendUint64 appends uint64 value formatted as a decimal string.

func (*Buffer) Release

func (b *Buffer) Release()

Release releases logging buffer back to the pool.

func (*Buffer) Reset

func (b *Buffer) Reset()

Reset resets logging buffer back to zero length.

func (*Buffer) String

func (b *Buffer) String() string

String returns a string value of a buffer. The value is valud as long as string remains allocated and no Append*() methods have been called.

type Logger

type Logger = *zap.SugaredLogger

Logger is used by Kopia to emit various logs.

func Broadcast

func Broadcast(logger ...Logger) Logger

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

type LoggerFactory

type LoggerFactory func(module string) Logger

LoggerFactory retrieves a named logger for a given module.

func ToWriter

func ToWriter(w io.Writer) LoggerFactory

ToWriter returns LoggerFactory that uses given writer for log output (unadorned).