log

Documentation

Index

• Variables
• func Init(conf *Config)
• func SetLevel(lv Level)
• type CodecometWriter
  • func NewCodecometWriter(options ...func(w *CodecometWriter)) CodecometWriter
  • func (w CodecometWriter) Write(p []byte) (n int, err error)
• type Config
• type Event
  • func Debug() *Event
  • func Error() *Event
  • func Fatal() *Event
  • func Info() *Event
  • func LoggerForLevel(level string) *Event
  • func Trace() *Event
  • func Warn() *Event
• type Formatter
• type Level
  • func GetLevel() Level

Variables

var ContextFieldDefault = "core"

var ContextFieldName = "ctx"

var ModeFieldName = "mode"

Functions

func Init

func Init(conf *Config)

Init should be called when the app starts, from a config object.

func SetLevel

func SetLevel(lv Level)

Types

type CodecometWriter

type CodecometWriter struct {
	// Out is the output destination.
	Out io.Writer

	// NoColor disables the colorized output.
	NoColor bool

	// TimeFormat specifies the format for timestamp in output.
	TimeFormat string

	// PartsOrder defines the order of parts in output.
	PartsOrder []string

	// PartsExclude defines parts to not display in output.
	PartsExclude []string

	// FieldsExclude defines contextual fields to not display in output.
	FieldsExclude []string

	FormatTimestamp     Formatter
	FormatLevel         Formatter
	FormatMessage       Formatter
	FormatContext       Formatter
	FormatMode          Formatter
	FormatFieldName     Formatter
	FormatFieldValue    Formatter
	FormatErrFieldName  Formatter
	FormatErrFieldValue Formatter

	FormatExtra func(map[string]interface{}, *bytes.Buffer) error
}

CodecometWriter parses the JSON input and writes it in an (optionally) colorized, human-friendly format to Out.

func NewCodecometWriter

func NewCodecometWriter(options ...func(w *CodecometWriter)) CodecometWriter

NewCodecometWriter creates and initializes a new CodecometWriter.

func (CodecometWriter) Write

func (w CodecometWriter) Write(p []byte) (n int, err error)

Write transforms the JSON input with formatters and appends to w.Out.

type Config

type Config struct {
	Level Level `json:"level,omitempty"`
}

type Event

type Event = zerolog.Event

func Debug

func Debug() *Event

func Error

func Error() *Event

func Fatal

func Fatal() *Event

func Info

func Info() *Event

func LoggerForLevel

func LoggerForLevel(level string) *Event

func Trace

func Trace() *Event

func Warn

func Warn() *Event

type Formatter

type Formatter func(interface{}) string

Formatter transforms the input into a formatted string.

type Level

type Level = zerolog.Level

const (
	// DebugLevel defines debug log level.
	DebugLevel Level = iota
	// InfoLevel defines info log level.
	InfoLevel
	// WarnLevel defines warn log level.
	WarnLevel
	// ErrorLevel defines error log level.
	ErrorLevel
	// FatalLevel defines fatal log level.
	FatalLevel
	// PanicLevel defines panic log level.
	PanicLevel
	// NoLevel defines an absent log level.
	NoLevel
	// Disabled disables the logger.
	Disabled

	// TraceLevel defines trace log level.
	TraceLevel Level = -1
)

func GetLevel

func GetLevel() Level