zap

Documentation

Overview

Package zap contains helpers for setting up a new logr.Logger instance using the Zap logging framework.

Index

• func Encoder(encoder zapcore.Encoder) func(o *Options)
• func Level(level *zap.AtomicLevel) func(o *Options)
• func Logger(development bool) logr.Logger
• func LoggerTo(destWriter io.Writer, development bool) logr.Logger
• func New(opts ...Opts) logr.Logger
• func NewRaw(opts ...Opts) *zap.Logger
• func RawLoggerTo(destWriter io.Writer, development bool, opts ...zap.Option) *zap.Logger
• func RawZapOpts(zapOpts ...zap.Option) func(o *Options)
• func StacktraceLevel(stacktraceLevel *zap.AtomicLevel) func(o *Options)
• type KubeAwareEncoder
  • func (k *KubeAwareEncoder) Clone() zapcore.Encoder
  • func (k *KubeAwareEncoder) EncodeEntry(entry zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error)
• type Options
• type Opts
  • func UseDevMode(enabled bool) Opts
  • func WriteTo(out io.Writer) Opts

Functions

func Encoder

func Encoder(encoder zapcore.Encoder) func(o *Options)

Encoder configures how the logger will encode the output e.g JSON or console. See Options.Encoder

func Level

func Level(level *zap.AtomicLevel) func(o *Options)

Level sets the the minimum enabled logging level e.g Debug, Info See Options.Level

func Logger

func Logger(development bool) logr.Logger

Logger is a Logger implementation. If development is true, a Zap development config will be used (stacktraces on warnings, no sampling), otherwise a Zap production config will be used (stacktraces on errors, sampling).

Deprecated: use New() and the functional opts pattern instead:

New(UseDevMode(development))

func LoggerTo

func LoggerTo(destWriter io.Writer, development bool) logr.Logger

LoggerTo returns a new Logger implementation using Zap which logs to the given destination, instead of stderr. It otherwise behaves like ZapLogger.

Deprecated: use New() and the functional opts pattern instead:

New(UseDevMode(development), WriteTo(writer))

func New

func New(opts ...Opts) logr.Logger

New returns a brand new Logger configured with Opts. It uses KubeAwareEncoder which adds Type information and Namespace/Name to the log.

func NewRaw

func NewRaw(opts ...Opts) *zap.Logger

NewRaw returns a new zap.Logger configured with the passed Opts or their defaults. It uses KubeAwareEncoder which adds Type information and Namespace/Name to the log.

func RawLoggerTo

func RawLoggerTo(destWriter io.Writer, development bool, opts ...zap.Option) *zap.Logger

RawLoggerTo returns a new zap.Logger configured with KubeAwareEncoder which logs to a given destination

Deprecated: use NewRaw() and the functional opts pattern instead:

NewRaw(UseDevMode(development), WriteTo(destWriter), RawZapOpts(opts...))

func RawZapOpts

func RawZapOpts(zapOpts ...zap.Option) func(o *Options)

RawZapOpts allows appending arbitrary zap.Options to configure the underlying zap logger. See Options.ZapOpts

func StacktraceLevel

func StacktraceLevel(stacktraceLevel *zap.AtomicLevel) func(o *Options)

StacktraceLevel configures the logger to record a stack trace for all messages at or above a given level. See Options.StacktraceLevel

Types

type KubeAwareEncoder

type KubeAwareEncoder struct {
	// Encoder is the zapcore.Encoder that this encoder delegates to
	zapcore.Encoder

	// Verbose controls whether or not the full object is printed.
	// If false, only name, namespace, api version, and kind are printed.
	// Otherwise, the full object is logged.
	Verbose bool
}

KubeAwareEncoder is a Kubernetes-aware Zap Encoder. Instead of trying to force Kubernetes objects to implement ObjectMarshaller, we just implement a wrapper around a normal ObjectMarshaller that checks for Kubernetes objects.

func (*KubeAwareEncoder) Clone

func (k *KubeAwareEncoder) Clone() zapcore.Encoder

Clone implements zapcore.Encoder

func (*KubeAwareEncoder) EncodeEntry

func (k *KubeAwareEncoder) EncodeEntry(entry zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error)

EncodeEntry implements zapcore.Encoder

type Options

type Options struct {
	// Development configures the logger to use a Zap development config
	// (stacktraces on warnings, no sampling), otherwise a Zap production
	// config will be used (stacktraces on errors, sampling).
	Development bool
	// Encoder configures how Zap will encode the output.  Defaults to
	// console when Development is true and JSON otherwise
	Encoder zapcore.Encoder
	// DestWritter controls the destination of the log output.  Defaults to
	// os.Stderr.
	DestWritter io.Writer
	// Level configures the verbosity of the logging.  Defaults to Debug when
	// Development is true and Info otherwise
	Level *zap.AtomicLevel
	// StacktraceLevel is the level at and above which stacktraces will
	// be recorded for all messages. Defaults to Warn when Development
	// is true and Error otherwise
	StacktraceLevel *zap.AtomicLevel
	// ZapOpts allows passing arbitrary zap.Options to configure on the
	// underlying Zap logger.
	ZapOpts []zap.Option
}

Options contains all possible settings

type Opts

type Opts func(*Options)

Opts allows to manipulate Options

func UseDevMode

func UseDevMode(enabled bool) Opts

UseDevMode sets the logger to use (or not use) development mode (more human-readable output, extra stack traces and logging information, etc). See Options.Development

func WriteTo

func WriteTo(out io.Writer) Opts

WriteTo configures the logger to write to the given io.Writer, instead of standard error. See Options.DestWritter