const (
// TimeFormatUnix defines a time format that makes time fields to be
// serialized as Unix timestamp integers.
TimeFormatUnix = ""
// TimeFormatUnixMs defines a time format that makes time fields to be
// serialized as Unix timestamp integers in milliseconds.
TimeFormatUnixMs = "UNIXMS"
// TimeFormatUnixMicro defines a time format that makes time fields to be
// serialized as Unix timestamp integers in microseconds.
TimeFormatUnixMicro = "UNIXMICRO"
// TimeFormatUnixNano defines a time format that makes time fields to be
// serialized as Unix timestamp integers in nanoseconds.
TimeFormatUnixNano = "UNIXNANO"
)
var (
// TimestampFieldName is the field name used for the timestamp field.
TimestampFieldName = "time"
// LevelFieldName is the field name used for the level field.
LevelFieldName = "level"
// LevelTraceValue is the value used for the trace level field.
LevelTraceValue = "trace"
// LevelDebugValue is the value used for the debug level field.
LevelDebugValue = "debug"
// LevelInfoValue is the value used for the info level field.
LevelInfoValue = "info"
// LevelWarnValue is the value used for the warn level field.
LevelWarnValue = "warn"
// LevelErrorValue is the value used for the error level field.
LevelErrorValue = "error"
// LevelFatalValue is the value used for the fatal level field.
LevelFatalValue = "fatal"
// LevelPanicValue is the value used for the panic level field.
LevelPanicValue = "panic"
// LevelFieldMarshalFunc allows customization of global level field marshaling.
LevelFieldMarshalFunc = func(l Level) string {
return l.String()
}
// MessageFieldName is the field name used for the message field.
MessageFieldName = "message"
// ErrorFieldName is the field name used for error fields.
ErrorFieldName = "error"
// CallerFieldName is the field name used for caller field.
CallerFieldName = "caller"
// CallerSkipFrameCount is the number of stack frames to skip to find the caller.
CallerSkipFrameCount = 2
// CallerMarshalFunc allows customization of global caller marshaling
CallerMarshalFunc = func(pc uintptr, file string, line int) string {
return file + ":" + strconv.Itoa(line)
}
// ErrorStackFieldName is the field name used for error stacks.
ErrorStackFieldName = "stack"
// ErrorStackMarshaler extract the stack from err if any.
ErrorStackMarshaler func(err error) interface{}
// ErrorMarshalFunc allows customization of global error marshaling
ErrorMarshalFunc = func(err error) interface{} {
return err
}
// InterfaceMarshalFunc allows customization of interface marshaling.
// Default: "encoding/json.Marshal"
InterfaceMarshalFunc = json.Marshal
// TimeFieldFormat defines the time format of the Time field type. If set to
// TimeFormatUnix, TimeFormatUnixMs, TimeFormatUnixMicro or TimeFormatUnixNano, the time is formatted as a UNIX
// timestamp as integer.
TimeFieldFormat = time.RFC3339
// TimestampFunc defines the function called to generate a timestamp.
TimestampFunc = time.Now
// DurationFieldUnit defines the unit for time.Duration type fields added
// using the Dur method.
DurationFieldUnit = time.Millisecond
// DurationFieldInteger renders Dur fields as integer instead of float if
// set to true.
DurationFieldInteger = false
// ErrorHandler is called whenever zerolog fails to write an event on its
// output. If not set, an error is printed on the stderr. This handler must
// be thread safe and non-blocking.
ErrorHandler func(err error)
// DefaultContextLogger is returned from Ctx() if there is no logger associated
// with the context.
DefaultContextLogger *Logger
)
var (
// Often samples log every ~ 10 events.
Often = RandomSampler(10)
// Sometimes samples log every ~ 100 events.
Sometimes = RandomSampler(100)
// Rarely samples log every ~ 1000 events.
Rarely = RandomSampler(1000)
)
func ConsoleTestWriter(t TestingLog) func(w *ConsoleWriter)
ConsoleTestWriter creates an option that correctly sets the file frame depth for testing.TB log.
func DisableSampling(v bool)
DisableSampling will disable sampling in all Loggers if true.
func SetGlobalLevel(l Level)
SetGlobalLevel sets the global override for log level. If this values is raised, all Loggers will use at least this value.
To globally disable logs, set GlobalLevel to Disabled.
func SyncWriter(w io.Writer) io.Writer
SyncWriter wraps w so that each call to Write is synchronized with a mutex. This syncer can be used to wrap the call to writer's Write method if it is not thread safe. Note that you do not need this wrapper for os.File Write operations on POSIX and Windows systems as they are already thread-safe.
Array is used to prepopulate an array of items which can be re-used to add to log messages.
type Array struct {
// contains filtered or unexported fields
}
func Arr() *Array
Arr creates an array to be added to an Event or Context.
func (a *Array) Bool(b bool) *Array
Bool append append the val as a bool to the array.
func (a *Array) Bytes(val []byte) *Array
Bytes append append the val as a string to the array.
func (a *Array) Dict(dict *Event) *Array
Dict adds the dict Event to the array
func (a *Array) Dur(d time.Duration) *Array
Dur append append d to the array.
func (a *Array) Err(err error) *Array
Err serializes and appends the err to the array.
func (a *Array) Float32(f float32) *Array
Float32 append append f as a float32 to the array.
func (a *Array) Float64(f float64) *Array
Float64 append append f as a float64 to the array.
func (a *Array) Hex(val []byte) *Array
Hex append append the val as a hex string to the array.
func (a *Array) IPAddr(ip net.IP) *Array
IPAddr adds IPv4 or IPv6 address to the array
func (a *Array) IPPrefix(pfx net.IPNet) *Array
IPPrefix adds IPv4 or IPv6 Prefix (IP + mask) to the array
func (a *Array) Int(i int) *Array
Int append append i as a int to the array.
func (a *Array) Int16(i int16) *Array
Int16 append append i as a int16 to the array.
func (a *Array) Int32(i int32) *Array
Int32 append append i as a int32 to the array.
func (a *Array) Int64(i int64) *Array
Int64 append append i as a int64 to the array.
func (a *Array) Int8(i int8) *Array
Int8 append append i as a int8 to the array.
func (a *Array) Interface(i interface{}) *Array
Interface append append i marshaled using reflection.
func (a *Array) MACAddr(ha net.HardwareAddr) *Array
MACAddr adds a MAC (Ethernet) address to the array
func (*Array) MarshalZerologArray(*Array)
MarshalZerologArray method here is no-op - since data is already in the needed format.
func (a *Array) Object(obj LogObjectMarshaler) *Array
Object marshals an object that implement the LogObjectMarshaler interface and append append it to the array.
func (a *Array) RawJSON(val []byte) *Array
RawJSON adds already encoded JSON to the array.
func (a *Array) Str(val string) *Array
Str append append the val as a string to the array.
func (a *Array) Time(t time.Time) *Array
Time append append t formatted as string using zerolog.TimeFieldFormat.
func (a *Array) Uint(i uint) *Array
Uint append append i as a uint to the array.
func (a *Array) Uint16(i uint16) *Array
Uint16 append append i as a uint16 to the array.
func (a *Array) Uint32(i uint32) *Array
Uint32 append append i as a uint32 to the array.
func (a *Array) Uint64(i uint64) *Array
Uint64 append append i as a uint64 to the array.
func (a *Array) Uint8(i uint8) *Array
Uint8 append append i as a uint8 to the array.
BasicSampler is a sampler that will send every Nth events, regardless of their level.
type BasicSampler struct {
N uint32
// contains filtered or unexported fields
}
func (s *BasicSampler) Sample(lvl Level) bool
Sample implements the Sampler interface.
BurstSampler lets Burst events pass per Period then pass the decision to NextSampler. If Sampler is not set, all subsequent events are rejected.
type BurstSampler struct {
// Burst is the maximum number of event per period allowed before calling
// NextSampler.
Burst uint32
// Period defines the burst period. If 0, NextSampler is always called.
Period time.Duration
// NextSampler is the sampler used after the burst is reached. If nil,
// events are always rejected after the burst.
NextSampler Sampler
// contains filtered or unexported fields
}
func (s *BurstSampler) Sample(lvl Level) bool
Sample implements the Sampler interface.
ConsoleWriter parses the JSON input and writes it in an (optionally) colorized, human-friendly format to Out.
type ConsoleWriter 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
FormatCaller Formatter
FormatMessage Formatter
FormatFieldName Formatter
FormatFieldValue Formatter
FormatErrFieldName Formatter
FormatErrFieldValue Formatter
FormatExtra func(map[string]interface{}, *bytes.Buffer) error
}
▹ Example
▹ Example (CustomFormatters)
func NewConsoleWriter(options ...func(w *ConsoleWriter)) ConsoleWriter
NewConsoleWriter creates and initializes a new ConsoleWriter.
▹ Example
▹ Example (CustomFormatters)
func (w ConsoleWriter) Write(p []byte) (n int, err error)
Write transforms the JSON input with formatters and appends to w.Out.
Context configures a new sub-logger with contextual fields.
type Context struct {
// contains filtered or unexported fields
}
func (c Context) AnErr(key string, err error) Context
AnErr adds the field key with serialized err to the logger context.
func (c Context) Array(key string, arr LogArrayMarshaler) Context
Array adds the field key with an array to the event context. Use zerolog.Arr() to create the array or pass a type that implement the LogArrayMarshaler interface.
▹ Example
▹ Example (Object)
func (c Context) Bool(key string, b bool) Context
Bool adds the field key with val as a bool to the logger context.
func (c Context) Bools(key string, b []bool) Context
Bools adds the field key with val as a []bool to the logger context.
func (c Context) Bytes(key string, val []byte) Context
Bytes adds the field key with val as a []byte to the logger context.
func (c Context) Caller() Context
Caller adds the file:line of the caller with the zerolog.CallerFieldName key.
func (c Context) CallerWithSkipFrameCount(skipFrameCount int) Context
CallerWithSkipFrameCount adds the file:line of the caller with the zerolog.CallerFieldName key. The specified skipFrameCount int will override the global CallerSkipFrameCount for this context's respective logger. If set to -1 the global CallerSkipFrameCount will be used.
func (c Context) Dict(key string, dict *Event) Context
Dict adds the field key with the dict to the logger context.
▹ Example
func (c Context) Dur(key string, d time.Duration) Context
Dur adds the fields key with d divided by unit and stored as a float.
▹ Example
func (c Context) Durs(key string, d []time.Duration) Context
Durs adds the fields key with d divided by unit and stored as a float.
▹ Example
func (c Context) EmbedObject(obj LogObjectMarshaler) Context
EmbedObject marshals and Embeds an object that implement the LogObjectMarshaler interface.
▹ Example
func (c Context) Err(err error) Context
Err adds the field "error" with serialized err to the logger context.
func (c Context) Errs(key string, errs []error) Context
Errs adds the field key with errs as an array of serialized errors to the logger context.
func (c Context) Fields(fields interface{}) Context
Fields is a helper function to use a map or slice to set fields using type assertion. Only map[string]interface{} and []interface{} are accepted. []interface{} must alternate string keys and arbitrary values, and extraneous ones are ignored.
▹ Example (Map)
▹ Example (Slice)
func (c Context) Float32(key string, f float32) Context
Float32 adds the field key with f as a float32 to the logger context.
func (c Context) Float64(key string, f float64) Context
Float64 adds the field key with f as a float64 to the logger context.
func (c Context) Floats32(key string, f []float32) Context
Floats32 adds the field key with f as a []float32 to the logger context.
func (c Context) Floats64(key string, f []float64) Context
Floats64 adds the field key with f as a []float64 to the logger context.
func (c Context) Hex(key string, val []byte) Context
Hex adds the field key with val as a hex string to the logger context.
func (c Context) IPAddr(key string, ip net.IP) Context
IPAddr adds IPv4 or IPv6 Address to the context
▹ Example
func (c Context) IPPrefix(key string, pfx net.IPNet) Context
IPPrefix adds IPv4 or IPv6 Prefix (address and mask) to the context
▹ Example
func (c Context) Int(key string, i int) Context
Int adds the field key with i as a int to the logger context.
func (c Context) Int16(key string, i int16) Context
Int16 adds the field key with i as a int16 to the logger context.
func (c Context) Int32(key string, i int32) Context
Int32 adds the field key with i as a int32 to the logger context.
func (c Context) Int64(key string, i int64) Context
Int64 adds the field key with i as a int64 to the logger context.
func (c Context) Int8(key string, i int8) Context
Int8 adds the field key with i as a int8 to the logger context.
func (c Context) Interface(key string, i interface{}) Context
Interface adds the field key with obj marshaled using reflection.
▹ Example
func (c Context) Ints(key string, i []int) Context
Ints adds the field key with i as a []int to the logger context.
func (c Context) Ints16(key string, i []int16) Context
Ints16 adds the field key with i as a []int16 to the logger context.
func (c Context) Ints32(key string, i []int32) Context
Ints32 adds the field key with i as a []int32 to the logger context.
func (c Context) Ints64(key string, i []int64) Context
Ints64 adds the field key with i as a []int64 to the logger context.
func (c Context) Ints8(key string, i []int8) Context
Ints8 adds the field key with i as a []int8 to the logger context.
func (c Context) Logger() Logger
Logger returns the logger with the context previously set.
func (c Context) MACAddr(key string, ha net.HardwareAddr) Context
MACAddr adds MAC address to the context
▹ Example
func (c Context) Object(key string, obj LogObjectMarshaler) Context
Object marshals an object that implement the LogObjectMarshaler interface.
▹ Example
func (c Context) RawJSON(key string, b []byte) Context
RawJSON adds already encoded JSON to context.
No sanity check is performed on b; it must not contain carriage returns and be valid JSON.
func (c Context) Stack() Context
Stack enables stack trace printing for the error passed to Err().
func (c Context) Str(key, val string) Context
Str adds the field key with val as a string to the logger context.
func (c Context) Stringer(key string, val fmt.Stringer) Context
Stringer adds the field key with val.String() (or null if val is nil) to the logger context.
func (c Context) Strs(key string, vals []string) Context
Strs adds the field key with val as a string to the logger context.
func (c Context) Time(key string, t time.Time) Context
Time adds the field key with t formated as string using zerolog.TimeFieldFormat.
func (c Context) Times(key string, t []time.Time) Context
Times adds the field key with t formated as string using zerolog.TimeFieldFormat.
func (c Context) Timestamp() Context
Timestamp adds the current local time as UNIX timestamp to the logger context with the "time" key. To customize the key name, change zerolog.TimestampFieldName.
NOTE: It won't dedupe the "time" key if the *Context has one already.
func (c Context) Uint(key string, i uint) Context
Uint adds the field key with i as a uint to the logger context.
func (c Context) Uint16(key string, i uint16) Context
Uint16 adds the field key with i as a uint16 to the logger context.
func (c Context) Uint32(key string, i uint32) Context
Uint32 adds the field key with i as a uint32 to the logger context.
func (c Context) Uint64(key string, i uint64) Context
Uint64 adds the field key with i as a uint64 to the logger context.
func (c Context) Uint8(key string, i uint8) Context
Uint8 adds the field key with i as a uint8 to the logger context.
func (c Context) Uints(key string, i []uint) Context
Uints adds the field key with i as a []uint to the logger context.
func (c Context) Uints16(key string, i []uint16) Context
Uints16 adds the field key with i as a []uint16 to the logger context.
func (c Context) Uints32(key string, i []uint32) Context
Uints32 adds the field key with i as a []uint32 to the logger context.
func (c Context) Uints64(key string, i []uint64) Context
Uints64 adds the field key with i as a []uint64 to the logger context.
func (c Context) Uints8(key string, i []uint8) Context
Uints8 adds the field key with i as a []uint8 to the logger context.
Event represents a log event. It is instanced by one of the level method of Logger and finalized by the Msg or Msgf method.
type Event struct {
// contains filtered or unexported fields
}
func Dict() *Event
Dict creates an Event to be used with the *Event.Dict method. Call usual field methods like Str, Int etc to add fields to this event and give it as argument the *Event.Dict method.
func (e *Event) AnErr(key string, err error) *Event
AnErr adds the field key with serialized err to the *Event context. If err is nil, no field is added.
func (e *Event) Array(key string, arr LogArrayMarshaler) *Event
Array adds the field key with an array to the event context. Use zerolog.Arr() to create the array or pass a type that implement the LogArrayMarshaler interface.
▹ Example
▹ Example (Object)
func (e *Event) Bool(key string, b bool) *Event
Bool adds the field key with val as a bool to the *Event context.
func (e *Event) Bools(key string, b []bool) *Event
Bools adds the field key with val as a []bool to the *Event context.
func (e *Event) Bytes(key string, val []byte) *Event
Bytes adds the field key with val as a string to the *Event context.
Runes outside of normal ASCII ranges will be hex-encoded in the resulting JSON.
func (e *Event) Caller(skip ...int) *Event
Caller adds the file:line of the caller with the zerolog.CallerFieldName key. The argument skip is the number of stack frames to ascend Skip If not passed, use the global variable CallerSkipFrameCount
func (e *Event) CallerSkipFrame(skip int) *Event
CallerSkipFrame instructs any future Caller calls to skip the specified number of frames. This includes those added via hooks from the context.
func (e *Event) Dict(key string, dict *Event) *Event
Dict adds the field key with a dict to the event context. Use zerolog.Dict() to create the dictionary.
▹ Example
func (e *Event) Discard() *Event
Discard disables the event so Msg(f) won't print it.
func (e *Event) Dur(key string, d time.Duration) *Event
Dur adds the field key with duration d stored as zerolog.DurationFieldUnit. If zerolog.DurationFieldInteger is true, durations are rendered as integer instead of float.
▹ Example
func (e *Event) Durs(key string, d []time.Duration) *Event
Durs adds the field key with duration d stored as zerolog.DurationFieldUnit. If zerolog.DurationFieldInteger is true, durations are rendered as integer instead of float.
▹ Example
func (e *Event) EmbedObject(obj LogObjectMarshaler) *Event
EmbedObject marshals an object that implement the LogObjectMarshaler interface.
▹ Example
func (e *Event) Enabled() bool
Enabled return false if the *Event is going to be filtered out by log level or sampling.
func (e *Event) Err(err error) *Event
Err adds the field "error" with serialized err to the *Event context. If err is nil, no field is added.
To customize the key name, change zerolog.ErrorFieldName.
If Stack() has been called before and zerolog.ErrorStackMarshaler is defined, the err is passed to ErrorStackMarshaler and the result is appended to the zerolog.ErrorStackFieldName.
func (e *Event) Errs(key string, errs []error) *Event
Errs adds the field key with errs as an array of serialized errors to the *Event context.
func (e *Event) Fields(fields interface{}) *Event
Fields is a helper function to use a map or slice to set fields using type assertion. Only map[string]interface{} and []interface{} are accepted. []interface{} must alternate string keys and arbitrary values, and extraneous ones are ignored.
▹ Example (Map)
▹ Example (Slice)
func (e *Event) Float32(key string, f float32) *Event
Float32 adds the field key with f as a float32 to the *Event context.
func (e *Event) Float64(key string, f float64) *Event
Float64 adds the field key with f as a float64 to the *Event context.
func (e *Event) Floats32(key string, f []float32) *Event
Floats32 adds the field key with f as a []float32 to the *Event context.
func (e *Event) Floats64(key string, f []float64) *Event
Floats64 adds the field key with f as a []float64 to the *Event context.
func (e *Event) Func(f func(e *Event)) *Event
Func allows an anonymous func to run only if the event is enabled.
func (e *Event) Hex(key string, val []byte) *Event
Hex adds the field key with val as a hex string to the *Event context.
func (e *Event) IPAddr(key string, ip net.IP) *Event
IPAddr adds IPv4 or IPv6 Address to the event
func (e *Event) IPPrefix(key string, pfx net.IPNet) *Event
IPPrefix adds IPv4 or IPv6 Prefix (address and mask) to the event
func (e *Event) Int(key string, i int) *Event
Int adds the field key with i as a int to the *Event context.
func (e *Event) Int16(key string, i int16) *Event
Int16 adds the field key with i as a int16 to the *Event context.
func (e *Event) Int32(key string, i int32) *Event
Int32 adds the field key with i as a int32 to the *Event context.
func (e *Event) Int64(key string, i int64) *Event
Int64 adds the field key with i as a int64 to the *Event context.
func (e *Event) Int8(key string, i int8) *Event
Int8 adds the field key with i as a int8 to the *Event context.
func (e *Event) Interface(key string, i interface{}) *Event
Interface adds the field key with i marshaled using reflection.
▹ Example
func (e *Event) Ints(key string, i []int) *Event
Ints adds the field key with i as a []int to the *Event context.
func (e *Event) Ints16(key string, i []int16) *Event
Ints16 adds the field key with i as a []int16 to the *Event context.
func (e *Event) Ints32(key string, i []int32) *Event
Ints32 adds the field key with i as a []int32 to the *Event context.
func (e *Event) Ints64(key string, i []int64) *Event
Ints64 adds the field key with i as a []int64 to the *Event context.
func (e *Event) Ints8(key string, i []int8) *Event
Ints8 adds the field key with i as a []int8 to the *Event context.
func (e *Event) MACAddr(key string, ha net.HardwareAddr) *Event
MACAddr adds MAC address to the event
func (e *Event) Msg(msg string)
Msg sends the *Event with msg added as the message field if not empty.
NOTICE: once this method is called, the *Event should be disposed. Calling Msg twice can have unexpected result.
func (e *Event) MsgFunc(createMsg func() string)
func (e *Event) Msgf(format string, v ...interface{})
Msgf sends the event with formatted msg added as the message field if not empty.
NOTICE: once this method is called, the *Event should be disposed. Calling Msgf twice can have unexpected result.
func (e *Event) Object(key string, obj LogObjectMarshaler) *Event
Object marshals an object that implement the LogObjectMarshaler interface.
▹ Example
func (e *Event) RawJSON(key string, b []byte) *Event
RawJSON adds already encoded JSON to the log line under key.
No sanity check is performed on b; it must not contain carriage returns and be valid JSON.
func (e *Event) Send()
Send is equivalent to calling Msg("").
NOTICE: once this method is called, the *Event should be disposed.
func (e *Event) Stack() *Event
Stack enables stack trace printing for the error passed to Err().
ErrorStackMarshaler must be set for this method to do something.
func (e *Event) Str(key, val string) *Event
Str adds the field key with val as a string to the *Event context.
func (e *Event) Stringer(key string, val fmt.Stringer) *Event
Stringer adds the field key with val.String() (or null if val is nil) to the *Event context.
func (e *Event) Stringers(key string, vals []fmt.Stringer) *Event
Stringers adds the field key with vals where each individual val is used as val.String() (or null if val is empty) to the *Event context.
func (e *Event) Strs(key string, vals []string) *Event
Strs adds the field key with vals as a []string to the *Event context.
func (e *Event) Time(key string, t time.Time) *Event
Time adds the field key with t formatted as string using zerolog.TimeFieldFormat.
func (e *Event) TimeDiff(key string, t time.Time, start time.Time) *Event
TimeDiff adds the field key with positive duration between time t and start. If time t is not greater than start, duration will be 0. Duration format follows the same principle as Dur().
func (e *Event) Times(key string, t []time.Time) *Event
Times adds the field key with t formatted as string using zerolog.TimeFieldFormat.
func (e *Event) Timestamp() *Event
Timestamp adds the current local time as UNIX timestamp to the *Event context with the "time" key. To customize the key name, change zerolog.TimestampFieldName.
NOTE: It won't dedupe the "time" key if the *Event (or *Context) has one already.
func (e *Event) Uint(key string, i uint) *Event
Uint adds the field key with i as a uint to the *Event context.
func (e *Event) Uint16(key string, i uint16) *Event
Uint16 adds the field key with i as a uint16 to the *Event context.
func (e *Event) Uint32(key string, i uint32) *Event
Uint32 adds the field key with i as a uint32 to the *Event context.
func (e *Event) Uint64(key string, i uint64) *Event
Uint64 adds the field key with i as a uint64 to the *Event context.
func (e *Event) Uint8(key string, i uint8) *Event
Uint8 adds the field key with i as a uint8 to the *Event context.
func (e *Event) Uints(key string, i []uint) *Event
Uints adds the field key with i as a []int to the *Event context.
func (e *Event) Uints16(key string, i []uint16) *Event
Uints16 adds the field key with i as a []int16 to the *Event context.
func (e *Event) Uints32(key string, i []uint32) *Event
Uints32 adds the field key with i as a []int32 to the *Event context.
func (e *Event) Uints64(key string, i []uint64) *Event
Uints64 adds the field key with i as a []int64 to the *Event context.
func (e *Event) Uints8(key string, i []uint8) *Event
Uints8 adds the field key with i as a []int8 to the *Event context.
Formatter transforms the input into a formatted string.
type Formatter func(interface{}) string
Hook defines an interface to a log hook.
type Hook interface {
// Run runs the hook with the event.
Run(e *Event, level Level, message string)
}
HookFunc is an adaptor to allow the use of an ordinary function as a Hook.
type HookFunc func(e *Event, level Level, message string)
func (h HookFunc) Run(e *Event, level Level, message string)
Run implements the Hook interface.
Level defines log levels.
type Level int8
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 GlobalLevel() Level
GlobalLevel returns the current global log level
func ParseLevel(levelStr string) (Level, error)
ParseLevel converts a level string into a zerolog Level value. returns an error if the input string does not match known values.
func (l Level) MarshalText() ([]byte, error)
MarshalText implements encoding.TextMarshaler to allow for easy writing into toml/yaml/json formats
func (l Level) String() string
func (l *Level) UnmarshalText(text []byte) error
UnmarshalText implements encoding.TextUnmarshaler to allow for easy reading from toml/yaml/json formats
LevelHook applies a different hook for each level.
type LevelHook struct {
NoLevelHook, TraceHook, DebugHook, InfoHook, WarnHook, ErrorHook, FatalHook, PanicHook Hook
}
func NewLevelHook() LevelHook
NewLevelHook returns a new LevelHook.
func (h LevelHook) Run(e *Event, level Level, message string)
Run implements the Hook interface.
LevelSampler applies a different sampler for each level.
type LevelSampler struct {
TraceSampler, DebugSampler, InfoSampler, WarnSampler, ErrorSampler Sampler
}
func (s LevelSampler) Sample(lvl Level) bool
LevelWriter defines as interface a writer may implement in order to receive level information with payload.
type LevelWriter interface {
io.Writer
WriteLevel(level Level, p []byte) (n int, err error)
}
func MultiLevelWriter(writers ...io.Writer) LevelWriter
MultiLevelWriter creates a writer that duplicates its writes to all the provided writers, similar to the Unix tee(1) command. If some writers implement LevelWriter, their WriteLevel method will be used instead of Write.
func SyslogCEEWriter(w SyslogWriter) LevelWriter
SyslogCEEWriter wraps a SyslogWriter with a SyslogLevelWriter that adds a MITRE CEE prefix for JSON syslog entries, compatible with rsyslog and syslog-ng JSON logging support. See https://www.rsyslog.com/json-elasticsearch/
func SyslogLevelWriter(w SyslogWriter) LevelWriter
SyslogLevelWriter wraps a SyslogWriter and call the right syslog level method matching the zerolog level.
LogArrayMarshaler provides a strongly-typed and encoding-agnostic interface to be implemented by types used with Event/Context's Array methods.
type LogArrayMarshaler interface {
MarshalZerologArray(a *Array)
}
LogObjectMarshaler provides a strongly-typed and encoding-agnostic interface to be implemented by types used with Event/Context's Object methods.
type LogObjectMarshaler interface {
MarshalZerologObject(e *Event)
}
A Logger represents an active logging object that generates lines of JSON output to an io.Writer. Each logging operation makes a single call to the Writer's Write method. There is no guarantee on access serialization to the Writer. If your Writer is not thread safe, you may consider a sync wrapper.
type Logger struct {
// contains filtered or unexported fields
}
func Ctx(ctx context.Context) *Logger
Ctx returns the Logger associated with the ctx. If no logger is associated, DefaultContextLogger is returned, unless DefaultContextLogger is nil, in which case a disabled logger is returned.
func New(w io.Writer) Logger
New creates a root logger with given output writer. If the output writer implements the LevelWriter interface, the WriteLevel method will be called instead of the Write one.
Each logging operation makes a single call to the Writer's Write method. There is no guarantee on access serialization to the Writer. If your Writer is not thread safe, you may consider using sync wrapper.
▹ Example
func Nop() Logger
Nop returns a disabled logger for which all operation are no-op.
func (l *Logger) Debug() *Event
Debug starts a new message with debug level.
You must call Msg on the returned event in order to send the event.
▹ Example
func (l *Logger) Err(err error) *Event
Err starts a new message with error level with err as a field if not nil or with info level if err is nil.
You must call Msg on the returned event in order to send the event.
func (l *Logger) Error() *Event
Error starts a new message with error level.
You must call Msg on the returned event in order to send the event.
▹ Example
func (l *Logger) Fatal() *Event
Fatal starts a new message with fatal level. The os.Exit(1) function is called by the Msg method, which terminates the program immediately.
You must call Msg on the returned event in order to send the event.
func (l Logger) GetLevel() Level
GetLevel returns the current Level of l.
func (l Logger) Hook(h Hook) Logger
Hook returns a logger with the h Hook.
▹ Example
func (l *Logger) Info() *Event
Info starts a new message with info level.
You must call Msg on the returned event in order to send the event.
▹ Example
func (l Logger) Level(lvl Level) Logger
Level creates a child logger with the minimum accepted level set to level.
▹ Example
func (l *Logger) Log() *Event
Log starts a new message with no level. Setting GlobalLevel to Disabled will still disable events produced by this method.
You must call Msg on the returned event in order to send the event.
▹ Example
func (l Logger) Output(w io.Writer) Logger
Output duplicates the current logger and sets w as its output.
func (l *Logger) Panic() *Event
Panic starts a new message with panic level. The panic() function is called by the Msg method, which stops the ordinary flow of a goroutine.
You must call Msg on the returned event in order to send the event.
func (l *Logger) Print(v ...interface{})
Print sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Print.
▹ Example
func (l *Logger) Printf(format string, v ...interface{})
Printf sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Printf.
▹ Example
func (l Logger) Sample(s Sampler) Logger
Sample returns a logger with the s sampler.
▹ Example
func (l *Logger) Trace() *Event
Trace starts a new message with trace level.
You must call Msg on the returned event in order to send the event.
▹ Example
func (l *Logger) UpdateContext(update func(c Context) Context)
UpdateContext updates the internal logger's context.
Use this method with caution. If unsure, prefer the With method.
func (l *Logger) Warn() *Event
Warn starts a new message with warn level.
You must call Msg on the returned event in order to send the event.
▹ Example
func (l Logger) With() Context
With creates a child logger with the field added to its context.
▹ Example
func (l Logger) WithContext(ctx context.Context) context.Context
WithContext returns a copy of ctx with l associated. If an instance of Logger is already in the context, the context is not updated.
For instance, to add a field to an existing logger in the context, use this notation:
ctx := r.Context()
l := zerolog.Ctx(ctx)
l.UpdateContext(func(c Context) Context {
return c.Str("bar", "baz")
})
func (l *Logger) WithLevel(level Level) *Event
WithLevel starts a new message with level. Unlike Fatal and Panic methods, WithLevel does not terminate the program or stop the ordinary flow of a goroutine when used with their respective levels.
You must call Msg on the returned event in order to send the event.
▹ Example
func (l Logger) Write(p []byte) (n int, err error)
Write implements the io.Writer interface. This is useful to set as a writer for the standard library log.
▹ Example
RandomSampler use a PRNG to randomly sample an event out of N events, regardless of their level.
type RandomSampler uint32
func (s RandomSampler) Sample(lvl Level) bool
Sample implements the Sampler interface.
Sampler defines an interface to a log sampler.
type Sampler interface {
// Sample returns true if the event should be part of the sample, false if
// the event should be dropped.
Sample(lvl Level) bool
}
SyslogWriter is an interface matching a syslog.Writer struct.
type SyslogWriter interface {
io.Writer
Debug(m string) error
Info(m string) error
Warning(m string) error
Err(m string) error
Emerg(m string) error
Crit(m string) error
}
TestWriter is a writer that writes to testing.TB.
type TestWriter struct {
T TestingLog
// Frame skips caller frames to capture the original file and line numbers.
Frame int
}
func NewTestWriter(t TestingLog) TestWriter
NewTestWriter creates a writer that logs to the testing.TB.
func (t TestWriter) Write(p []byte) (n int, err error)
Write to testing.TB.
TestingLog is the logging interface of testing.TB.
type TestingLog interface {
Log(args ...interface{})
Logf(format string, args ...interface{})
Helper()
}