log

Documentation

Overview

Package log has been graciously copied from KKP (Copyright 2020 The Kubermatic Kubernetes Platform contributors).

Index

• Variables
• func New(debug bool, format Format) *zap.Logger
• func NewDefault() *zap.Logger
• func NewFromOptions(o Options) *zap.Logger
• type Format
  • func (f *Format) Set(s string) error
  • func (f *Format) String() string
  • func (f *Format) Type() string
• type Formats
  • func (f Formats) Contains(s Format) bool
  • func (f Formats) String() string
• type Options
  • func NewDefaultOptions() Options
  • func (o *Options) AddFlags(fs *flag.FlagSet)
  • func (o *Options) AddPFlags(fs *pflag.FlagSet)
  • func (o *Options) Validate() error

Variables

var (
	AvailableFormats = Formats{FormatJSON, FormatConsole}
)

var Logger *zap.SugaredLogger

Functions

func New

func New(debug bool, format Format) *zap.Logger

func NewDefault

func NewDefault() *zap.Logger

NewDefault creates new default logger.

func NewFromOptions

func NewFromOptions(o Options) *zap.Logger

Types

type Format

type Format string

const (
	FormatJSON    Format = "JSON"
	FormatConsole Format = "Console"
)

func (*Format) Set

func (f *Format) Set(s string) error

Set implements the cli.Value and flag.Value interfaces.

func (*Format) String

func (f *Format) String() string

String implements the cli.Value and flag.Value interfaces.

func (*Format) Type

func (f *Format) Type() string

Type implements the pflag.Value interfaces.

type Formats

type Formats []Format

func (Formats) Contains

func (f Formats) Contains(s Format) bool

func (Formats) String

func (f Formats) String() string

type Options

type Options struct {
	// Enable debug logs
	Debug bool
	// Log format (JSON or plain text)
	Format Format
}

Options exports a options struct to be used by cmd's.

func NewDefaultOptions

func NewDefaultOptions() Options

func (*Options) AddFlags

func (o *Options) AddFlags(fs *flag.FlagSet)

func (*Options) AddPFlags

func (o *Options) AddPFlags(fs *pflag.FlagSet)

func (*Options) Validate

func (o *Options) Validate() error