Documentation ¶
Overview ¶
Package zerolog provides a lightweight logging library dedicated to JSON logging.
A global Logger can be use for simple logging:
import "github.com/didi/gatekeeper/golang_common/zerolog/log" log.Info().Msg("hello world") // Output: {"time":1494567715,"level":"info","message":"hello world"}
NOTE: To import the global logger, import the "log" subpackage "github.com/didi/gatekeeper/golang_common/zerolog/log".
Fields can be added to log messages:
log.Info().Str("foo", "bar").Msg("hello world") // Output: {"time":1494567715,"level":"info","message":"hello world","foo":"bar"}
Create logger instance to manage different outputs:
logger := zerolog.New(os.Stderr).With().Timestamp().Logger() logger.Info(). Str("foo", "bar"). Msg("hello world") // Output: {"time":1494567715,"level":"info","message":"hello world","foo":"bar"}
Sub-loggers let you chain loggers with additional context:
sublogger := log.With().Str("component": "foo").Logger() sublogger.Info().Msg("hello world") // Output: {"time":1494567715,"level":"info","message":"hello world","component":"foo"}
Level logging
zerolog.SetGlobalLevel(zerolog.InfoLevel) log.Debug().Msg("filtered out message") log.Info().Msg("routed message") if e := log.Debug(); e.Enabled() { // Compute log output only if enabled. value := compute() e.Str("foo": value).Msg("some debug message") } // Output: {"level":"info","time":1494567715,"routed message"}
Customize automatic field names:
log.TimestampFieldName = "t" log.LevelFieldName = "p" log.MessageFieldName = "m" log.Info().Msg("hello world") // Output: {"t":1494567715,"p":"info","m":"hello world"}
Log with no level and message:
log.Log().Str("foo","bar").Msg("") // Output: {"time":1494567715,"foo":"bar"}
Add contextual fields to global Logger:
log.Logger = log.With().Str("foo", "bar").Logger()
Sample logs:
sampled := log.Sample(&zerolog.BasicSampler{N: 10}) sampled.Info().Msg("will be logged every 10 messages")
Log with contextual hooks:
// Create the hook: type SeverityHook struct{} func (h SeverityHook) Run(e *zerolog.Event, level zerolog.Level, msg string) { if level != zerolog.NoLevel { e.Str("severity", level.String()) } } // And use it: var h SeverityHook log := zerolog.New(os.Stdout).Hook(h) log.Warn().Msg("") // Output: {"level":"warn","severity":"warn"}
Caveats ¶
There is no fields deduplication out-of-the-box. Using the same key multiple times creates new key in final JSON each time.
logger := zerolog.New(os.Stderr).With().Timestamp().Logger() logger.Info(). Timestamp(). Msg("dup") // Output: {"level":"info","time":1494567715,"time":1494567715,"message":"dup"}
However, it’s not a big deal though as JSON accepts dup keys, the last one prevails.
Index ¶
- Variables
- func DisableSampling(v bool)
- func SetGlobalLevel(l Level)
- func SyncWriter(w io.Writer) io.Writer
- type AccessWriter
- func (w *AccessWriter) FormatCaller(i string) string
- func (w *AccessWriter) FormatLevel(i string) string
- func (w *AccessWriter) FormatMessage(i string) string
- func (w *AccessWriter) FormatTimestamp() string
- func (w *AccessWriter) Write(p []byte) (n int, err error)
- func (w *AccessWriter) WriteLevel(l Level, p []byte) (n int, err error)
- type Array
- func (a *Array) Bool(b bool) *Array
- func (a *Array) Bytes(val []byte) *Array
- func (a *Array) Dur(d time.Duration) *Array
- func (a *Array) Err(err error) *Array
- func (a *Array) Float32(f float32) *Array
- func (a *Array) Float64(f float64) *Array
- func (a *Array) Hex(val []byte) *Array
- func (a *Array) IPAddr(ip net.IP) *Array
- func (a *Array) IPPrefix(pfx net.IPNet) *Array
- func (a *Array) Int(i int) *Array
- func (a *Array) Int16(i int16) *Array
- func (a *Array) Int32(i int32) *Array
- func (a *Array) Int64(i int64) *Array
- func (a *Array) Int8(i int8) *Array
- func (a *Array) Interface(i interface{}) *Array
- func (a *Array) MACAddr(ha net.HardwareAddr) *Array
- func (*Array) MarshalZerologArray(*Array)
- func (a *Array) Str(val string) *Array
- func (a *Array) Time(t time.Time) *Array
- func (a *Array) Uint(i uint) *Array
- func (a *Array) Uint16(i uint16) *Array
- func (a *Array) Uint32(i uint32) *Array
- func (a *Array) Uint64(i uint64) *Array
- func (a *Array) Uint8(i uint8) *Array
- type BasicSampler
- type BurstSampler
- type ConsoleWriter
- type Context
- func (c Context) AnErr(key string, err error) Context
- func (c Context) Bool(key string, b bool) Context
- func (c Context) Bools(key string, b []bool) Context
- func (c Context) Bytes(key string, val []byte) Context
- func (c Context) Caller() Context
- func (c Context) Dur(key string, d time.Duration) Context
- func (c Context) Durs(key string, d []time.Duration) Context
- func (c Context) Err(err error) Context
- func (c Context) Fields(fields map[string]interface{}) Context
- func (c Context) Float32(key string, f float32) Context
- func (c Context) Float64(key string, f float64) Context
- func (c Context) Floats32(key string, f []float32) Context
- func (c Context) Floats64(key string, f []float64) Context
- func (c Context) Hex(key string, val []byte) Context
- func (c Context) IPAddr(key string, ip net.IP) Context
- func (c Context) IPPrefix(key string, pfx net.IPNet) Context
- func (c Context) Int(key string, i int) Context
- func (c Context) Int16(key string, i int16) Context
- func (c Context) Int32(key string, i int32) Context
- func (c Context) Int64(key string, i int64) Context
- func (c Context) Int8(key string, i int8) Context
- func (c Context) Interface(key string, i interface{}) Context
- func (c Context) Ints(key string, i []int) Context
- func (c Context) Ints16(key string, i []int16) Context
- func (c Context) Ints32(key string, i []int32) Context
- func (c Context) Ints64(key string, i []int64) Context
- func (c Context) Ints8(key string, i []int8) Context
- func (c Context) Logger() Logger
- func (c Context) MACAddr(key string, ha net.HardwareAddr) Context
- func (c Context) RawJSON(key string, b []byte) Context
- func (c Context) Str(key, val string) Context
- func (c Context) Strs(key string, vals []string) Context
- func (c Context) Time(key string, t time.Time) Context
- func (c Context) Times(key string, t []time.Time) Context
- func (c Context) Timestamp() Context
- func (c Context) Uint(key string, i uint) Context
- func (c Context) Uint16(key string, i uint16) Context
- func (c Context) Uint32(key string, i uint32) Context
- func (c Context) Uint64(key string, i uint64) Context
- func (c Context) Uint8(key string, i uint8) Context
- func (c Context) Uints(key string, i []uint) Context
- func (c Context) Uints16(key string, i []uint16) Context
- func (c Context) Uints32(key string, i []uint32) Context
- func (c Context) Uints64(key string, i []uint64) Context
- func (c Context) Uints8(key string, i []uint8) Context
- type Event
- func (e *Event) AnErr(key string, err error) *Event
- func (e *Event) Bool(key string, b bool) *Event
- func (e *Event) Bools(key string, b []bool) *Event
- func (e *Event) Bytes(key string, val []byte) *Event
- func (e *Event) Caller() *Event
- func (e *Event) CallerDefault(caller string) *Event
- func (e *Event) Discard() *Event
- func (e *Event) Dur(key string, d time.Duration) *Event
- func (e *Event) Durs(key string, d []time.Duration) *Event
- func (e *Event) Enabled() bool
- func (e *Event) Err(err error) *Event
- func (e *Event) Fields(fields map[string]interface{}) *Event
- func (e *Event) Float32(key string, f float32) *Event
- func (e *Event) Float64(key string, f float64) *Event
- func (e *Event) Floats32(key string, f []float32) *Event
- func (e *Event) Floats64(key string, f []float64) *Event
- func (e *Event) Hex(key string, val []byte) *Event
- func (e *Event) IPAddr(key string, ip net.IP) *Event
- func (e *Event) IPPrefix(key string, pfx net.IPNet) *Event
- func (e *Event) Int(key string, i int) *Event
- func (e *Event) Int16(key string, i int16) *Event
- func (e *Event) Int32(key string, i int32) *Event
- func (e *Event) Int64(key string, i int64) *Event
- func (e *Event) Int8(key string, i int8) *Event
- func (e *Event) Interface(key string, i interface{}) *Event
- func (e *Event) Ints(key string, i []int) *Event
- func (e *Event) Ints16(key string, i []int16) *Event
- func (e *Event) Ints32(key string, i []int32) *Event
- func (e *Event) Ints64(key string, i []int64) *Event
- func (e *Event) Ints8(key string, i []int8) *Event
- func (e *Event) MACAddr(key string, ha net.HardwareAddr) *Event
- func (e *Event) Msg(msg string)
- func (e *Event) Msgf(format string, v ...interface{})
- func (e *Event) RawJSON(key string, b []byte) *Event
- func (e *Event) Str(key, val string) *Event
- func (e *Event) Strs(key string, vals []string) *Event
- func (e *Event) Tag(key string) *Event
- func (e *Event) Time(key string, t time.Time) *Event
- func (e *Event) TimeDiff(key string, t time.Time, start time.Time) *Event
- func (e *Event) Times(key string, t []time.Time) *Event
- func (e *Event) Timestamp() *Event
- func (e *Event) Uint(key string, i uint) *Event
- func (e *Event) Uint16(key string, i uint16) *Event
- func (e *Event) Uint32(key string, i uint32) *Event
- func (e *Event) Uint64(key string, i uint64) *Event
- func (e *Event) Uint8(key string, i uint8) *Event
- func (e *Event) Uints(key string, i []uint) *Event
- func (e *Event) Uints16(key string, i []uint16) *Event
- func (e *Event) Uints32(key string, i []uint32) *Event
- func (e *Event) Uints64(key string, i []uint64) *Event
- func (e *Event) Uints8(key string, i []uint8) *Event
- type FileWriter
- type FormatWriter
- type Formatter
- type Hook
- type HookFunc
- type Level
- type LevelHook
- type LevelSampler
- type LevelWriter
- type Logger
- func (l *Logger) Debug() *Event
- func (l *Logger) Error() *Event
- func (l *Logger) Fatal() *Event
- func (l *Logger) GetLevel() Level
- func (l Logger) Hook(h Hook) Logger
- func (l *Logger) Info() *Event
- func (l Logger) Level(lvl Level) Logger
- func (l *Logger) Log() *Event
- func (l Logger) Output(w io.Writer) Logger
- func (l *Logger) Panic() *Event
- func (l *Logger) Print(v ...interface{})
- func (l *Logger) Printf(format string, v ...interface{})
- func (l Logger) Sample(s Sampler) Logger
- func (l *Logger) UpdateContext(update func(c Context) Context)
- func (l *Logger) Warn() *Event
- func (l Logger) With() Context
- func (l *Logger) WithContext(ctx context.Context) context.Context
- func (l *Logger) WithLevel(level Level) *Event
- func (l Logger) Write(p []byte) (n int, err error)
- type Option
- type RandomSampler
- type Sampler
- type StdoutWriter
- type SyslogWriter
- type WFFileWriter
Examples ¶
- Context.Dur
- Context.Dur
- Context.Durs
- Context.Durs
- Context.IPAddr
- Context.IPPrefix
- Context.Interface
- Context.Interface
- Event.Dur
- Event.Dur
- Event.Durs
- Event.Durs
- Event.Interface
- Event.Interface
- Logger.Debug
- Logger.Debug
- Logger.Error
- Logger.Error
- Logger.Hook
- Logger.Hook
- Logger.Info
- Logger.Info
- Logger.Level
- Logger.Level
- Logger.Log
- Logger.Log
- Logger.Print
- Logger.Print
- Logger.Printf
- Logger.Printf
- Logger.Sample
- Logger.Sample
- Logger.Warn
- Logger.Warn
- Logger.WithLevel
- Logger.WithLevel
- Logger.Write
- Logger.Write
- New
Constants ¶
This section is empty.
Variables ¶
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" // 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 = 3 // TimeFieldFormat defines the time format of the Time field type. // If set to an empty string, the time is formatted as an 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) )
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) )
var ErrorMarshalFunc = func(err error) interface{} {
return err
}
ErrorMarshalFunc allows customization of global error marshaling
Functions ¶
func DisableSampling ¶
func DisableSampling(v bool)
DisableSampling will disable sampling in all Loggers if true.
func SetGlobalLevel ¶
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 ¶
SyncWriter wraps w so that each call to Write is synchronized with a mutex. This syncer can be the call to writer's Write method is not thread safe. Note that os.File Write operation is using write() syscall which is supposed to be thread-safe on POSIX systems. So there is no need to use this with os.File on such systems as zerolog guaranties to issue a single Write call per log event.
Types ¶
type AccessWriter ¶
type AccessWriter struct { //normal file FileOut *os.File //auto clear the log AutoClear bool //file directory FileDir string //file prefix name FilePrefix string //clear hours ClearHours int32 //clear steps ClearStep int32 //is Disable link DisableLink bool //caller format func FormatCallerFunc func(i string) string // time format func FormatTimestampFunc func() string // msg format func FormatMessageFunc func(i string) string // level format func FormatLevelFunc func(i string) string // contains filtered or unexported fields }
func NewAccessWriter ¶
func NewAccessWriter(options ...Option) *AccessWriter
NewFileWriter creates and initializes a new AccessWriter.
func (*AccessWriter) FormatCaller ¶
func (w *AccessWriter) FormatCaller(i string) string
func (*AccessWriter) FormatLevel ¶
func (w *AccessWriter) FormatLevel(i string) string
func (*AccessWriter) FormatMessage ¶
func (w *AccessWriter) FormatMessage(i string) string
func (*AccessWriter) FormatTimestamp ¶
func (w *AccessWriter) FormatTimestamp() string
func (*AccessWriter) WriteLevel ¶
func (w *AccessWriter) WriteLevel(l Level, p []byte) (n int, err error)
type Array ¶
type Array struct {
// contains filtered or unexported fields
}
Array is used to prepopulate an array of items which can be re-used to add to log messages.
func (*Array) MACAddr ¶
func (a *Array) MACAddr(ha net.HardwareAddr) *Array
MACAddr adds a MAC (Ethernet) address to the array
func (*Array) MarshalZerologArray ¶
MarshalZerologArray method here is no-op - since data is already in the needed format.
type BasicSampler ¶
type BasicSampler struct { N uint32 // contains filtered or unexported fields }
BasicSampler is a sampler that will send every Nth events, regardless of there level.
func (*BasicSampler) Sample ¶
func (s *BasicSampler) Sample(lvl Level) bool
Sample implements the Sampler interface.
type BurstSampler ¶
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 }
BurstSampler lets Burst events pass per Period then pass the decision to NextSampler. If Sampler is not set, all subsequent events are rejected.
func (*BurstSampler) Sample ¶
func (s *BurstSampler) Sample(lvl Level) bool
Sample implements the Sampler interface.
type ConsoleWriter ¶
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 FormatTimestamp Formatter FormatLevel Formatter FormatCaller Formatter FormatMessage Formatter FormatFieldName Formatter FormatFieldValue Formatter FormatErrFieldName Formatter FormatErrFieldValue Formatter }
ConsoleWriter parses the JSON input and writes it in an (optionally) colorized, human-friendly format to Out.
func NewConsoleWriter ¶
func NewConsoleWriter(options ...func(w *ConsoleWriter)) ConsoleWriter
NewConsoleWriter creates and initializes a new ConsoleWriter.
type Context ¶
type Context struct {
// contains filtered or unexported fields
}
Context configures a new sub-logger with contextual fields.
func (Context) Caller ¶
Caller adds the file:line of the caller with the zerolog.CallerFieldName key.
func (Context) Dur ¶
Dur adds the fields key with d divided by unit and stored as a float.
Example ¶
package main import ( "os" "time" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { d := time.Duration(10 * time.Second) log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Dur("dur", d). Logger() log.Log().Msg("hello world") }
Output: foo=bar||dur=10000||hello world
Example ¶
d := time.Duration(10 * time.Second) dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Dur("dur", d). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: foo=bar||dur=10000||hello world
func (Context) Durs ¶
Durs adds the fields key with d divided by unit and stored as a float.
Example ¶
d := []time.Duration{ time.Duration(10 * time.Second), time.Duration(20 * time.Second), } dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Durs("durs", d). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: foo=bar||durs=[10000,20000]||hello world
Example ¶
package main import ( "os" "time" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { d := []time.Duration{ time.Duration(10 * time.Second), time.Duration(20 * time.Second), } log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Durs("durs", d). Logger() log.Log().Msg("hello world") }
Output: foo=bar||durs=[10000,20000]||hello world
func (Context) Fields ¶
Fields is a helper function to use a map to set fields using type assertion.
func (Context) IPAddr ¶
IPAddr adds IPv4 or IPv6 Address to the context
Example ¶
package main import ( "net" "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { hostIP := net.IP{192, 168, 0, 100} log := zerolog.New(os.Stdout).With(). IPAddr("HostIP", hostIP). Logger() log.Log().Msg("hello world") }
Output: HostIP=192.168.0.100||hello world
func (Context) IPPrefix ¶
IPPrefix adds IPv4 or IPv6 Prefix (address and mask) to the context
Example ¶
package main import ( "net" "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { route := net.IPNet{IP: net.IP{192, 168, 0, 0}, Mask: net.CIDRMask(24, 32)} log := zerolog.New(os.Stdout).With(). IPPrefix("Route", route). Logger() log.Log().Msg("hello world") }
Output: Route=192.168.0.0/24||hello world
func (Context) Interface ¶
Interface adds the field key with obj marshaled using reflection.
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { obj := struct { Name string `json:"name"` }{ Name: "john", } log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Interface("obj", obj). Logger() log.Log().Msg("hello world") }
Output: foo=bar||obj={"name":"john"}||hello world
Example ¶
obj := struct { Name string `json:"name"` }{ Name: "john", } dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Interface("obj", obj). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: foo=bar||obj={"name":"john"}||hello world
func (Context) MACAddr ¶
func (c Context) MACAddr(key string, ha net.HardwareAddr) Context
MACAddr adds MAC address to the context
func (Context) RawJSON ¶
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 (Context) Time ¶
Time adds the field key with t formated as string using zerolog.TimeFieldFormat.
func (Context) Times ¶
Times adds the field key with t formated as string using zerolog.TimeFieldFormat.
func (Context) Timestamp ¶
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.
type Event ¶
type Event struct {
// contains filtered or unexported fields
}
Event represents a log event. It is instanced by one of the level method of Logger and finalized by the Msg or Msgf method.
func (*Event) AnErr ¶
AnErr adds the field key with serialized err to the *Event context. If err is nil, no field is added.
func (*Event) Bytes ¶
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 (*Event) Caller ¶
Caller adds the file:line of the caller with the zerolog.CallerFieldName key.
func (*Event) CallerDefault ¶
todo default caller
func (*Event) Dur ¶
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 ¶
package main import ( "os" "time" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { d := time.Duration(10 * time.Second) log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Dur("dur", d). Msg("hello world") }
Output: foo=bar||dur=10000||hello world
Example ¶
d := time.Duration(10 * time.Second) dst := bytes.Buffer{} log := New(&dst) log.Log().Tag(" undefined"). Str("foo", "bar"). Dur("dur", d). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: undefined||foo=bar||dur=10000||hello world
func (*Event) Durs ¶
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 ¶
d := []time.Duration{ time.Duration(10 * time.Second), time.Duration(20 * time.Second), } dst := bytes.Buffer{} log := New(&dst) log.Log().Tag(" undefined"). Str("foo", "bar"). Durs("durs", d). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: undefined||foo=bar||durs=[10000,20000]||hello world
Example ¶
package main import ( "os" "time" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { d := []time.Duration{ time.Duration(10 * time.Second), time.Duration(20 * time.Second), } log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Durs("durs", d). Msg("hello world") }
Output: foo=bar||durs=[10000,20000]||hello world
func (*Event) Enabled ¶
Enabled return false if the *Event is going to be filtered out by log level or sampling.
func (*Event) Err ¶
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.
func (*Event) Interface ¶
Interface adds the field key with i marshaled using reflection.
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) obj := struct { Name string `json:"name"` }{ Name: "john", } log.Log(). Str("foo", "bar"). Interface("obj", obj). Msg("hello world") }
Output: foo=bar||obj={"name":"john"}||hello world
Example ¶
dst := bytes.Buffer{} log := New(&dst) obj := struct { Name string `json:"name"` }{ Name: "john", } log.Log().Tag(" undefined"). Str("foo", "bar"). Interface("obj", obj). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: undefined||foo=bar||obj={"name":"john"}||hello world
func (*Event) MACAddr ¶
func (e *Event) MACAddr(key string, ha net.HardwareAddr) *Event
MACAddr adds MAC address to the event
func (*Event) Msg ¶
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 (*Event) Msgf ¶
Msgf sends the event with formated msg added as the message field if not empty.
NOTICE: once this methid is called, the *Event should be disposed. Calling Msg twice can have unexpected result.
func (*Event) RawJSON ¶
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 (*Event) Time ¶
Time adds the field key with t formated as string using zerolog.TimeFieldFormat.
func (*Event) TimeDiff ¶
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 (*Event) Times ¶
Times adds the field key with t formated as string using zerolog.TimeFieldFormat.
func (*Event) Timestamp ¶
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.
type FileWriter ¶
type FileWriter struct {
AccessWriter
}
func NewFileWriter ¶
func NewFileWriter(options ...Option) *FileWriter
NewFileWriter creates and initializes a new AccessWriter.
func (*FileWriter) WriteLevel ¶
func (w *FileWriter) WriteLevel(l Level, p []byte) (n int, err error)
final write
type FormatWriter ¶
type FormatWriter interface { FormatCaller(string) string FormatTimestamp() string FormatMessage(string) string FormatLevel(string) string }
FormatWriter define format method
type Formatter ¶
type Formatter func(interface{}) string
Formatter transforms the input into a formatted string.
type Hook ¶
type Hook interface { // Run runs the hook with the event. Run(e *Event, level Level, message string) }
Hook defines an interface to a log hook.
type Level ¶
type Level uint8
Level defines log levels.
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 )
func ParseLevel ¶
ParseLevel converts a level string into a zerolog Level value. returns an error if the input string does not match known values.
type LevelHook ¶
type LevelHook struct {
NoLevelHook, DebugHook, InfoHook, WarnHook, ErrorHook, FatalHook, PanicHook Hook
}
LevelHook applies a different hook for each level.
type LevelSampler ¶
type LevelSampler struct {
DebugSampler, InfoSampler, WarnSampler, ErrorSampler Sampler
}
LevelSampler applies a different sampler for each level.
func (LevelSampler) Sample ¶
func (s LevelSampler) Sample(lvl Level) bool
type LevelWriter ¶
type LevelWriter interface { FormatWriter io.Writer WriteLevel(level Level, p []byte) (n int, err error) }
LevelWriter defines as interface a writer may implement in order to receive level information with payload.
func MultiLevelWriter ¶
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 SyslogLevelWriter ¶
func SyslogLevelWriter(w SyslogWriter) LevelWriter
SyslogLevelWriter wraps a SyslogWriter and call the right syslog level method matching the zerolog level.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
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 guaranty on access serialization to the Writer. If your Writer is not thread safe, you may consider a sync wrapper.
func Ctx ¶
Ctx returns the Logger associated with the ctx. If no logger is associated, a disabled logger is returned.
func New ¶
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 guaranty on access serialization to the Writer. If your Writer is not thread safe, you may consider using sync wrapper.
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Info().Msg("hello world") }
Output: [INFO]||hello world
func (*Logger) Debug ¶
Debug starts a new message with debug level.
You must call Msg on the returned event in order to send the event.
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Debug(). Str("foo", "bar"). Int("n", 123). Msg("hello world") }
Output: [DEBUG]||foo=bar||n=123||hello world
Example ¶
dst := bytes.Buffer{} log := New(&dst) log.Debug().Tag(" undefined"). Str("foo", "bar"). Int("n", 123). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [DEBUG] undefined||foo=bar||n=123||hello world
func (*Logger) Error ¶
Error starts a new message with error level.
You must call Msg on the returned event in order to send the event.
Example ¶
package main import ( "errors" "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Error(). Err(errors.New("some error")). Msg("error doing something") }
Output: [ERROR]||error=some error||error doing something
Example ¶
dst := bytes.Buffer{} log := New(&dst) log.Error().Tag(" undefined"). Err(errors.New("some error")). Msg("error doing something") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [ERROR] undefined||error=some error||error doing something
func (*Logger) Fatal ¶
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 (Logger) Hook ¶
Hook returns a logger with the h Hook.
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) type LevelNameHook struct{} func (h LevelNameHook) Run(e *zerolog.Event, l zerolog.Level, msg string) { if l != zerolog.NoLevel { e.Str("level_name", l.String()) } else { e.Str("level_name", "NoLevel") } } type MessageHook string func (h MessageHook) Run(e *zerolog.Event, l zerolog.Level, msg string) { e.Str("the_message", msg) } func main() { var levelNameHook LevelNameHook var messageHook MessageHook = "The message" log := zerolog.New(os.Stdout).Hook(levelNameHook).Hook(messageHook) log.Info().Msg("hello world") }
Output: [INFO]||level_name=info||the_message=hello world||hello world
Example ¶
var levelNameHook LevelNameHook1 var messageHook MessageHook = "The message" dst := bytes.Buffer{} log := New(&dst).Hook(levelNameHook).Hook(messageHook) log.Info().Tag(" undefined").Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [INFO] undefined||level_name=info||the_message=hello world||hello world
func (*Logger) Info ¶
Info starts a new message with info level.
You must call Msg on the returned event in order to send the event.
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Info(). Str("foo", "bar"). Int("n", 123). Msg("hello world") }
Output: [INFO]||foo=bar||n=123||hello world
Example ¶
dst := bytes.Buffer{} log := New(&dst) log.Info().Tag(" undefined"). Str("foo", "bar"). Int("n", 123). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [INFO] undefined||foo=bar||n=123||hello world
func (Logger) Level ¶
Level creates a child logger with the minimum accepted level set to level.
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout).Level(zerolog.WarnLevel) log.Info().Msg("filtered out message") log.Error().Msg("kept message") }
Output: [ERROR]||kept message
Example ¶
dst := bytes.Buffer{} log := New(&dst).Level(WarnLevel) log.Info().Tag(" undefined").Msg("filtered out message") log.Error().Tag(" undefined").Msg("kept message") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [ERROR] undefined||kept message
func (*Logger) Log ¶
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 ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Str("bar", "baz"). Msg("") }
Output: foo=bar||bar=baz
Example ¶
dst := bytes.Buffer{} log := New(&dst) log.Log().Tag(" undefined"). Str("foo", "bar"). Str("bar", "baz"). Msg("") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: undefined||foo=bar||bar=baz
func (*Logger) Panic ¶
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 (*Logger) Print ¶
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 ¶
dst := bytes.Buffer{} log := New(&dst) log.Print("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [DEBUG]||hello world
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Print("hello world") }
Output: [DEBUG]||hello world
func (*Logger) Printf ¶
Printf sends a log event using debug level and no extra field. Arguments are handled in the manner of fmt.Printf.
Example ¶
dst := bytes.Buffer{} log := New(&dst) log.Printf("hello %s", "world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [DEBUG]||hello world
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Printf("hello %s", "world") }
Output: [DEBUG]||hello world
func (Logger) Sample ¶
Sample returns a logger with the s sampler.
Example ¶
dst := bytes.Buffer{} log := New(&dst).Sample(&BasicSampler{N: 2}) log.Info().Msg("message 1") log.Info().Msg("message 2") log.Info().Msg("message 3") log.Info().Msg("message 4") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [INFO]||message 1 [INFO]||message 3
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout).Sample(&zerolog.BasicSampler{N: 2}) log.Info().Msg("message 1") log.Info().Msg("message 2") log.Info().Msg("message 3") log.Info().Msg("message 4") }
Output: [INFO]||message 1 [INFO]||message 3
func (*Logger) UpdateContext ¶
UpdateContext updates the internal logger's context.
Use this method with caution. If unsure, prefer the With method.
func (*Logger) Warn ¶
Warn starts a new message with warn level.
You must call Msg on the returned event in order to send the event.
Example ¶
dst := bytes.Buffer{} log := New(&dst) log.Warn().Tag(" undefined"). Str("foo", "bar"). Msg("a warning message") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // [WARNING] undefined||foo=bar||a warning message
Output:
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.Warn(). Str("foo", "bar"). Msg("a warning message") }
Output: [WARNING]||foo=bar||a warning message
func (*Logger) WithContext ¶
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 (*Logger) WithLevel ¶
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 gourotine when used with their respective levels.
You must call Msg on the returned event in order to send the event.
Example ¶
dst := bytes.Buffer{} log := New(&dst) log.WithLevel(InfoLevel).Tag(" undefined"). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: [INFO] undefined||hello world
Example ¶
package main import ( "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout) log.WithLevel(zerolog.InfoLevel). Msg("hello world") }
Output: [INFO]||hello world
func (Logger) Write ¶
Write implements the io.Writer interface. This is useful to set as a writer for the standard library log.
Example ¶
dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Logger() stdlog.SetFlags(0) stdlog.SetOutput(log) stdlog.Print("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes()))
Output: foo=bar||hello world
Example ¶
package main import ( stdlog "log" "os" "github.com/didi/gatekeeper/golang_common/zerolog" ) func main() { log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Logger() stdlog.SetFlags(0) stdlog.SetOutput(log) stdlog.Print("hello world") }
Output: foo=bar||hello world
type Option ¶
type Option func(w *AccessWriter)
func SetAutoClear ¶
func SetClearHours ¶
func SetClearSteps ¶
func SetDisableLink ¶
func SetFileDir ¶
func SetFilePrefix ¶
type RandomSampler ¶
type RandomSampler uint32
RandomSampler use a PRNG to randomly sample an event out of N events, regardless of their level.
func (RandomSampler) Sample ¶
func (s RandomSampler) Sample(lvl Level) bool
Sample implements the Sampler interface.
type 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 }
Sampler defines an interface to a log sampler.
type StdoutWriter ¶
type StdoutWriter struct {
AccessWriter
}
func NewStdoutWriter ¶
func NewStdoutWriter(options ...Option) *StdoutWriter
NewStdoutWriter will write to stdout.
func (*StdoutWriter) WriteLevel ¶
func (w *StdoutWriter) WriteLevel(l Level, p []byte) (n int, err error)
type SyslogWriter ¶
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 }
SyslogWriter is an interface matching a syslog.Writer struct.
type WFFileWriter ¶
type WFFileWriter struct {
AccessWriter
}
func NewWFFileWriter ¶
func NewWFFileWriter(options ...Option) *WFFileWriter
NewFileWriter creates and initializes a new AccessWriter.
func (*WFFileWriter) WriteLevel ¶
func (w *WFFileWriter) WriteLevel(l Level, p []byte) (n int, err error)
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
cmd
|
|
Package diode provides a thread-safe, lock-free, non-blocking io.Writer wrapper.
|
Package diode provides a thread-safe, lock-free, non-blocking io.Writer wrapper. |
Package hlog provides a set of http.Handler helpers for zerolog.
|
Package hlog provides a set of http.Handler helpers for zerolog. |
internal
|
|
cbor
Package cbor provides primitives for storing different data in the CBOR (binary) format.
|
Package cbor provides primitives for storing different data in the CBOR (binary) format. |
ordered
Package ordered provided a type OrderedMap for use in JSON handling
|
Package ordered provided a type OrderedMap for use in JSON handling |
Package log provides a global logger for zerolog.
|
Package log provides a global logger for zerolog. |