pax_global_header00006660000000000000000000000064141564760560014530gustar00rootroot0000000000000052 comment=791ca15d999a97768ffd3b040116f9f5a772661a zerolog-1.26.1/000077500000000000000000000000001415647605600133005ustar00rootroot00000000000000zerolog-1.26.1/.github/000077500000000000000000000000001415647605600146405ustar00rootroot00000000000000zerolog-1.26.1/.github/dependabot.yml000066400000000000000000000003031415647605600174640ustar00rootroot00000000000000version: 2 updates: - package-ecosystem: github-actions directory: / schedule: interval: weekly - package-ecosystem: gomod directory: / schedule: interval: weekly zerolog-1.26.1/.github/workflows/000077500000000000000000000000001415647605600166755ustar00rootroot00000000000000zerolog-1.26.1/.github/workflows/test.yml000066400000000000000000000012561415647605600204030ustar00rootroot00000000000000on: [push, pull_request] name: Test jobs: test: strategy: matrix: go-version: [1.15.x, 1.16.x] os: [ubuntu-latest, macos-latest] runs-on: ${{ matrix.os }} steps: - name: Install Go uses: actions/setup-go@v2 with: go-version: ${{ matrix.go-version }} - name: Checkout code uses: actions/checkout@v2 - uses: actions/cache@v2 with: path: ~/go/pkg/mod key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} restore-keys: | ${{ runner.os }}-go- - name: Test run: go test -race -bench . -benchmem ./... - name: Test CBOR run: go test -tags binary_log ./... zerolog-1.26.1/.gitignore000066400000000000000000000004161415647605600152710ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test tmp # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof zerolog-1.26.1/CNAME000066400000000000000000000000121415647605600140370ustar00rootroot00000000000000zerolog.iozerolog-1.26.1/LICENSE000066400000000000000000000020601415647605600143030ustar00rootroot00000000000000MIT License Copyright (c) 2017 Olivier Poitrey Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. zerolog-1.26.1/README.md000066400000000000000000000534661415647605600145750ustar00rootroot00000000000000# Zero Allocation JSON Logger [![godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/rs/zerolog) [![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/rs/zerolog/master/LICENSE) [![Build Status](https://travis-ci.org/rs/zerolog.svg?branch=master)](https://travis-ci.org/rs/zerolog) [![Coverage](http://gocover.io/_badge/github.com/rs/zerolog)](http://gocover.io/github.com/rs/zerolog) The zerolog package provides a fast and simple logger dedicated to JSON output. Zerolog's API is designed to provide both a great developer experience and stunning [performance](#benchmarks). Its unique chaining API allows zerolog to write JSON (or CBOR) log events by avoiding allocations and reflection. Uber's [zap](https://godoc.org/go.uber.org/zap) library pioneered this approach. Zerolog is taking this concept to the next level with a simpler to use API and even better performance. To keep the code base and the API simple, zerolog focuses on efficient structured logging only. Pretty logging on the console is made possible using the provided (but inefficient) [`zerolog.ConsoleWriter`](#pretty-logging). ![Pretty Logging Image](pretty.png) ## Who uses zerolog Find out [who uses zerolog](https://github.com/rs/zerolog/wiki/Who-uses-zerolog) and add your company / project to the list. ## Features * [Blazing fast](#benchmarks) * [Low to zero allocation](#benchmarks) * [Leveled logging](#leveled-logging) * [Sampling](#log-sampling) * [Hooks](#hooks) * [Contextual fields](#contextual-logging) * `context.Context` integration * [Integration with `net/http`](#integration-with-nethttp) * [JSON and CBOR encoding formats](#binary-encoding) * [Pretty logging for development](#pretty-logging) * [Error Logging (with optional Stacktrace)](#error-logging) ## Installation ```bash go get -u github.com/rs/zerolog/log ``` ## Getting Started ### Simple Logging Example For simple logging, import the global logger package **github.com/rs/zerolog/log** ```go package main import ( "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { // UNIX Time is faster and smaller than most timestamps zerolog.TimeFieldFormat = zerolog.TimeFormatUnix log.Print("hello world") } // Output: {"time":1516134303,"level":"debug","message":"hello world"} ``` > Note: By default log writes to `os.Stderr` > Note: The default log level for `log.Print` is *debug* ### Contextual Logging **zerolog** allows data to be added to log messages in the form of key:value pairs. The data added to the message adds "context" about the log event that can be critical for debugging as well as myriad other purposes. An example of this is below: ```go package main import ( "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { zerolog.TimeFieldFormat = zerolog.TimeFormatUnix log.Debug(). Str("Scale", "833 cents"). Float64("Interval", 833.09). Msg("Fibonacci is everywhere") log.Debug(). Str("Name", "Tom"). Send() } // Output: {"level":"debug","Scale":"833 cents","Interval":833.09,"time":1562212768,"message":"Fibonacci is everywhere"} // Output: {"level":"debug","Name":"Tom","time":1562212768} ``` > You'll note in the above example that when adding contextual fields, the fields are strongly typed. You can find the full list of supported fields [here](#standard-types) ### Leveled Logging #### Simple Leveled Logging Example ```go package main import ( "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { zerolog.TimeFieldFormat = zerolog.TimeFormatUnix log.Info().Msg("hello world") } // Output: {"time":1516134303,"level":"info","message":"hello world"} ``` > It is very important to note that when using the **zerolog** chaining API, as shown above (`log.Info().Msg("hello world"`), the chain must have either the `Msg` or `Msgf` method call. If you forget to add either of these, the log will not occur and there is no compile time error to alert you of this. **zerolog** allows for logging at the following levels (from highest to lowest): * panic (`zerolog.PanicLevel`, 5) * fatal (`zerolog.FatalLevel`, 4) * error (`zerolog.ErrorLevel`, 3) * warn (`zerolog.WarnLevel`, 2) * info (`zerolog.InfoLevel`, 1) * debug (`zerolog.DebugLevel`, 0) * trace (`zerolog.TraceLevel`, -1) You can set the Global logging level to any of these options using the `SetGlobalLevel` function in the zerolog package, passing in one of the given constants above, e.g. `zerolog.InfoLevel` would be the "info" level. Whichever level is chosen, all logs with a level greater than or equal to that level will be written. To turn off logging entirely, pass the `zerolog.Disabled` constant. #### Setting Global Log Level This example uses command-line flags to demonstrate various outputs depending on the chosen log level. ```go package main import ( "flag" "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { zerolog.TimeFieldFormat = zerolog.TimeFormatUnix debug := flag.Bool("debug", false, "sets log level to debug") flag.Parse() // Default level for this example is info, unless debug flag is present zerolog.SetGlobalLevel(zerolog.InfoLevel) if *debug { zerolog.SetGlobalLevel(zerolog.DebugLevel) } log.Debug().Msg("This message appears only when log level set to Debug") log.Info().Msg("This message appears when log level set to Debug or Info") if e := log.Debug(); e.Enabled() { // Compute log output only if enabled. value := "bar" e.Str("foo", value).Msg("some debug message") } } ``` Info Output (no flag) ```bash $ ./logLevelExample {"time":1516387492,"level":"info","message":"This message appears when log level set to Debug or Info"} ``` Debug Output (debug flag set) ```bash $ ./logLevelExample -debug {"time":1516387573,"level":"debug","message":"This message appears only when log level set to Debug"} {"time":1516387573,"level":"info","message":"This message appears when log level set to Debug or Info"} {"time":1516387573,"level":"debug","foo":"bar","message":"some debug message"} ``` #### Logging without Level or Message You may choose to log without a specific level by using the `Log` method. You may also write without a message by setting an empty string in the `msg string` parameter of the `Msg` method. Both are demonstrated in the example below. ```go package main import ( "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { zerolog.TimeFieldFormat = zerolog.TimeFormatUnix log.Log(). Str("foo", "bar"). Msg("") } // Output: {"time":1494567715,"foo":"bar"} ``` ### Error Logging You can log errors using the `Err` method ```go package main import ( "errors" "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { zerolog.TimeFieldFormat = zerolog.TimeFormatUnix err := errors.New("seems we have an error here") log.Error().Err(err).Msg("") } // Output: {"level":"error","error":"seems we have an error here","time":1609085256} ``` > The default field name for errors is `error`, you can change this by setting `zerolog.ErrorFieldName` to meet your needs. #### Error Logging with Stacktrace Using `github.com/pkg/errors`, you can add a formatted stacktrace to your errors. ```go package main import ( "github.com/pkg/errors" "github.com/rs/zerolog/pkgerrors" "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { zerolog.TimeFieldFormat = zerolog.TimeFormatUnix zerolog.ErrorStackMarshaler = pkgerrors.MarshalStack err := outer() log.Error().Stack().Err(err).Msg("") } func inner() error { return errors.New("seems we have an error here") } func middle() error { err := inner() if err != nil { return err } return nil } func outer() error { err := middle() if err != nil { return err } return nil } // Output: {"level":"error","stack":[{"func":"inner","line":"20","source":"errors.go"},{"func":"middle","line":"24","source":"errors.go"},{"func":"outer","line":"32","source":"errors.go"},{"func":"main","line":"15","source":"errors.go"},{"func":"main","line":"204","source":"proc.go"},{"func":"goexit","line":"1374","source":"asm_amd64.s"}],"error":"seems we have an error here","time":1609086683} ``` > zerolog.ErrorStackMarshaler must be set in order for the stack to output anything. #### Logging Fatal Messages ```go package main import ( "errors" "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) func main() { err := errors.New("A repo man spends his life getting into tense situations") service := "myservice" zerolog.TimeFieldFormat = zerolog.TimeFormatUnix log.Fatal(). Err(err). Str("service", service). Msgf("Cannot start %s", service) } // Output: {"time":1516133263,"level":"fatal","error":"A repo man spends his life getting into tense situations","service":"myservice","message":"Cannot start myservice"} // exit status 1 ``` > NOTE: Using `Msgf` generates one allocation even when the logger is disabled. ### Create logger instance to manage different outputs ```go logger := zerolog.New(os.Stderr).With().Timestamp().Logger() logger.Info().Str("foo", "bar").Msg("hello world") // Output: {"level":"info","time":1494567715,"message":"hello world","foo":"bar"} ``` ### Sub-loggers let you chain loggers with additional context ```go sublogger := log.With(). Str("component", "foo"). Logger() sublogger.Info().Msg("hello world") // Output: {"level":"info","time":1494567715,"message":"hello world","component":"foo"} ``` ### Pretty logging To log a human-friendly, colorized output, use `zerolog.ConsoleWriter`: ```go log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr}) log.Info().Str("foo", "bar").Msg("Hello world") // Output: 3:04PM INF Hello World foo=bar ``` To customize the configuration and formatting: ```go output := zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: time.RFC3339} output.FormatLevel = func(i interface{}) string { return strings.ToUpper(fmt.Sprintf("| %-6s|", i)) } output.FormatMessage = func(i interface{}) string { return fmt.Sprintf("***%s****", i) } output.FormatFieldName = func(i interface{}) string { return fmt.Sprintf("%s:", i) } output.FormatFieldValue = func(i interface{}) string { return strings.ToUpper(fmt.Sprintf("%s", i)) } log := zerolog.New(output).With().Timestamp().Logger() log.Info().Str("foo", "bar").Msg("Hello World") // Output: 2006-01-02T15:04:05Z07:00 | INFO | ***Hello World**** foo:BAR ``` ### Sub dictionary ```go log.Info(). Str("foo", "bar"). Dict("dict", zerolog.Dict(). Str("bar", "baz"). Int("n", 1), ).Msg("hello world") // Output: {"level":"info","time":1494567715,"foo":"bar","dict":{"bar":"baz","n":1},"message":"hello world"} ``` ### Customize automatic field names ```go zerolog.TimestampFieldName = "t" zerolog.LevelFieldName = "l" zerolog.MessageFieldName = "m" log.Info().Msg("hello world") // Output: {"l":"info","t":1494567715,"m":"hello world"} ``` ### Add contextual fields to the global logger ```go log.Logger = log.With().Str("foo", "bar").Logger() ``` ### Add file and line number to log ```go log.Logger = log.With().Caller().Logger() log.Info().Msg("hello world") // Output: {"level": "info", "message": "hello world", "caller": "/go/src/your_project/some_file:21"} ``` ### Thread-safe, lock-free, non-blocking writer If your writer might be slow or not thread-safe and you need your log producers to never get slowed down by a slow writer, you can use a `diode.Writer` as follow: ```go wr := diode.NewWriter(os.Stdout, 1000, 10*time.Millisecond, func(missed int) { fmt.Printf("Logger Dropped %d messages", missed) }) log := zerolog.New(wr) log.Print("test") ``` You will need to install `code.cloudfoundry.org/go-diodes` to use this feature. ### Log Sampling ```go sampled := log.Sample(&zerolog.BasicSampler{N: 10}) sampled.Info().Msg("will be logged every 10 messages") // Output: {"time":1494567715,"level":"info","message":"will be logged every 10 messages"} ``` More advanced sampling: ```go // Will let 5 debug messages per period of 1 second. // Over 5 debug message, 1 every 100 debug messages are logged. // Other levels are not sampled. sampled := log.Sample(zerolog.LevelSampler{ DebugSampler: &zerolog.BurstSampler{ Burst: 5, Period: 1*time.Second, NextSampler: &zerolog.BasicSampler{N: 100}, }, }) sampled.Debug().Msg("hello world") // Output: {"time":1494567715,"level":"debug","message":"hello world"} ``` ### Hooks ```go type SeverityHook struct{} func (h SeverityHook) Run(e *zerolog.Event, level zerolog.Level, msg string) { if level != zerolog.NoLevel { e.Str("severity", level.String()) } } hooked := log.Hook(SeverityHook{}) hooked.Warn().Msg("") // Output: {"level":"warn","severity":"warn"} ``` ### Pass a sub-logger by context ```go ctx := log.With().Str("component", "module").Logger().WithContext(ctx) log.Ctx(ctx).Info().Msg("hello world") // Output: {"component":"module","level":"info","message":"hello world"} ``` ### Set as standard logger output ```go log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Logger() stdlog.SetFlags(0) stdlog.SetOutput(log) stdlog.Print("hello world") // Output: {"foo":"bar","message":"hello world"} ``` ### Integration with `net/http` The `github.com/rs/zerolog/hlog` package provides some helpers to integrate zerolog with `http.Handler`. In this example we use [alice](https://github.com/justinas/alice) to install logger for better readability. ```go log := zerolog.New(os.Stdout).With(). Timestamp(). Str("role", "my-service"). Str("host", host). Logger() c := alice.New() // Install the logger handler with default output on the console c = c.Append(hlog.NewHandler(log)) // Install some provided extra handler to set some request's context fields. // Thanks to that handler, all our logs will come with some prepopulated fields. c = c.Append(hlog.AccessHandler(func(r *http.Request, status, size int, duration time.Duration) { hlog.FromRequest(r).Info(). Str("method", r.Method). Stringer("url", r.URL). Int("status", status). Int("size", size). Dur("duration", duration). Msg("") })) c = c.Append(hlog.RemoteAddrHandler("ip")) c = c.Append(hlog.UserAgentHandler("user_agent")) c = c.Append(hlog.RefererHandler("referer")) c = c.Append(hlog.RequestIDHandler("req_id", "Request-Id")) // Here is your final handler h := c.Then(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { // Get the logger from the request's context. You can safely assume it // will be always there: if the handler is removed, hlog.FromRequest // will return a no-op logger. hlog.FromRequest(r).Info(). Str("user", "current user"). Str("status", "ok"). Msg("Something happened") // Output: {"level":"info","time":"2001-02-03T04:05:06Z","role":"my-service","host":"local-hostname","req_id":"b4g0l5t6tfid6dtrapu0","user":"current user","status":"ok","message":"Something happened"} })) http.Handle("/", h) if err := http.ListenAndServe(":8080", nil); err != nil { log.Fatal().Err(err).Msg("Startup failed") } ``` ## Multiple Log Output `zerolog.MultiLevelWriter` may be used to send the log message to multiple outputs. In this example, we send the log message to both `os.Stdout` and the in-built ConsoleWriter. ```go func main() { consoleWriter := zerolog.ConsoleWriter{Out: os.Stdout} multi := zerolog.MultiLevelWriter(consoleWriter, os.Stdout) logger := zerolog.New(multi).With().Timestamp().Logger() logger.Info().Msg("Hello World!") } // Output (Line 1: Console; Line 2: Stdout) // 12:36PM INF Hello World! // {"level":"info","time":"2019-11-07T12:36:38+03:00","message":"Hello World!"} ``` ## Global Settings Some settings can be changed and will by applied to all loggers: * `log.Logger`: You can set this value to customize the global logger (the one used by package level methods). * `zerolog.SetGlobalLevel`: Can raise the minimum level of all loggers. Call this with `zerolog.Disabled` to disable logging altogether (quiet mode). * `zerolog.DisableSampling`: If argument is `true`, all sampled loggers will stop sampling and issue 100% of their log events. * `zerolog.TimestampFieldName`: Can be set to customize `Timestamp` field name. * `zerolog.LevelFieldName`: Can be set to customize level field name. * `zerolog.MessageFieldName`: Can be set to customize message field name. * `zerolog.ErrorFieldName`: Can be set to customize `Err` field name. * `zerolog.TimeFieldFormat`: Can be set to customize `Time` field value formatting. If set with `zerolog.TimeFormatUnix`, `zerolog.TimeFormatUnixMs` or `zerolog.TimeFormatUnixMicro`, times are formated as UNIX timestamp. * `zerolog.DurationFieldUnit`: Can be set to customize the unit for time.Duration type fields added by `Dur` (default: `time.Millisecond`). * `zerolog.DurationFieldInteger`: If set to `true`, `Dur` fields are formatted as integers instead of floats (default: `false`). * `zerolog.ErrorHandler`: 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. ## Field Types ### Standard Types * `Str` * `Bool` * `Int`, `Int8`, `Int16`, `Int32`, `Int64` * `Uint`, `Uint8`, `Uint16`, `Uint32`, `Uint64` * `Float32`, `Float64` ### Advanced Fields * `Err`: Takes an `error` and renders it as a string using the `zerolog.ErrorFieldName` field name. * `Func`: Run a `func` only if the level is enabled. * `Timestamp`: Inserts a timestamp field with `zerolog.TimestampFieldName` field name, formatted using `zerolog.TimeFieldFormat`. * `Time`: Adds a field with time formatted with `zerolog.TimeFieldFormat`. * `Dur`: Adds a field with `time.Duration`. * `Dict`: Adds a sub-key/value as a field of the event. * `RawJSON`: Adds a field with an already encoded JSON (`[]byte`) * `Hex`: Adds a field with value formatted as a hexadecimal string (`[]byte`) * `Interface`: Uses reflection to marshal the type. Most fields are also available in the slice format (`Strs` for `[]string`, `Errs` for `[]error` etc.) ## Binary Encoding In addition to the default JSON encoding, `zerolog` can produce binary logs using [CBOR](http://cbor.io) encoding. The choice of encoding can be decided at compile time using the build tag `binary_log` as follows: ```bash go build -tags binary_log . ``` To Decode binary encoded log files you can use any CBOR decoder. One has been tested to work with zerolog library is [CSD](https://github.com/toravir/csd/). ## Related Projects * [grpc-zerolog](https://github.com/cheapRoc/grpc-zerolog): Implementation of `grpclog.LoggerV2` interface using `zerolog` * [overlog](https://github.com/Trendyol/overlog): Implementation of `Mapped Diagnostic Context` interface using `zerolog` * [zerologr](https://github.com/go-logr/zerologr): Implementation of `logr.LogSink` interface using `zerolog` ## Benchmarks See [logbench](http://hackemist.com/logbench/) for more comprehensive and up-to-date benchmarks. All operations are allocation free (those numbers *include* JSON encoding): ```text BenchmarkLogEmpty-8 100000000 19.1 ns/op 0 B/op 0 allocs/op BenchmarkDisabled-8 500000000 4.07 ns/op 0 B/op 0 allocs/op BenchmarkInfo-8 30000000 42.5 ns/op 0 B/op 0 allocs/op BenchmarkContextFields-8 30000000 44.9 ns/op 0 B/op 0 allocs/op BenchmarkLogFields-8 10000000 184 ns/op 0 B/op 0 allocs/op ``` There are a few Go logging benchmarks and comparisons that include zerolog. * [imkira/go-loggers-bench](https://github.com/imkira/go-loggers-bench) * [uber-common/zap](https://github.com/uber-go/zap#performance) Using Uber's zap comparison benchmark: Log a message and 10 fields: | Library | Time | Bytes Allocated | Objects Allocated | | :--- | :---: | :---: | :---: | | zerolog | 767 ns/op | 552 B/op | 6 allocs/op | | :zap: zap | 848 ns/op | 704 B/op | 2 allocs/op | | :zap: zap (sugared) | 1363 ns/op | 1610 B/op | 20 allocs/op | | go-kit | 3614 ns/op | 2895 B/op | 66 allocs/op | | lion | 5392 ns/op | 5807 B/op | 63 allocs/op | | logrus | 5661 ns/op | 6092 B/op | 78 allocs/op | | apex/log | 15332 ns/op | 3832 B/op | 65 allocs/op | | log15 | 20657 ns/op | 5632 B/op | 93 allocs/op | Log a message with a logger that already has 10 fields of context: | Library | Time | Bytes Allocated | Objects Allocated | | :--- | :---: | :---: | :---: | | zerolog | 52 ns/op | 0 B/op | 0 allocs/op | | :zap: zap | 283 ns/op | 0 B/op | 0 allocs/op | | :zap: zap (sugared) | 337 ns/op | 80 B/op | 2 allocs/op | | lion | 2702 ns/op | 4074 B/op | 38 allocs/op | | go-kit | 3378 ns/op | 3046 B/op | 52 allocs/op | | logrus | 4309 ns/op | 4564 B/op | 63 allocs/op | | apex/log | 13456 ns/op | 2898 B/op | 51 allocs/op | | log15 | 14179 ns/op | 2642 B/op | 44 allocs/op | Log a static string, without any context or `printf`-style templating: | Library | Time | Bytes Allocated | Objects Allocated | | :--- | :---: | :---: | :---: | | zerolog | 50 ns/op | 0 B/op | 0 allocs/op | | :zap: zap | 236 ns/op | 0 B/op | 0 allocs/op | | standard library | 453 ns/op | 80 B/op | 2 allocs/op | | :zap: zap (sugared) | 337 ns/op | 80 B/op | 2 allocs/op | | go-kit | 508 ns/op | 656 B/op | 13 allocs/op | | lion | 771 ns/op | 1224 B/op | 10 allocs/op | | logrus | 1244 ns/op | 1505 B/op | 27 allocs/op | | apex/log | 2751 ns/op | 584 B/op | 11 allocs/op | | log15 | 5181 ns/op | 1592 B/op | 26 allocs/op | ## Caveats Note that zerolog does no de-duplication of fields. Using the same key multiple times creates multiple keys in final JSON: ```go logger := zerolog.New(os.Stderr).With().Timestamp().Logger() logger.Info(). Timestamp(). Msg("dup") // Output: {"level":"info","time":1494567715,"time":1494567715,"message":"dup"} ``` In this case, many consumers will take the last value, but this is not guaranteed; check yours if in doubt. zerolog-1.26.1/_config.yml000066400000000000000000000000331415647605600154230ustar00rootroot00000000000000remote_theme: rs/gh-readme zerolog-1.26.1/array.go000066400000000000000000000142541415647605600147530ustar00rootroot00000000000000package zerolog import ( "net" "sync" "time" ) var arrayPool = &sync.Pool{ New: func() interface{} { return &Array{ buf: make([]byte, 0, 500), } }, } // Array is used to prepopulate an array of items // which can be re-used to add to log messages. type Array struct { buf []byte } func putArray(a *Array) { // Proper usage of a sync.Pool requires each entry to have approximately // the same memory cost. To obtain this property when the stored type // contains a variably-sized buffer, we add a hard limit on the maximum buffer // to place back in the pool. // // See https://golang.org/issue/23199 const maxSize = 1 << 16 // 64KiB if cap(a.buf) > maxSize { return } arrayPool.Put(a) } // Arr creates an array to be added to an Event or Context. func Arr() *Array { a := arrayPool.Get().(*Array) a.buf = a.buf[:0] return a } // MarshalZerologArray method here is no-op - since data is // already in the needed format. func (*Array) MarshalZerologArray(*Array) { } func (a *Array) write(dst []byte) []byte { dst = enc.AppendArrayStart(dst) if len(a.buf) > 0 { dst = append(append(dst, a.buf...)) } dst = enc.AppendArrayEnd(dst) putArray(a) return dst } // Object marshals an object that implement the LogObjectMarshaler // interface and append append it to the array. func (a *Array) Object(obj LogObjectMarshaler) *Array { e := Dict() obj.MarshalZerologObject(e) e.buf = enc.AppendEndMarker(e.buf) a.buf = append(enc.AppendArrayDelim(a.buf), e.buf...) putEvent(e) return a } // Str append append the val as a string to the array. func (a *Array) Str(val string) *Array { a.buf = enc.AppendString(enc.AppendArrayDelim(a.buf), val) return a } // Bytes append append the val as a string to the array. func (a *Array) Bytes(val []byte) *Array { a.buf = enc.AppendBytes(enc.AppendArrayDelim(a.buf), val) return a } // Hex append append the val as a hex string to the array. func (a *Array) Hex(val []byte) *Array { a.buf = enc.AppendHex(enc.AppendArrayDelim(a.buf), val) return a } // RawJSON adds already encoded JSON to the array. func (a *Array) RawJSON(val []byte) *Array { a.buf = appendJSON(enc.AppendArrayDelim(a.buf), val) return a } // Err serializes and appends the err to the array. func (a *Array) Err(err error) *Array { switch m := ErrorMarshalFunc(err).(type) { case LogObjectMarshaler: e := newEvent(nil, 0) e.buf = e.buf[:0] e.appendObject(m) a.buf = append(enc.AppendArrayDelim(a.buf), e.buf...) putEvent(e) case error: if m == nil || isNilValue(m) { a.buf = enc.AppendNil(enc.AppendArrayDelim(a.buf)) } else { a.buf = enc.AppendString(enc.AppendArrayDelim(a.buf), m.Error()) } case string: a.buf = enc.AppendString(enc.AppendArrayDelim(a.buf), m) default: a.buf = enc.AppendInterface(enc.AppendArrayDelim(a.buf), m) } return a } // Bool append append the val as a bool to the array. func (a *Array) Bool(b bool) *Array { a.buf = enc.AppendBool(enc.AppendArrayDelim(a.buf), b) return a } // Int append append i as a int to the array. func (a *Array) Int(i int) *Array { a.buf = enc.AppendInt(enc.AppendArrayDelim(a.buf), i) return a } // Int8 append append i as a int8 to the array. func (a *Array) Int8(i int8) *Array { a.buf = enc.AppendInt8(enc.AppendArrayDelim(a.buf), i) return a } // Int16 append append i as a int16 to the array. func (a *Array) Int16(i int16) *Array { a.buf = enc.AppendInt16(enc.AppendArrayDelim(a.buf), i) return a } // Int32 append append i as a int32 to the array. func (a *Array) Int32(i int32) *Array { a.buf = enc.AppendInt32(enc.AppendArrayDelim(a.buf), i) return a } // Int64 append append i as a int64 to the array. func (a *Array) Int64(i int64) *Array { a.buf = enc.AppendInt64(enc.AppendArrayDelim(a.buf), i) return a } // Uint append append i as a uint to the array. func (a *Array) Uint(i uint) *Array { a.buf = enc.AppendUint(enc.AppendArrayDelim(a.buf), i) return a } // Uint8 append append i as a uint8 to the array. func (a *Array) Uint8(i uint8) *Array { a.buf = enc.AppendUint8(enc.AppendArrayDelim(a.buf), i) return a } // Uint16 append append i as a uint16 to the array. func (a *Array) Uint16(i uint16) *Array { a.buf = enc.AppendUint16(enc.AppendArrayDelim(a.buf), i) return a } // Uint32 append append i as a uint32 to the array. func (a *Array) Uint32(i uint32) *Array { a.buf = enc.AppendUint32(enc.AppendArrayDelim(a.buf), i) return a } // Uint64 append append i as a uint64 to the array. func (a *Array) Uint64(i uint64) *Array { a.buf = enc.AppendUint64(enc.AppendArrayDelim(a.buf), i) return a } // Float32 append append f as a float32 to the array. func (a *Array) Float32(f float32) *Array { a.buf = enc.AppendFloat32(enc.AppendArrayDelim(a.buf), f) return a } // Float64 append append f as a float64 to the array. func (a *Array) Float64(f float64) *Array { a.buf = enc.AppendFloat64(enc.AppendArrayDelim(a.buf), f) return a } // Time append append t formated as string using zerolog.TimeFieldFormat. func (a *Array) Time(t time.Time) *Array { a.buf = enc.AppendTime(enc.AppendArrayDelim(a.buf), t, TimeFieldFormat) return a } // Dur append append d to the array. func (a *Array) Dur(d time.Duration) *Array { a.buf = enc.AppendDuration(enc.AppendArrayDelim(a.buf), d, DurationFieldUnit, DurationFieldInteger) return a } // Interface append append i marshaled using reflection. func (a *Array) Interface(i interface{}) *Array { if obj, ok := i.(LogObjectMarshaler); ok { return a.Object(obj) } a.buf = enc.AppendInterface(enc.AppendArrayDelim(a.buf), i) return a } // IPAddr adds IPv4 or IPv6 address to the array func (a *Array) IPAddr(ip net.IP) *Array { a.buf = enc.AppendIPAddr(enc.AppendArrayDelim(a.buf), ip) return a } // IPPrefix adds IPv4 or IPv6 Prefix (IP + mask) to the array func (a *Array) IPPrefix(pfx net.IPNet) *Array { a.buf = enc.AppendIPPrefix(enc.AppendArrayDelim(a.buf), pfx) return a } // MACAddr adds a MAC (Ethernet) address to the array func (a *Array) MACAddr(ha net.HardwareAddr) *Array { a.buf = enc.AppendMACAddr(enc.AppendArrayDelim(a.buf), ha) return a } // Dict adds the dict Event to the array func (a *Array) Dict(dict *Event) *Array { dict.buf = enc.AppendEndMarker(dict.buf) a.buf = append(enc.AppendArrayDelim(a.buf), dict.buf...) return a } zerolog-1.26.1/array_test.go000066400000000000000000000014041415647605600160030ustar00rootroot00000000000000package zerolog import ( "net" "testing" "time" ) func TestArray(t *testing.T) { a := Arr(). Bool(true). Int(1). Int8(2). Int16(3). Int32(4). Int64(5). Uint(6). Uint8(7). Uint16(8). Uint32(9). Uint64(10). Float32(11.98122). Float64(12.987654321). Str("a"). Bytes([]byte("b")). Hex([]byte{0x1f}). RawJSON([]byte(`{"some":"json"}`)). Time(time.Time{}). IPAddr(net.IP{192, 168, 0, 10}). Dur(0). Dict(Dict(). Str("bar", "baz"). Int("n", 1), ) want := `[true,1,2,3,4,5,6,7,8,9,10,11.98122,12.987654321,"a","b","1f",{"some":"json"},"0001-01-01T00:00:00Z","192.168.0.10",0,{"bar":"baz","n":1}]` if got := decodeObjectToStr(a.write([]byte{})); got != want { t.Errorf("Array.write()\ngot: %s\nwant: %s", got, want) } } zerolog-1.26.1/benchmark_test.go000066400000000000000000000177441415647605600166350ustar00rootroot00000000000000package zerolog import ( "errors" "io/ioutil" "net" "testing" "time" ) var ( errExample = errors.New("fail") fakeMessage = "Test logging, but use a somewhat realistic message length." ) func BenchmarkLogEmpty(b *testing.B) { logger := New(ioutil.Discard) b.ResetTimer() b.RunParallel(func(pb *testing.PB) { for pb.Next() { logger.Log().Msg("") } }) } func BenchmarkDisabled(b *testing.B) { logger := New(ioutil.Discard).Level(Disabled) b.ResetTimer() b.RunParallel(func(pb *testing.PB) { for pb.Next() { logger.Info().Msg(fakeMessage) } }) } func BenchmarkInfo(b *testing.B) { logger := New(ioutil.Discard) b.ResetTimer() b.RunParallel(func(pb *testing.PB) { for pb.Next() { logger.Info().Msg(fakeMessage) } }) } func BenchmarkContextFields(b *testing.B) { logger := New(ioutil.Discard).With(). Str("string", "four!"). Time("time", time.Time{}). Int("int", 123). Float32("float", -2.203230293249593). Logger() b.ResetTimer() b.RunParallel(func(pb *testing.PB) { for pb.Next() { logger.Info().Msg(fakeMessage) } }) } func BenchmarkContextAppend(b *testing.B) { logger := New(ioutil.Discard).With(). Str("foo", "bar"). Logger() b.ResetTimer() b.RunParallel(func(pb *testing.PB) { for pb.Next() { logger.With().Str("bar", "baz") } }) } func BenchmarkLogFields(b *testing.B) { logger := New(ioutil.Discard) b.ResetTimer() b.RunParallel(func(pb *testing.PB) { for pb.Next() { logger.Info(). Str("string", "four!"). Time("time", time.Time{}). Int("int", 123). Float32("float", -2.203230293249593). Msg(fakeMessage) } }) } type obj struct { Pub string Tag string `json:"tag"` priv int } func (o obj) MarshalZerologObject(e *Event) { e.Str("Pub", o.Pub). Str("Tag", o.Tag). Int("priv", o.priv) } func BenchmarkLogArrayObject(b *testing.B) { obj1 := obj{"a", "b", 2} obj2 := obj{"c", "d", 3} obj3 := obj{"e", "f", 4} logger := New(ioutil.Discard) b.ResetTimer() b.ReportAllocs() for i := 0; i < b.N; i++ { arr := Arr() arr.Object(&obj1) arr.Object(&obj2) arr.Object(&obj3) logger.Info().Array("objects", arr).Msg("test") } } func BenchmarkLogFieldType(b *testing.B) { bools := []bool{true, false, true, false, true, false, true, false, true, false} ints := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} floats := []float64{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} strings := []string{"a", "b", "c", "d", "e", "f", "g", "h", "i", "j"} durations := []time.Duration{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} times := []time.Time{ time.Unix(0, 0), time.Unix(1, 0), time.Unix(2, 0), time.Unix(3, 0), time.Unix(4, 0), time.Unix(5, 0), time.Unix(6, 0), time.Unix(7, 0), time.Unix(8, 0), time.Unix(9, 0), } interfaces := []struct { Pub string Tag string `json:"tag"` priv int }{ {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, } objects := []obj{ {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, } errs := []error{errors.New("a"), errors.New("b"), errors.New("c"), errors.New("d"), errors.New("e")} types := map[string]func(e *Event) *Event{ "Bool": func(e *Event) *Event { return e.Bool("k", bools[0]) }, "Bools": func(e *Event) *Event { return e.Bools("k", bools) }, "Int": func(e *Event) *Event { return e.Int("k", ints[0]) }, "Ints": func(e *Event) *Event { return e.Ints("k", ints) }, "Float": func(e *Event) *Event { return e.Float64("k", floats[0]) }, "Floats": func(e *Event) *Event { return e.Floats64("k", floats) }, "Str": func(e *Event) *Event { return e.Str("k", strings[0]) }, "Strs": func(e *Event) *Event { return e.Strs("k", strings) }, "Err": func(e *Event) *Event { return e.Err(errs[0]) }, "Errs": func(e *Event) *Event { return e.Errs("k", errs) }, "Time": func(e *Event) *Event { return e.Time("k", times[0]) }, "Times": func(e *Event) *Event { return e.Times("k", times) }, "Dur": func(e *Event) *Event { return e.Dur("k", durations[0]) }, "Durs": func(e *Event) *Event { return e.Durs("k", durations) }, "Interface": func(e *Event) *Event { return e.Interface("k", interfaces[0]) }, "Interfaces": func(e *Event) *Event { return e.Interface("k", interfaces) }, "Interface(Object)": func(e *Event) *Event { return e.Interface("k", objects[0]) }, "Interface(Objects)": func(e *Event) *Event { return e.Interface("k", objects) }, "Object": func(e *Event) *Event { return e.Object("k", objects[0]) }, } logger := New(ioutil.Discard) b.ResetTimer() for name := range types { f := types[name] b.Run(name, func(b *testing.B) { b.RunParallel(func(pb *testing.PB) { for pb.Next() { f(logger.Info()).Msg("") } }) }) } } func BenchmarkContextFieldType(b *testing.B) { oldFormat := TimeFieldFormat TimeFieldFormat = TimeFormatUnix defer func() { TimeFieldFormat = oldFormat }() bools := []bool{true, false, true, false, true, false, true, false, true, false} ints := []int{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} floats := []float64{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} strings := []string{"a", "b", "c", "d", "e", "f", "g", "h", "i", "j"} stringer := net.IP{127, 0, 0, 1} durations := []time.Duration{0, 1, 2, 3, 4, 5, 6, 7, 8, 9} times := []time.Time{ time.Unix(0, 0), time.Unix(1, 0), time.Unix(2, 0), time.Unix(3, 0), time.Unix(4, 0), time.Unix(5, 0), time.Unix(6, 0), time.Unix(7, 0), time.Unix(8, 0), time.Unix(9, 0), } interfaces := []struct { Pub string Tag string `json:"tag"` priv int }{ {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, } objects := []obj{ {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, {"a", "a", 0}, } errs := []error{errors.New("a"), errors.New("b"), errors.New("c"), errors.New("d"), errors.New("e")} types := map[string]func(c Context) Context{ "Bool": func(c Context) Context { return c.Bool("k", bools[0]) }, "Bools": func(c Context) Context { return c.Bools("k", bools) }, "Int": func(c Context) Context { return c.Int("k", ints[0]) }, "Ints": func(c Context) Context { return c.Ints("k", ints) }, "Float": func(c Context) Context { return c.Float64("k", floats[0]) }, "Floats": func(c Context) Context { return c.Floats64("k", floats) }, "Str": func(c Context) Context { return c.Str("k", strings[0]) }, "Strs": func(c Context) Context { return c.Strs("k", strings) }, "Stringer": func(c Context) Context { return c.Stringer("k", stringer) }, "Err": func(c Context) Context { return c.Err(errs[0]) }, "Errs": func(c Context) Context { return c.Errs("k", errs) }, "Time": func(c Context) Context { return c.Time("k", times[0]) }, "Times": func(c Context) Context { return c.Times("k", times) }, "Dur": func(c Context) Context { return c.Dur("k", durations[0]) }, "Durs": func(c Context) Context { return c.Durs("k", durations) }, "Interface": func(c Context) Context { return c.Interface("k", interfaces[0]) }, "Interfaces": func(c Context) Context { return c.Interface("k", interfaces) }, "Interface(Object)": func(c Context) Context { return c.Interface("k", objects[0]) }, "Interface(Objects)": func(c Context) Context { return c.Interface("k", objects) }, "Object": func(c Context) Context { return c.Object("k", objects[0]) }, "Timestamp": func(c Context) Context { return c.Timestamp() }, } logger := New(ioutil.Discard) b.ResetTimer() for name := range types { f := types[name] b.Run(name, func(b *testing.B) { b.RunParallel(func(pb *testing.PB) { for pb.Next() { l := f(logger.With()).Logger() l.Info().Msg("") } }) }) } } zerolog-1.26.1/binary_test.go000066400000000000000000000276651415647605600161720ustar00rootroot00000000000000// +build binary_log package zerolog import ( "bytes" "errors" "fmt" // "io/ioutil" stdlog "log" "time" ) func ExampleBinaryNew() { dst := bytes.Buffer{} log := New(&dst) log.Info().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"info","message":"hello world"} } func ExampleLogger_With() { dst := bytes.Buffer{} log := New(&dst). With(). Str("foo", "bar"). Logger() log.Info().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"info","foo":"bar","message":"hello world"} } func ExampleLogger_Level() { dst := bytes.Buffer{} log := New(&dst).Level(WarnLevel) log.Info().Msg("filtered out message") log.Error().Msg("kept message") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"error","message":"kept message"} } func ExampleLogger_Sample() { 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: {"level":"info","message":"message 1"} // {"level":"info","message":"message 3"} } type LevelNameHook1 struct{} func (h LevelNameHook1) Run(e *Event, l Level, msg string) { if l != NoLevel { e.Str("level_name", l.String()) } else { e.Str("level_name", "NoLevel") } } type MessageHook string func (h MessageHook) Run(e *Event, l Level, msg string) { e.Str("the_message", msg) } func ExampleLogger_Hook() { var levelNameHook LevelNameHook1 var messageHook MessageHook = "The message" dst := bytes.Buffer{} log := New(&dst).Hook(levelNameHook).Hook(messageHook) log.Info().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"info","level_name":"info","the_message":"hello world","message":"hello world"} } func ExampleLogger_Print() { dst := bytes.Buffer{} log := New(&dst) log.Print("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"debug","message":"hello world"} } func ExampleLogger_Printf() { dst := bytes.Buffer{} log := New(&dst) log.Printf("hello %s", "world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"debug","message":"hello world"} } func ExampleLogger_Trace() { dst := bytes.Buffer{} log := New(&dst) log.Trace(). Str("foo", "bar"). Int("n", 123). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"trace","foo":"bar","n":123,"message":"hello world"} } func ExampleLogger_Debug() { dst := bytes.Buffer{} log := New(&dst) log.Debug(). Str("foo", "bar"). Int("n", 123). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"debug","foo":"bar","n":123,"message":"hello world"} } func ExampleLogger_Info() { dst := bytes.Buffer{} log := New(&dst) log.Info(). Str("foo", "bar"). Int("n", 123). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"info","foo":"bar","n":123,"message":"hello world"} } func ExampleLogger_Warn() { dst := bytes.Buffer{} log := New(&dst) log.Warn(). Str("foo", "bar"). Msg("a warning message") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"warn","foo":"bar","message":"a warning message"} } func ExampleLogger_Error() { dst := bytes.Buffer{} log := New(&dst) log.Error(). Err(errors.New("some error")). Msg("error doing something") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"error","error":"some error","message":"error doing something"} } func ExampleLogger_WithLevel() { dst := bytes.Buffer{} log := New(&dst) log.WithLevel(InfoLevel). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"level":"info","message":"hello world"} } func ExampleLogger_Write() { 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","message":"hello world"} } func ExampleLogger_Log() { dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). Str("bar", "baz"). Msg("") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","bar":"baz"} } func ExampleEvent_Dict() { dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). Dict("dict", Dict(). Str("bar", "baz"). Int("n", 1), ). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","dict":{"bar":"baz","n":1},"message":"hello world"} } type User struct { Name string Age int Created time.Time } func (u User) MarshalZerologObject(e *Event) { e.Str("name", u.Name). Int("age", u.Age). Time("created", u.Created) } type Users []User func (uu Users) MarshalZerologArray(a *Array) { for _, u := range uu { a.Object(u) } } func ExampleEvent_Array() { dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). Array("array", Arr(). Str("baz"). Int(1), ). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","array":["baz",1],"message":"hello world"} } func ExampleEvent_Array_object() { dst := bytes.Buffer{} log := New(&dst) // Users implements LogArrayMarshaler u := Users{ User{"John", 35, time.Time{}}, User{"Bob", 55, time.Time{}}, } log.Log(). Str("foo", "bar"). Array("users", u). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","users":[{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},{"name":"Bob","age":55,"created":"0001-01-01T00:00:00Z"}],"message":"hello world"} } func ExampleEvent_Object() { dst := bytes.Buffer{} log := New(&dst) // User implements LogObjectMarshaler u := User{"John", 35, time.Time{}} log.Log(). Str("foo", "bar"). Object("user", u). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","user":{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},"message":"hello world"} } func ExampleEvent_EmbedObject() { price := Price{val: 6449, prec: 2, unit: "$"} dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). EmbedObject(price). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","price":"$64.49","message":"hello world"} } func ExampleEvent_Interface() { dst := bytes.Buffer{} log := New(&dst) obj := struct { Name string `json:"name"` }{ Name: "john", } log.Log(). Str("foo", "bar"). Interface("obj", obj). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","obj":{"name":"john"},"message":"hello world"} } func ExampleEvent_Dur() { d := time.Duration(10 * time.Second) dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). Dur("dur", d). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","dur":10000,"message":"hello world"} } func ExampleEvent_Durs() { d := []time.Duration{ time.Duration(10 * time.Second), time.Duration(20 * time.Second), } dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). Durs("durs", d). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","durs":[10000,20000],"message":"hello world"} } func ExampleEvent_Fields_map() { fields := map[string]interface{}{ "bar": "baz", "n": 1, } dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). Fields(fields). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } func ExampleEvent_Fields_slice() { fields := []interface{}{ "bar", "baz", "n", 1, } dst := bytes.Buffer{} log := New(&dst) log.Log(). Str("foo", "bar"). Fields(fields). Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } func ExampleContext_Dict() { dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Dict("dict", Dict(). Str("bar", "baz"). Int("n", 1), ).Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","dict":{"bar":"baz","n":1},"message":"hello world"} } func ExampleContext_Array() { dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Array("array", Arr(). Str("baz"). Int(1), ).Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","array":["baz",1],"message":"hello world"} } func ExampleContext_Array_object() { // Users implements LogArrayMarshaler u := Users{ User{"John", 35, time.Time{}}, User{"Bob", 55, time.Time{}}, } dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Array("users", u). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","users":[{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},{"name":"Bob","age":55,"created":"0001-01-01T00:00:00Z"}],"message":"hello world"} } type Price struct { val uint64 prec int unit string } func (p Price) MarshalZerologObject(e *Event) { denom := uint64(1) for i := 0; i < p.prec; i++ { denom *= 10 } result := []byte(p.unit) result = append(result, fmt.Sprintf("%d.%d", p.val/denom, p.val%denom)...) e.Str("price", string(result)) } func ExampleContext_EmbedObject() { price := Price{val: 6449, prec: 2, unit: "$"} dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). EmbedObject(price). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","price":"$64.49","message":"hello world"} } func ExampleContext_Object() { // User implements LogObjectMarshaler u := User{"John", 35, time.Time{}} dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Object("user", u). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","user":{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},"message":"hello world"} } func ExampleContext_Interface() { 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"},"message":"hello world"} } func ExampleContext_Dur() { 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,"message":"hello world"} } func ExampleContext_Durs() { 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],"message":"hello world"} } func ExampleContext_Fields_map() { fields := map[string]interface{}{ "bar": "baz", "n": 1, } dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Fields(fields). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } func ExampleContext_Fields_slice() { fields := []interface{}{ "bar", "baz", "n", 1, } dst := bytes.Buffer{} log := New(&dst).With(). Str("foo", "bar"). Fields(fields). Logger() log.Log().Msg("hello world") fmt.Println(decodeIfBinaryToString(dst.Bytes())) // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } zerolog-1.26.1/cmd/000077500000000000000000000000001415647605600140435ustar00rootroot00000000000000zerolog-1.26.1/cmd/lint/000077500000000000000000000000001415647605600150115ustar00rootroot00000000000000zerolog-1.26.1/cmd/lint/lint.go000066400000000000000000000102621415647605600163070ustar00rootroot00000000000000package main import ( "flag" "fmt" "go/ast" "go/token" "go/types" "os" "path/filepath" "strings" "golang.org/x/tools/go/loader" ) var ( recursivelyIgnoredPkgs arrayFlag ignoredPkgs arrayFlag ignoredFiles arrayFlag allowedFinishers arrayFlag = []string{"Msg", "Msgf"} rootPkg string ) // parse input flags and args func init() { flag.Var(&recursivelyIgnoredPkgs, "ignorePkgRecursively", "ignore the specified package and all subpackages recursively") flag.Var(&ignoredPkgs, "ignorePkg", "ignore the specified package") flag.Var(&ignoredFiles, "ignoreFile", "ignore the specified file by its path and/or go path (package/file.go)") flag.Var(&allowedFinishers, "finisher", "allowed finisher for the event chain") flag.Parse() // add zerolog to recursively ignored packages recursivelyIgnoredPkgs = append(recursivelyIgnoredPkgs, "github.com/rs/zerolog") args := flag.Args() if len(args) != 1 { fmt.Fprintln(os.Stderr, "you must provide exactly one package path") os.Exit(1) } rootPkg = args[0] } func main() { // load the package and all its dependencies conf := loader.Config{} conf.Import(rootPkg) p, err := conf.Load() if err != nil { fmt.Fprintf(os.Stderr, "Error: unable to load the root package. %s\n", err.Error()) os.Exit(1) } // get the github.com/rs/zerolog.Event type event := getEvent(p) if event == nil { fmt.Fprintln(os.Stderr, "Error: github.com/rs/zerolog.Event declaration not found, maybe zerolog is not imported in the scanned package?") os.Exit(1) } // get all selections (function calls) with the github.com/rs/zerolog.Event (or pointer) receiver selections := getSelectionsWithReceiverType(p, event) // print the violations (if any) hasViolations := false for _, s := range selections { if hasBadFinisher(p, s) { hasViolations = true fmt.Printf("Error: missing or bad finisher for log chain, last call: %q at: %s:%v\n", s.fn.Name(), p.Fset.File(s.Pos()).Name(), p.Fset.Position(s.Pos()).Line) } } // if no violations detected, return normally if !hasViolations { fmt.Println("No violations found") return } // if violations were detected, return error code os.Exit(1) } func getEvent(p *loader.Program) types.Type { for _, pkg := range p.AllPackages { if strings.HasSuffix(pkg.Pkg.Path(), "github.com/rs/zerolog") { for _, d := range pkg.Defs { if d != nil && d.Name() == "Event" { return d.Type() } } } } return nil } func getSelectionsWithReceiverType(p *loader.Program, targetType types.Type) map[token.Pos]selection { selections := map[token.Pos]selection{} for _, z := range p.AllPackages { for i, t := range z.Selections { switch o := t.Obj().(type) { case *types.Func: // this is not a bug, o.Type() is always *types.Signature, see docs if vt := o.Type().(*types.Signature).Recv(); vt != nil { typ := vt.Type() if pointer, ok := typ.(*types.Pointer); ok { typ = pointer.Elem() } if typ == targetType { if s, ok := selections[i.Pos()]; !ok || i.End() > s.End() { selections[i.Pos()] = selection{i, o, z.Pkg} } } } default: // skip } } } return selections } func hasBadFinisher(p *loader.Program, s selection) bool { pkgPath := strings.TrimPrefix(s.pkg.Path(), rootPkg+"/vendor/") absoluteFilePath := strings.TrimPrefix(p.Fset.File(s.Pos()).Name(), rootPkg+"/vendor/") goFilePath := pkgPath + "/" + filepath.Base(p.Fset.Position(s.Pos()).Filename) for _, f := range allowedFinishers { if f == s.fn.Name() { return false } } for _, ignoredPkg := range recursivelyIgnoredPkgs { if strings.HasPrefix(pkgPath, ignoredPkg) { return false } } for _, ignoredPkg := range ignoredPkgs { if pkgPath == ignoredPkg { return false } } for _, ignoredFile := range ignoredFiles { if absoluteFilePath == ignoredFile { return false } if goFilePath == ignoredFile { return false } } return true } type arrayFlag []string func (i *arrayFlag) String() string { return fmt.Sprintf("%v", []string(*i)) } func (i *arrayFlag) Set(value string) error { *i = append(*i, value) return nil } type selection struct { *ast.SelectorExpr fn *types.Func pkg *types.Package } zerolog-1.26.1/cmd/lint/readme.md000066400000000000000000000041471415647605600165760ustar00rootroot00000000000000# Zerolog Lint This is a basic linter that checks for missing log event finishers. Finds errors like: `log.Error().Int64("userID": 5)` - missing the `Msg`/`Msgf` finishers. ## Problem When using zerolog it's easy to forget to finish the log event chain by calling a finisher - the `Msg` or `Msgf` function that will schedule the event for writing. The problem with this is that it doesn't warn/panic during compilation and it's not easily found by grep or other general tools. It's even prominently mentioned in the project's readme, that: > It is very important to note that when using the **zerolog** chaining API, as shown above (`log.Info().Msg("hello world"`), the chain must have either the `Msg` or `Msgf` method call. If you forget to add either of these, the log will not occur and there is no compile time error to alert you of this. ## Solution A basic linter like this one here that looks for method invocations on `zerolog.Event` can examine the last call in a method call chain and check if it is a finisher, thus pointing out these errors. ## Usage Just compile this and then run it. Or just run it via `go run` command via something like `go run cmd/lint/lint.go`. The command accepts only one argument - the package to be inspected - and 4 optional flags, all of which can occur multiple times. The standard synopsis of the command is: `lint [-finisher value] [-ignoreFile value] [-ignorePkg value] [-ignorePkgRecursively value] package` #### Flags - finisher - specify which finishers to accept, defaults to `Msg` and `Msgf` - ignoreFile - which files to ignore, either by full path or by go path (package/file.go) - ignorePkg - do not inspect the specified package if found in the dependecy tree - ignorePkgRecursively - do not inspect the specified package or its subpackages if found in the dependency tree ## Drawbacks As it is, linter can generate a false positives in a specific case. These false positives come from the fact that if you have a method that returns a `zerolog.Event` the linter will flag it because you are obviously not finishing the event. This will be solved in later release. zerolog-1.26.1/console.go000066400000000000000000000217511415647605600152770ustar00rootroot00000000000000package zerolog import ( "bytes" "encoding/json" "fmt" "io" "os" "path/filepath" "sort" "strconv" "strings" "sync" "time" ) const ( colorBlack = iota + 30 colorRed colorGreen colorYellow colorBlue colorMagenta colorCyan colorWhite colorBold = 1 colorDarkGray = 90 ) var ( consoleBufPool = sync.Pool{ New: func() interface{} { return bytes.NewBuffer(make([]byte, 0, 100)) }, } ) const ( consoleDefaultTimeFormat = time.Kitchen ) // Formatter transforms the input into a formatted string. type Formatter func(interface{}) string // 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 FormatTimestamp Formatter FormatLevel Formatter FormatCaller Formatter FormatMessage Formatter FormatFieldName Formatter FormatFieldValue Formatter FormatErrFieldName Formatter FormatErrFieldValue Formatter } // NewConsoleWriter creates and initializes a new ConsoleWriter. func NewConsoleWriter(options ...func(w *ConsoleWriter)) ConsoleWriter { w := ConsoleWriter{ Out: os.Stdout, TimeFormat: consoleDefaultTimeFormat, PartsOrder: consoleDefaultPartsOrder(), } for _, opt := range options { opt(&w) } return w } // Write transforms the JSON input with formatters and appends to w.Out. func (w ConsoleWriter) Write(p []byte) (n int, err error) { if w.PartsOrder == nil { w.PartsOrder = consoleDefaultPartsOrder() } var buf = consoleBufPool.Get().(*bytes.Buffer) defer func() { buf.Reset() consoleBufPool.Put(buf) }() var evt map[string]interface{} p = decodeIfBinaryToBytes(p) d := json.NewDecoder(bytes.NewReader(p)) d.UseNumber() err = d.Decode(&evt) if err != nil { return n, fmt.Errorf("cannot decode event: %s", err) } for _, p := range w.PartsOrder { w.writePart(buf, evt, p) } w.writeFields(evt, buf) err = buf.WriteByte('\n') if err != nil { return n, err } _, err = buf.WriteTo(w.Out) return len(p), err } // writeFields appends formatted key-value pairs to buf. func (w ConsoleWriter) writeFields(evt map[string]interface{}, buf *bytes.Buffer) { var fields = make([]string, 0, len(evt)) for field := range evt { switch field { case LevelFieldName, TimestampFieldName, MessageFieldName, CallerFieldName: continue } fields = append(fields, field) } sort.Strings(fields) if len(fields) > 0 { buf.WriteByte(' ') } // Move the "error" field to the front ei := sort.Search(len(fields), func(i int) bool { return fields[i] >= ErrorFieldName }) if ei < len(fields) && fields[ei] == ErrorFieldName { fields[ei] = "" fields = append([]string{ErrorFieldName}, fields...) var xfields = make([]string, 0, len(fields)) for _, field := range fields { if field == "" { // Skip empty fields continue } xfields = append(xfields, field) } fields = xfields } for i, field := range fields { var fn Formatter var fv Formatter if field == ErrorFieldName { if w.FormatErrFieldName == nil { fn = consoleDefaultFormatErrFieldName(w.NoColor) } else { fn = w.FormatErrFieldName } if w.FormatErrFieldValue == nil { fv = consoleDefaultFormatErrFieldValue(w.NoColor) } else { fv = w.FormatErrFieldValue } } else { if w.FormatFieldName == nil { fn = consoleDefaultFormatFieldName(w.NoColor) } else { fn = w.FormatFieldName } if w.FormatFieldValue == nil { fv = consoleDefaultFormatFieldValue } else { fv = w.FormatFieldValue } } buf.WriteString(fn(field)) switch fValue := evt[field].(type) { case string: if needsQuote(fValue) { buf.WriteString(fv(strconv.Quote(fValue))) } else { buf.WriteString(fv(fValue)) } case json.Number: buf.WriteString(fv(fValue)) default: b, err := json.Marshal(fValue) if err != nil { fmt.Fprintf(buf, colorize("[error: %v]", colorRed, w.NoColor), err) } else { fmt.Fprint(buf, fv(b)) } } if i < len(fields)-1 { // Skip space for last field buf.WriteByte(' ') } } } // writePart appends a formatted part to buf. func (w ConsoleWriter) writePart(buf *bytes.Buffer, evt map[string]interface{}, p string) { var f Formatter if w.PartsExclude != nil && len(w.PartsExclude) > 0 { for _, exclude := range w.PartsExclude { if exclude == p { return } } } switch p { case LevelFieldName: if w.FormatLevel == nil { f = consoleDefaultFormatLevel(w.NoColor) } else { f = w.FormatLevel } case TimestampFieldName: if w.FormatTimestamp == nil { f = consoleDefaultFormatTimestamp(w.TimeFormat, w.NoColor) } else { f = w.FormatTimestamp } case MessageFieldName: if w.FormatMessage == nil { f = consoleDefaultFormatMessage } else { f = w.FormatMessage } case CallerFieldName: if w.FormatCaller == nil { f = consoleDefaultFormatCaller(w.NoColor) } else { f = w.FormatCaller } default: if w.FormatFieldValue == nil { f = consoleDefaultFormatFieldValue } else { f = w.FormatFieldValue } } var s = f(evt[p]) if len(s) > 0 { buf.WriteString(s) if p != w.PartsOrder[len(w.PartsOrder)-1] { // Skip space for last part buf.WriteByte(' ') } } } // needsQuote returns true when the string s should be quoted in output. func needsQuote(s string) bool { for i := range s { if s[i] < 0x20 || s[i] > 0x7e || s[i] == ' ' || s[i] == '\\' || s[i] == '"' { return true } } return false } // colorize returns the string s wrapped in ANSI code c, unless disabled is true. func colorize(s interface{}, c int, disabled bool) string { if disabled { return fmt.Sprintf("%s", s) } return fmt.Sprintf("\x1b[%dm%v\x1b[0m", c, s) } // ----- DEFAULT FORMATTERS --------------------------------------------------- func consoleDefaultPartsOrder() []string { return []string{ TimestampFieldName, LevelFieldName, CallerFieldName, MessageFieldName, } } func consoleDefaultFormatTimestamp(timeFormat string, noColor bool) Formatter { if timeFormat == "" { timeFormat = consoleDefaultTimeFormat } return func(i interface{}) string { t := "" switch tt := i.(type) { case string: ts, err := time.Parse(TimeFieldFormat, tt) if err != nil { t = tt } else { t = ts.Format(timeFormat) } case json.Number: i, err := tt.Int64() if err != nil { t = tt.String() } else { var sec, nsec int64 = i, 0 switch TimeFieldFormat { case TimeFormatUnixMs: nsec = int64(time.Duration(i) * time.Millisecond) sec = 0 case TimeFormatUnixMicro: nsec = int64(time.Duration(i) * time.Microsecond) sec = 0 } ts := time.Unix(sec, nsec).UTC() t = ts.Format(timeFormat) } } return colorize(t, colorDarkGray, noColor) } } func consoleDefaultFormatLevel(noColor bool) Formatter { return func(i interface{}) string { var l string if ll, ok := i.(string); ok { switch ll { case LevelTraceValue: l = colorize("TRC", colorMagenta, noColor) case LevelDebugValue: l = colorize("DBG", colorYellow, noColor) case LevelInfoValue: l = colorize("INF", colorGreen, noColor) case LevelWarnValue: l = colorize("WRN", colorRed, noColor) case LevelErrorValue: l = colorize(colorize("ERR", colorRed, noColor), colorBold, noColor) case LevelFatalValue: l = colorize(colorize("FTL", colorRed, noColor), colorBold, noColor) case LevelPanicValue: l = colorize(colorize("PNC", colorRed, noColor), colorBold, noColor) default: l = colorize("???", colorBold, noColor) } } else { if i == nil { l = colorize("???", colorBold, noColor) } else { l = strings.ToUpper(fmt.Sprintf("%s", i))[0:3] } } return l } } func consoleDefaultFormatCaller(noColor bool) Formatter { return func(i interface{}) string { var c string if cc, ok := i.(string); ok { c = cc } if len(c) > 0 { if cwd, err := os.Getwd(); err == nil { if rel, err := filepath.Rel(cwd, c); err == nil { c = rel } } c = colorize(c, colorBold, noColor) + colorize(" >", colorCyan, noColor) } return c } } func consoleDefaultFormatMessage(i interface{}) string { if i == nil { return "" } return fmt.Sprintf("%s", i) } func consoleDefaultFormatFieldName(noColor bool) Formatter { return func(i interface{}) string { return colorize(fmt.Sprintf("%s=", i), colorCyan, noColor) } } func consoleDefaultFormatFieldValue(i interface{}) string { return fmt.Sprintf("%s", i) } func consoleDefaultFormatErrFieldName(noColor bool) Formatter { return func(i interface{}) string { return colorize(fmt.Sprintf("%s=", i), colorCyan, noColor) } } func consoleDefaultFormatErrFieldValue(noColor bool) Formatter { return func(i interface{}) string { return colorize(fmt.Sprintf("%s", i), colorRed, noColor) } } zerolog-1.26.1/console_test.go000066400000000000000000000260601415647605600163340ustar00rootroot00000000000000package zerolog_test import ( "bytes" "fmt" "io/ioutil" "os" "strings" "testing" "time" "github.com/rs/zerolog" ) func ExampleConsoleWriter() { log := zerolog.New(zerolog.ConsoleWriter{Out: os.Stdout, NoColor: true}) log.Info().Str("foo", "bar").Msg("Hello World") // Output: INF Hello World foo=bar } func ExampleConsoleWriter_customFormatters() { out := zerolog.ConsoleWriter{Out: os.Stdout, NoColor: true} out.FormatLevel = func(i interface{}) string { return strings.ToUpper(fmt.Sprintf("%-6s|", i)) } out.FormatFieldName = func(i interface{}) string { return fmt.Sprintf("%s:", i) } out.FormatFieldValue = func(i interface{}) string { return strings.ToUpper(fmt.Sprintf("%s", i)) } log := zerolog.New(out) log.Info().Str("foo", "bar").Msg("Hello World") // Output: INFO | Hello World foo:BAR } func ExampleNewConsoleWriter() { out := zerolog.NewConsoleWriter() out.NoColor = true // For testing purposes only log := zerolog.New(out) log.Debug().Str("foo", "bar").Msg("Hello World") // Output: DBG Hello World foo=bar } func ExampleNewConsoleWriter_customFormatters() { out := zerolog.NewConsoleWriter( func(w *zerolog.ConsoleWriter) { // Customize time format w.TimeFormat = time.RFC822 // Customize level formatting w.FormatLevel = func(i interface{}) string { return strings.ToUpper(fmt.Sprintf("[%-5s]", i)) } }, ) out.NoColor = true // For testing purposes only log := zerolog.New(out) log.Info().Str("foo", "bar").Msg("Hello World") // Output: [INFO ] Hello World foo=bar } func TestConsoleLogger(t *testing.T) { t.Run("Numbers", func(t *testing.T) { buf := &bytes.Buffer{} log := zerolog.New(zerolog.ConsoleWriter{Out: buf, NoColor: true}) log.Info(). Float64("float", 1.23). Uint64("small", 123). Uint64("big", 1152921504606846976). Msg("msg") if got, want := strings.TrimSpace(buf.String()), " INF msg big=1152921504606846976 float=1.23 small=123"; got != want { t.Errorf("\ngot:\n%s\nwant:\n%s", got, want) } }) } func TestConsoleWriter(t *testing.T) { t.Run("Default field formatter", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true, PartsOrder: []string{"foo"}} _, err := w.Write([]byte(`{"foo": "DEFAULT"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "DEFAULT foo=DEFAULT\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Write colorized", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: false} _, err := w.Write([]byte(`{"level": "warn", "message": "Foobar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "\x1b[90m\x1b[0m \x1b[31mWRN\x1b[0m Foobar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Write fields", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true} d := time.Unix(0, 0).UTC().Format(time.RFC3339) _, err := w.Write([]byte(`{"time": "` + d + `", "level": "debug", "message": "Foobar", "foo": "bar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "12:00AM DBG Foobar foo=bar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Unix timestamp input format", func(t *testing.T) { of := zerolog.TimeFieldFormat defer func() { zerolog.TimeFieldFormat = of }() zerolog.TimeFieldFormat = zerolog.TimeFormatUnix buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, TimeFormat: time.StampMilli, NoColor: true} _, err := w.Write([]byte(`{"time": 1234, "level": "debug", "message": "Foobar", "foo": "bar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "Jan 1 00:20:34.000 DBG Foobar foo=bar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Unix timestamp ms input format", func(t *testing.T) { of := zerolog.TimeFieldFormat defer func() { zerolog.TimeFieldFormat = of }() zerolog.TimeFieldFormat = zerolog.TimeFormatUnixMs buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, TimeFormat: time.StampMilli, NoColor: true} _, err := w.Write([]byte(`{"time": 1234567, "level": "debug", "message": "Foobar", "foo": "bar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "Jan 1 00:20:34.567 DBG Foobar foo=bar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Unix timestamp us input format", func(t *testing.T) { of := zerolog.TimeFieldFormat defer func() { zerolog.TimeFieldFormat = of }() zerolog.TimeFieldFormat = zerolog.TimeFormatUnixMicro buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, TimeFormat: time.StampMicro, NoColor: true} _, err := w.Write([]byte(`{"time": 1234567891, "level": "debug", "message": "Foobar", "foo": "bar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "Jan 1 00:20:34.567891 DBG Foobar foo=bar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("No message field", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true} _, err := w.Write([]byte(`{"level": "debug", "foo": "bar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := " DBG foo=bar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("No level field", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true} _, err := w.Write([]byte(`{"message": "Foobar", "foo": "bar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := " ??? Foobar foo=bar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Write colorized fields", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: false} _, err := w.Write([]byte(`{"level": "warn", "message": "Foobar", "foo": "bar"}`)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "\x1b[90m\x1b[0m \x1b[31mWRN\x1b[0m Foobar \x1b[36mfoo=\x1b[0mbar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Write error field", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true} d := time.Unix(0, 0).UTC().Format(time.RFC3339) evt := `{"time": "` + d + `", "level": "error", "message": "Foobar", "aaa": "bbb", "error": "Error"}` // t.Log(evt) _, err := w.Write([]byte(evt)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "12:00AM ERR Foobar error=Error aaa=bbb\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Write caller field", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true} cwd, err := os.Getwd() if err != nil { t.Fatalf("Cannot get working directory: %s", err) } d := time.Unix(0, 0).UTC().Format(time.RFC3339) evt := `{"time": "` + d + `", "level": "debug", "message": "Foobar", "foo": "bar", "caller": "` + cwd + `/foo/bar.go"}` // t.Log(evt) _, err = w.Write([]byte(evt)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "12:00AM DBG foo/bar.go > Foobar foo=bar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Write JSON field", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true} evt := `{"level": "debug", "message": "Foobar", "foo": [1, 2, 3], "bar": true}` // t.Log(evt) _, err := w.Write([]byte(evt)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := " DBG Foobar bar=true foo=[1,2,3]\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) } func TestConsoleWriterConfiguration(t *testing.T) { t.Run("Sets TimeFormat", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true, TimeFormat: time.RFC3339} d := time.Unix(0, 0).UTC().Format(time.RFC3339) evt := `{"time": "` + d + `", "level": "info", "message": "Foobar"}` _, err := w.Write([]byte(evt)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "1970-01-01T00:00:00Z INF Foobar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Sets PartsOrder", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true, PartsOrder: []string{"message", "level"}} evt := `{"level": "info", "message": "Foobar"}` _, err := w.Write([]byte(evt)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "Foobar INF\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) t.Run("Sets PartsExclude", func(t *testing.T) { buf := &bytes.Buffer{} w := zerolog.ConsoleWriter{Out: buf, NoColor: true, PartsExclude: []string{"time"}} d := time.Unix(0, 0).UTC().Format(time.RFC3339) evt := `{"time": "` + d + `", "level": "info", "message": "Foobar"}` _, err := w.Write([]byte(evt)) if err != nil { t.Errorf("Unexpected error when writing output: %s", err) } expectedOutput := "INF Foobar\n" actualOutput := buf.String() if actualOutput != expectedOutput { t.Errorf("Unexpected output %q, want: %q", actualOutput, expectedOutput) } }) } func BenchmarkConsoleWriter(b *testing.B) { b.ResetTimer() b.ReportAllocs() var msg = []byte(`{"level": "info", "foo": "bar", "message": "HELLO", "time": "1990-01-01"}`) w := zerolog.ConsoleWriter{Out: ioutil.Discard, NoColor: false} for i := 0; i < b.N; i++ { w.Write(msg) } } zerolog-1.26.1/context.go000066400000000000000000000327761415647605600153320ustar00rootroot00000000000000package zerolog import ( "fmt" "io/ioutil" "math" "net" "time" ) // Context configures a new sub-logger with contextual fields. type Context struct { l Logger } // Logger returns the logger with the context previously set. func (c Context) Logger() Logger { return c.l } // 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. func (c Context) Fields(fields interface{}) Context { c.l.context = appendFields(c.l.context, fields) return c } // Dict adds the field key with the dict to the logger context. func (c Context) Dict(key string, dict *Event) Context { dict.buf = enc.AppendEndMarker(dict.buf) c.l.context = append(enc.AppendKey(c.l.context, key), dict.buf...) putEvent(dict) return c } // 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. func (c Context) Array(key string, arr LogArrayMarshaler) Context { c.l.context = enc.AppendKey(c.l.context, key) if arr, ok := arr.(*Array); ok { c.l.context = arr.write(c.l.context) return c } var a *Array if aa, ok := arr.(*Array); ok { a = aa } else { a = Arr() arr.MarshalZerologArray(a) } c.l.context = a.write(c.l.context) return c } // Object marshals an object that implement the LogObjectMarshaler interface. func (c Context) Object(key string, obj LogObjectMarshaler) Context { e := newEvent(levelWriterAdapter{ioutil.Discard}, 0) e.Object(key, obj) c.l.context = enc.AppendObjectData(c.l.context, e.buf) putEvent(e) return c } // EmbedObject marshals and Embeds an object that implement the LogObjectMarshaler interface. func (c Context) EmbedObject(obj LogObjectMarshaler) Context { e := newEvent(levelWriterAdapter{ioutil.Discard}, 0) e.EmbedObject(obj) c.l.context = enc.AppendObjectData(c.l.context, e.buf) putEvent(e) return c } // Str adds the field key with val as a string to the logger context. func (c Context) Str(key, val string) Context { c.l.context = enc.AppendString(enc.AppendKey(c.l.context, key), val) return c } // Strs adds the field key with val as a string to the logger context. func (c Context) Strs(key string, vals []string) Context { c.l.context = enc.AppendStrings(enc.AppendKey(c.l.context, key), vals) return c } // Stringer adds the field key with val.String() (or null if val is nil) to the logger context. func (c Context) Stringer(key string, val fmt.Stringer) Context { if val != nil { c.l.context = enc.AppendString(enc.AppendKey(c.l.context, key), val.String()) return c } c.l.context = enc.AppendInterface(enc.AppendKey(c.l.context, key), nil) return c } // Bytes adds the field key with val as a []byte to the logger context. func (c Context) Bytes(key string, val []byte) Context { c.l.context = enc.AppendBytes(enc.AppendKey(c.l.context, key), val) return c } // Hex adds the field key with val as a hex string to the logger context. func (c Context) Hex(key string, val []byte) Context { c.l.context = enc.AppendHex(enc.AppendKey(c.l.context, key), val) return c } // 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) RawJSON(key string, b []byte) Context { c.l.context = appendJSON(enc.AppendKey(c.l.context, key), b) return c } // AnErr adds the field key with serialized err to the logger context. func (c Context) AnErr(key string, err error) Context { switch m := ErrorMarshalFunc(err).(type) { case nil: return c case LogObjectMarshaler: return c.Object(key, m) case error: if m == nil || isNilValue(m) { return c } else { return c.Str(key, m.Error()) } case string: return c.Str(key, m) default: return c.Interface(key, m) } } // Errs adds the field key with errs as an array of serialized errors to the // logger context. func (c Context) Errs(key string, errs []error) Context { arr := Arr() for _, err := range errs { switch m := ErrorMarshalFunc(err).(type) { case LogObjectMarshaler: arr = arr.Object(m) case error: if m == nil || isNilValue(m) { arr = arr.Interface(nil) } else { arr = arr.Str(m.Error()) } case string: arr = arr.Str(m) default: arr = arr.Interface(m) } } return c.Array(key, arr) } // Err adds the field "error" with serialized err to the logger context. func (c Context) Err(err error) Context { return c.AnErr(ErrorFieldName, err) } // Bool adds the field key with val as a bool to the logger context. func (c Context) Bool(key string, b bool) Context { c.l.context = enc.AppendBool(enc.AppendKey(c.l.context, key), b) return c } // Bools adds the field key with val as a []bool to the logger context. func (c Context) Bools(key string, b []bool) Context { c.l.context = enc.AppendBools(enc.AppendKey(c.l.context, key), b) return c } // Int adds the field key with i as a int to the logger context. func (c Context) Int(key string, i int) Context { c.l.context = enc.AppendInt(enc.AppendKey(c.l.context, key), i) return c } // Ints adds the field key with i as a []int to the logger context. func (c Context) Ints(key string, i []int) Context { c.l.context = enc.AppendInts(enc.AppendKey(c.l.context, key), i) return c } // Int8 adds the field key with i as a int8 to the logger context. func (c Context) Int8(key string, i int8) Context { c.l.context = enc.AppendInt8(enc.AppendKey(c.l.context, key), i) return c } // Ints8 adds the field key with i as a []int8 to the logger context. func (c Context) Ints8(key string, i []int8) Context { c.l.context = enc.AppendInts8(enc.AppendKey(c.l.context, key), i) return c } // Int16 adds the field key with i as a int16 to the logger context. func (c Context) Int16(key string, i int16) Context { c.l.context = enc.AppendInt16(enc.AppendKey(c.l.context, key), i) return c } // Ints16 adds the field key with i as a []int16 to the logger context. func (c Context) Ints16(key string, i []int16) Context { c.l.context = enc.AppendInts16(enc.AppendKey(c.l.context, key), i) return c } // Int32 adds the field key with i as a int32 to the logger context. func (c Context) Int32(key string, i int32) Context { c.l.context = enc.AppendInt32(enc.AppendKey(c.l.context, key), i) return c } // Ints32 adds the field key with i as a []int32 to the logger context. func (c Context) Ints32(key string, i []int32) Context { c.l.context = enc.AppendInts32(enc.AppendKey(c.l.context, key), i) return c } // Int64 adds the field key with i as a int64 to the logger context. func (c Context) Int64(key string, i int64) Context { c.l.context = enc.AppendInt64(enc.AppendKey(c.l.context, key), i) return c } // Ints64 adds the field key with i as a []int64 to the logger context. func (c Context) Ints64(key string, i []int64) Context { c.l.context = enc.AppendInts64(enc.AppendKey(c.l.context, key), i) return c } // Uint adds the field key with i as a uint to the logger context. func (c Context) Uint(key string, i uint) Context { c.l.context = enc.AppendUint(enc.AppendKey(c.l.context, key), i) return c } // Uints adds the field key with i as a []uint to the logger context. func (c Context) Uints(key string, i []uint) Context { c.l.context = enc.AppendUints(enc.AppendKey(c.l.context, key), i) return c } // Uint8 adds the field key with i as a uint8 to the logger context. func (c Context) Uint8(key string, i uint8) Context { c.l.context = enc.AppendUint8(enc.AppendKey(c.l.context, key), i) return c } // Uints8 adds the field key with i as a []uint8 to the logger context. func (c Context) Uints8(key string, i []uint8) Context { c.l.context = enc.AppendUints8(enc.AppendKey(c.l.context, key), i) return c } // Uint16 adds the field key with i as a uint16 to the logger context. func (c Context) Uint16(key string, i uint16) Context { c.l.context = enc.AppendUint16(enc.AppendKey(c.l.context, key), i) return c } // Uints16 adds the field key with i as a []uint16 to the logger context. func (c Context) Uints16(key string, i []uint16) Context { c.l.context = enc.AppendUints16(enc.AppendKey(c.l.context, key), i) return c } // Uint32 adds the field key with i as a uint32 to the logger context. func (c Context) Uint32(key string, i uint32) Context { c.l.context = enc.AppendUint32(enc.AppendKey(c.l.context, key), i) return c } // Uints32 adds the field key with i as a []uint32 to the logger context. func (c Context) Uints32(key string, i []uint32) Context { c.l.context = enc.AppendUints32(enc.AppendKey(c.l.context, key), i) return c } // Uint64 adds the field key with i as a uint64 to the logger context. func (c Context) Uint64(key string, i uint64) Context { c.l.context = enc.AppendUint64(enc.AppendKey(c.l.context, key), i) return c } // Uints64 adds the field key with i as a []uint64 to the logger context. func (c Context) Uints64(key string, i []uint64) Context { c.l.context = enc.AppendUints64(enc.AppendKey(c.l.context, key), i) return c } // Float32 adds the field key with f as a float32 to the logger context. func (c Context) Float32(key string, f float32) Context { c.l.context = enc.AppendFloat32(enc.AppendKey(c.l.context, key), f) return c } // Floats32 adds the field key with f as a []float32 to the logger context. func (c Context) Floats32(key string, f []float32) Context { c.l.context = enc.AppendFloats32(enc.AppendKey(c.l.context, key), f) return c } // Float64 adds the field key with f as a float64 to the logger context. func (c Context) Float64(key string, f float64) Context { c.l.context = enc.AppendFloat64(enc.AppendKey(c.l.context, key), f) return c } // Floats64 adds the field key with f as a []float64 to the logger context. func (c Context) Floats64(key string, f []float64) Context { c.l.context = enc.AppendFloats64(enc.AppendKey(c.l.context, key), f) return c } type timestampHook struct{} func (ts timestampHook) Run(e *Event, level Level, msg string) { e.Timestamp() } var th = timestampHook{} // 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) Timestamp() Context { c.l = c.l.Hook(th) return c } // Time adds the field key with t formated as string using zerolog.TimeFieldFormat. func (c Context) Time(key string, t time.Time) Context { c.l.context = enc.AppendTime(enc.AppendKey(c.l.context, key), t, TimeFieldFormat) return c } // Times adds the field key with t formated as string using zerolog.TimeFieldFormat. func (c Context) Times(key string, t []time.Time) Context { c.l.context = enc.AppendTimes(enc.AppendKey(c.l.context, key), t, TimeFieldFormat) return c } // Dur adds the fields key with d divided by unit and stored as a float. func (c Context) Dur(key string, d time.Duration) Context { c.l.context = enc.AppendDuration(enc.AppendKey(c.l.context, key), d, DurationFieldUnit, DurationFieldInteger) return c } // Durs adds the fields key with d divided by unit and stored as a float. func (c Context) Durs(key string, d []time.Duration) Context { c.l.context = enc.AppendDurations(enc.AppendKey(c.l.context, key), d, DurationFieldUnit, DurationFieldInteger) return c } // Interface adds the field key with obj marshaled using reflection. func (c Context) Interface(key string, i interface{}) Context { c.l.context = enc.AppendInterface(enc.AppendKey(c.l.context, key), i) return c } type callerHook struct { callerSkipFrameCount int } func newCallerHook(skipFrameCount int) callerHook { return callerHook{callerSkipFrameCount: skipFrameCount} } func (ch callerHook) Run(e *Event, level Level, msg string) { switch ch.callerSkipFrameCount { case useGlobalSkipFrameCount: // Extra frames to skip (added by hook infra). e.caller(CallerSkipFrameCount + contextCallerSkipFrameCount) default: // Extra frames to skip (added by hook infra). e.caller(ch.callerSkipFrameCount + contextCallerSkipFrameCount) } } // useGlobalSkipFrameCount acts as a flag to informat callerHook.Run // to use the global CallerSkipFrameCount. const useGlobalSkipFrameCount = math.MinInt32 // ch is the default caller hook using the global CallerSkipFrameCount. var ch = newCallerHook(useGlobalSkipFrameCount) // Caller adds the file:line of the caller with the zerolog.CallerFieldName key. func (c Context) Caller() Context { c.l = c.l.Hook(ch) return c } // 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) CallerWithSkipFrameCount(skipFrameCount int) Context { c.l = c.l.Hook(newCallerHook(skipFrameCount)) return c } // Stack enables stack trace printing for the error passed to Err(). func (c Context) Stack() Context { c.l.stack = true return c } // IPAddr adds IPv4 or IPv6 Address to the context func (c Context) IPAddr(key string, ip net.IP) Context { c.l.context = enc.AppendIPAddr(enc.AppendKey(c.l.context, key), ip) return c } // IPPrefix adds IPv4 or IPv6 Prefix (address and mask) to the context func (c Context) IPPrefix(key string, pfx net.IPNet) Context { c.l.context = enc.AppendIPPrefix(enc.AppendKey(c.l.context, key), pfx) return c } // MACAddr adds MAC address to the context func (c Context) MACAddr(key string, ha net.HardwareAddr) Context { c.l.context = enc.AppendMACAddr(enc.AppendKey(c.l.context, key), ha) return c } zerolog-1.26.1/ctx.go000066400000000000000000000023521415647605600144270ustar00rootroot00000000000000package zerolog import ( "context" ) var disabledLogger *Logger func init() { SetGlobalLevel(TraceLevel) l := Nop() disabledLogger = &l } type ctxKey struct{} // 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) WithContext(ctx context.Context) context.Context { if lp, ok := ctx.Value(ctxKey{}).(*Logger); ok { if lp == l { // Do not store same logger. return ctx } } else if l.level == Disabled { // Do not store disabled logger. return ctx } return context.WithValue(ctx, ctxKey{}, l) } // 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 Ctx(ctx context.Context) *Logger { if l, ok := ctx.Value(ctxKey{}).(*Logger); ok { return l } else if l = DefaultContextLogger; l != nil { return l } return disabledLogger } zerolog-1.26.1/ctx_test.go000066400000000000000000000030541415647605600154660ustar00rootroot00000000000000package zerolog import ( "context" "io/ioutil" "reflect" "testing" ) func TestCtx(t *testing.T) { log := New(ioutil.Discard) ctx := log.WithContext(context.Background()) log2 := Ctx(ctx) if !reflect.DeepEqual(log, *log2) { t.Error("Ctx did not return the expected logger") } // update log = log.Level(InfoLevel) ctx = log.WithContext(ctx) log2 = Ctx(ctx) if !reflect.DeepEqual(log, *log2) { t.Error("Ctx did not return the expected logger") } log2 = Ctx(context.Background()) if log2 != disabledLogger { t.Error("Ctx did not return the expected logger") } DefaultContextLogger = &log t.Cleanup(func() { DefaultContextLogger = nil }) log2 = Ctx(context.Background()) if log2 != &log { t.Error("Ctx did not return the expected logger") } } func TestCtxDisabled(t *testing.T) { dl := New(ioutil.Discard).Level(Disabled) ctx := dl.WithContext(context.Background()) if ctx != context.Background() { t.Error("WithContext stored a disabled logger") } l := New(ioutil.Discard).With().Str("foo", "bar").Logger() ctx = l.WithContext(ctx) if Ctx(ctx) != &l { t.Error("WithContext did not store logger") } l.UpdateContext(func(c Context) Context { return c.Str("bar", "baz") }) ctx = l.WithContext(ctx) if Ctx(ctx) != &l { t.Error("WithContext did not store updated logger") } l = l.Level(DebugLevel) ctx = l.WithContext(ctx) if Ctx(ctx) != &l { t.Error("WithContext did not store copied logger") } ctx = dl.WithContext(ctx) if Ctx(ctx) != &dl { t.Error("WithContext did not overide logger with a disabled logger") } } zerolog-1.26.1/diode/000077500000000000000000000000001415647605600143645ustar00rootroot00000000000000zerolog-1.26.1/diode/diode.go000066400000000000000000000051651415647605600160060ustar00rootroot00000000000000// Package diode provides a thread-safe, lock-free, non-blocking io.Writer // wrapper. package diode import ( "context" "io" "sync" "time" "github.com/rs/zerolog/diode/internal/diodes" ) var bufPool = &sync.Pool{ New: func() interface{} { return make([]byte, 0, 500) }, } type Alerter func(missed int) type diodeFetcher interface { diodes.Diode Next() diodes.GenericDataType } // Writer is a io.Writer wrapper that uses a diode to make Write lock-free, // non-blocking and thread safe. type Writer struct { w io.Writer d diodeFetcher c context.CancelFunc done chan struct{} } // NewWriter creates a writer wrapping w with a many-to-one diode in order to // never block log producers and drop events if the writer can't keep up with // the flow of data. // // Use a diode.Writer when // // wr := diode.NewWriter(w, 1000, 0, func(missed int) { // log.Printf("Dropped %d messages", missed) // }) // log := zerolog.New(wr) // // If pollInterval is greater than 0, a poller is used otherwise a waiter is // used. // // See code.cloudfoundry.org/go-diodes for more info on diode. func NewWriter(w io.Writer, size int, pollInterval time.Duration, f Alerter) Writer { ctx, cancel := context.WithCancel(context.Background()) dw := Writer{ w: w, c: cancel, done: make(chan struct{}), } if f == nil { f = func(int) {} } d := diodes.NewManyToOne(size, diodes.AlertFunc(f)) if pollInterval > 0 { dw.d = diodes.NewPoller(d, diodes.WithPollingInterval(pollInterval), diodes.WithPollingContext(ctx)) } else { dw.d = diodes.NewWaiter(d, diodes.WithWaiterContext(ctx)) } go dw.poll() return dw } func (dw Writer) Write(p []byte) (n int, err error) { // p is pooled in zerolog so we can't hold it passed this call, hence the // copy. p = append(bufPool.Get().([]byte), p...) dw.d.Set(diodes.GenericDataType(&p)) return len(p), nil } // Close releases the diode poller and call Close on the wrapped writer if // io.Closer is implemented. func (dw Writer) Close() error { dw.c() <-dw.done if w, ok := dw.w.(io.Closer); ok { return w.Close() } return nil } func (dw Writer) poll() { defer close(dw.done) for { d := dw.d.Next() if d == nil { return } p := *(*[]byte)(d) dw.w.Write(p) // Proper usage of a sync.Pool requires each entry to have approximately // the same memory cost. To obtain this property when the stored type // contains a variably-sized buffer, we add a hard limit on the maximum buffer // to place back in the pool. // // See https://golang.org/issue/23199 const maxSize = 1 << 16 // 64KiB if cap(p) <= maxSize { bufPool.Put(p[:0]) } } } zerolog-1.26.1/diode/diode_example_test.go000066400000000000000000000005561415647605600205570ustar00rootroot00000000000000// +build !binary_log package diode_test import ( "fmt" "os" "github.com/rs/zerolog" "github.com/rs/zerolog/diode" ) func ExampleNewWriter() { w := diode.NewWriter(os.Stdout, 1000, 0, func(missed int) { fmt.Printf("Dropped %d messages\n", missed) }) log := zerolog.New(w) log.Print("test") w.Close() // Output: {"level":"debug","message":"test"} } zerolog-1.26.1/diode/diode_test.go000066400000000000000000000021201415647605600170310ustar00rootroot00000000000000package diode_test import ( "bytes" "fmt" "io/ioutil" "log" "os" "testing" "time" "github.com/rs/zerolog" "github.com/rs/zerolog/diode" "github.com/rs/zerolog/internal/cbor" ) func TestNewWriter(t *testing.T) { buf := bytes.Buffer{} w := diode.NewWriter(&buf, 1000, 0, func(missed int) { fmt.Printf("Dropped %d messages\n", missed) }) log := zerolog.New(w) log.Print("test") w.Close() want := "{\"level\":\"debug\",\"message\":\"test\"}\n" got := cbor.DecodeIfBinaryToString(buf.Bytes()) if got != want { t.Errorf("Diode New Writer Test failed. got:%s, want:%s!", got, want) } } func Benchmark(b *testing.B) { log.SetOutput(ioutil.Discard) defer log.SetOutput(os.Stderr) benchs := map[string]time.Duration{ "Waiter": 0, "Pooler": 10 * time.Millisecond, } for name, interval := range benchs { b.Run(name, func(b *testing.B) { w := diode.NewWriter(ioutil.Discard, 100000, interval, nil) log := zerolog.New(w) defer w.Close() b.SetParallelism(1000) b.RunParallel(func(pb *testing.PB) { for pb.Next() { log.Print("test") } }) }) } } zerolog-1.26.1/diode/internal/000077500000000000000000000000001415647605600162005ustar00rootroot00000000000000zerolog-1.26.1/diode/internal/diodes/000077500000000000000000000000001415647605600174475ustar00rootroot00000000000000zerolog-1.26.1/diode/internal/diodes/README000066400000000000000000000001221415647605600203220ustar00rootroot00000000000000Copied from https://github.com/cloudfoundry/go-diodes to avoid test dependencies. zerolog-1.26.1/diode/internal/diodes/many_to_one.go000066400000000000000000000101751415647605600223110ustar00rootroot00000000000000package diodes import ( "log" "sync/atomic" "unsafe" ) // ManyToOne diode is optimal for many writers (go-routines B-n) and a single // reader (go-routine A). It is not thread safe for multiple readers. type ManyToOne struct { writeIndex uint64 readIndex uint64 buffer []unsafe.Pointer alerter Alerter } // NewManyToOne creates a new diode (ring buffer). The ManyToOne diode // is optimzed for many writers (on go-routines B-n) and a single reader // (on go-routine A). The alerter is invoked on the read's go-routine. It is // called when it notices that the writer go-routine has passed it and wrote // over data. A nil can be used to ignore alerts. func NewManyToOne(size int, alerter Alerter) *ManyToOne { if alerter == nil { alerter = AlertFunc(func(int) {}) } d := &ManyToOne{ buffer: make([]unsafe.Pointer, size), alerter: alerter, } // Start write index at the value before 0 // to allow the first write to use AddUint64 // and still have a beginning index of 0 d.writeIndex = ^d.writeIndex return d } // Set sets the data in the next slot of the ring buffer. func (d *ManyToOne) Set(data GenericDataType) { for { writeIndex := atomic.AddUint64(&d.writeIndex, 1) idx := writeIndex % uint64(len(d.buffer)) old := atomic.LoadPointer(&d.buffer[idx]) if old != nil && (*bucket)(old) != nil && (*bucket)(old).seq > writeIndex-uint64(len(d.buffer)) { log.Println("Diode set collision: consider using a larger diode") continue } newBucket := &bucket{ data: data, seq: writeIndex, } if !atomic.CompareAndSwapPointer(&d.buffer[idx], old, unsafe.Pointer(newBucket)) { log.Println("Diode set collision: consider using a larger diode") continue } return } } // TryNext will attempt to read from the next slot of the ring buffer. // If there is not data available, it will return (nil, false). func (d *ManyToOne) TryNext() (data GenericDataType, ok bool) { // Read a value from the ring buffer based on the readIndex. idx := d.readIndex % uint64(len(d.buffer)) result := (*bucket)(atomic.SwapPointer(&d.buffer[idx], nil)) // When the result is nil that means the writer has not had the // opportunity to write a value into the diode. This value must be ignored // and the read head must not increment. if result == nil { return nil, false } // When the seq value is less than the current read index that means a // value was read from idx that was previously written but has since has // been dropped. This value must be ignored and the read head must not // increment. // // The simulation for this scenario assumes the fast forward occurred as // detailed below. // // 5. The reader reads again getting seq 5. It then reads again expecting // seq 6 but gets seq 2. This is a read of a stale value that was // effectively "dropped" so the read fails and the read head stays put. // `| 4 | 5 | 2 | 3 |` r: 7, w: 6 // if result.seq < d.readIndex { return nil, false } // When the seq value is greater than the current read index that means a // value was read from idx that overwrote the value that was expected to // be at this idx. This happens when the writer has lapped the reader. The // reader needs to catch up to the writer so it moves its write head to // the new seq, effectively dropping the messages that were not read in // between the two values. // // Here is a simulation of this scenario: // // 1. Both the read and write heads start at 0. // `| nil | nil | nil | nil |` r: 0, w: 0 // 2. The writer fills the buffer. // `| 0 | 1 | 2 | 3 |` r: 0, w: 4 // 3. The writer laps the read head. // `| 4 | 5 | 2 | 3 |` r: 0, w: 6 // 4. The reader reads the first value, expecting a seq of 0 but reads 4, // this forces the reader to fast forward to 5. // `| 4 | 5 | 2 | 3 |` r: 5, w: 6 // if result.seq > d.readIndex { dropped := result.seq - d.readIndex d.readIndex = result.seq d.alerter.Alert(int(dropped)) } // Only increment read index if a regular read occurred (where seq was // equal to readIndex) or a value was read that caused a fast forward // (where seq was greater than readIndex). // d.readIndex++ return result.data, true } zerolog-1.26.1/diode/internal/diodes/one_to_one.go000066400000000000000000000077731415647605600221400ustar00rootroot00000000000000package diodes import ( "sync/atomic" "unsafe" ) // GenericDataType is the data type the diodes operate on. type GenericDataType unsafe.Pointer // Alerter is used to report how many values were overwritten since the // last write. type Alerter interface { Alert(missed int) } // AlertFunc type is an adapter to allow the use of ordinary functions as // Alert handlers. type AlertFunc func(missed int) // Alert calls f(missed) func (f AlertFunc) Alert(missed int) { f(missed) } type bucket struct { data GenericDataType seq uint64 // seq is the recorded write index at the time of writing } // OneToOne diode is meant to be used by a single reader and a single writer. // It is not thread safe if used otherwise. type OneToOne struct { writeIndex uint64 readIndex uint64 buffer []unsafe.Pointer alerter Alerter } // NewOneToOne creates a new diode is meant to be used by a single reader and // a single writer. The alerter is invoked on the read's go-routine. It is // called when it notices that the writer go-routine has passed it and wrote // over data. A nil can be used to ignore alerts. func NewOneToOne(size int, alerter Alerter) *OneToOne { if alerter == nil { alerter = AlertFunc(func(int) {}) } return &OneToOne{ buffer: make([]unsafe.Pointer, size), alerter: alerter, } } // Set sets the data in the next slot of the ring buffer. func (d *OneToOne) Set(data GenericDataType) { idx := d.writeIndex % uint64(len(d.buffer)) newBucket := &bucket{ data: data, seq: d.writeIndex, } d.writeIndex++ atomic.StorePointer(&d.buffer[idx], unsafe.Pointer(newBucket)) } // TryNext will attempt to read from the next slot of the ring buffer. // If there is no data available, it will return (nil, false). func (d *OneToOne) TryNext() (data GenericDataType, ok bool) { // Read a value from the ring buffer based on the readIndex. idx := d.readIndex % uint64(len(d.buffer)) result := (*bucket)(atomic.SwapPointer(&d.buffer[idx], nil)) // When the result is nil that means the writer has not had the // opportunity to write a value into the diode. This value must be ignored // and the read head must not increment. if result == nil { return nil, false } // When the seq value is less than the current read index that means a // value was read from idx that was previously written but has since has // been dropped. This value must be ignored and the read head must not // increment. // // The simulation for this scenario assumes the fast forward occurred as // detailed below. // // 5. The reader reads again getting seq 5. It then reads again expecting // seq 6 but gets seq 2. This is a read of a stale value that was // effectively "dropped" so the read fails and the read head stays put. // `| 4 | 5 | 2 | 3 |` r: 7, w: 6 // if result.seq < d.readIndex { return nil, false } // When the seq value is greater than the current read index that means a // value was read from idx that overwrote the value that was expected to // be at this idx. This happens when the writer has lapped the reader. The // reader needs to catch up to the writer so it moves its write head to // the new seq, effectively dropping the messages that were not read in // between the two values. // // Here is a simulation of this scenario: // // 1. Both the read and write heads start at 0. // `| nil | nil | nil | nil |` r: 0, w: 0 // 2. The writer fills the buffer. // `| 0 | 1 | 2 | 3 |` r: 0, w: 4 // 3. The writer laps the read head. // `| 4 | 5 | 2 | 3 |` r: 0, w: 6 // 4. The reader reads the first value, expecting a seq of 0 but reads 4, // this forces the reader to fast forward to 5. // `| 4 | 5 | 2 | 3 |` r: 5, w: 6 // if result.seq > d.readIndex { dropped := result.seq - d.readIndex d.readIndex = result.seq d.alerter.Alert(int(dropped)) } // Only increment read index if a regular read occurred (where seq was // equal to readIndex) or a value was read that caused a fast forward // (where seq was greater than readIndex). d.readIndex++ return result.data, true } zerolog-1.26.1/diode/internal/diodes/poller.go000066400000000000000000000032071415647605600212750ustar00rootroot00000000000000package diodes import ( "context" "time" ) // Diode is any implementation of a diode. type Diode interface { Set(GenericDataType) TryNext() (GenericDataType, bool) } // Poller will poll a diode until a value is available. type Poller struct { Diode interval time.Duration ctx context.Context } // PollerConfigOption can be used to setup the poller. type PollerConfigOption func(*Poller) // WithPollingInterval sets the interval at which the diode is queried // for new data. The default is 10ms. func WithPollingInterval(interval time.Duration) PollerConfigOption { return PollerConfigOption(func(c *Poller) { c.interval = interval }) } // WithPollingContext sets the context to cancel any retrieval (Next()). It // will not change any results for adding data (Set()). Default is // context.Background(). func WithPollingContext(ctx context.Context) PollerConfigOption { return PollerConfigOption(func(c *Poller) { c.ctx = ctx }) } // NewPoller returns a new Poller that wraps the given diode. func NewPoller(d Diode, opts ...PollerConfigOption) *Poller { p := &Poller{ Diode: d, interval: 10 * time.Millisecond, ctx: context.Background(), } for _, o := range opts { o(p) } return p } // Next polls the diode until data is available or until the context is done. // If the context is done, then nil will be returned. func (p *Poller) Next() GenericDataType { for { data, ok := p.Diode.TryNext() if !ok { if p.isDone() { return nil } time.Sleep(p.interval) continue } return data } } func (p *Poller) isDone() bool { select { case <-p.ctx.Done(): return true default: return false } } zerolog-1.26.1/diode/internal/diodes/waiter.go000066400000000000000000000031661415647605600212770ustar00rootroot00000000000000package diodes import ( "context" "sync" ) // Waiter will use a conditional mutex to alert the reader to when data is // available. type Waiter struct { Diode mu sync.Mutex c *sync.Cond ctx context.Context } // WaiterConfigOption can be used to setup the waiter. type WaiterConfigOption func(*Waiter) // WithWaiterContext sets the context to cancel any retrieval (Next()). It // will not change any results for adding data (Set()). Default is // context.Background(). func WithWaiterContext(ctx context.Context) WaiterConfigOption { return WaiterConfigOption(func(c *Waiter) { c.ctx = ctx }) } // NewWaiter returns a new Waiter that wraps the given diode. func NewWaiter(d Diode, opts ...WaiterConfigOption) *Waiter { w := new(Waiter) w.Diode = d w.c = sync.NewCond(&w.mu) w.ctx = context.Background() for _, opt := range opts { opt(w) } go func() { <-w.ctx.Done() w.c.Broadcast() }() return w } // Set invokes the wrapped diode's Set with the given data and uses Broadcast // to wake up any readers. func (w *Waiter) Set(data GenericDataType) { w.Diode.Set(data) w.c.Broadcast() } // Next returns the next data point on the wrapped diode. If there is not any // new data, it will Wait for set to be called or the context to be done. // If the context is done, then nil will be returned. func (w *Waiter) Next() GenericDataType { w.mu.Lock() defer w.mu.Unlock() for { data, ok := w.Diode.TryNext() if !ok { if w.isDone() { return nil } w.c.Wait() continue } return data } } func (w *Waiter) isDone() bool { select { case <-w.ctx.Done(): return true default: return false } } zerolog-1.26.1/encoder.go000066400000000000000000000043071415647605600152520ustar00rootroot00000000000000package zerolog import ( "net" "time" ) type encoder interface { AppendArrayDelim(dst []byte) []byte AppendArrayEnd(dst []byte) []byte AppendArrayStart(dst []byte) []byte AppendBeginMarker(dst []byte) []byte AppendBool(dst []byte, val bool) []byte AppendBools(dst []byte, vals []bool) []byte AppendBytes(dst, s []byte) []byte AppendDuration(dst []byte, d time.Duration, unit time.Duration, useInt bool) []byte AppendDurations(dst []byte, vals []time.Duration, unit time.Duration, useInt bool) []byte AppendEndMarker(dst []byte) []byte AppendFloat32(dst []byte, val float32) []byte AppendFloat64(dst []byte, val float64) []byte AppendFloats32(dst []byte, vals []float32) []byte AppendFloats64(dst []byte, vals []float64) []byte AppendHex(dst, s []byte) []byte AppendIPAddr(dst []byte, ip net.IP) []byte AppendIPPrefix(dst []byte, pfx net.IPNet) []byte AppendInt(dst []byte, val int) []byte AppendInt16(dst []byte, val int16) []byte AppendInt32(dst []byte, val int32) []byte AppendInt64(dst []byte, val int64) []byte AppendInt8(dst []byte, val int8) []byte AppendInterface(dst []byte, i interface{}) []byte AppendInts(dst []byte, vals []int) []byte AppendInts16(dst []byte, vals []int16) []byte AppendInts32(dst []byte, vals []int32) []byte AppendInts64(dst []byte, vals []int64) []byte AppendInts8(dst []byte, vals []int8) []byte AppendKey(dst []byte, key string) []byte AppendLineBreak(dst []byte) []byte AppendMACAddr(dst []byte, ha net.HardwareAddr) []byte AppendNil(dst []byte) []byte AppendObjectData(dst []byte, o []byte) []byte AppendString(dst []byte, s string) []byte AppendStrings(dst []byte, vals []string) []byte AppendTime(dst []byte, t time.Time, format string) []byte AppendTimes(dst []byte, vals []time.Time, format string) []byte AppendUint(dst []byte, val uint) []byte AppendUint16(dst []byte, val uint16) []byte AppendUint32(dst []byte, val uint32) []byte AppendUint64(dst []byte, val uint64) []byte AppendUint8(dst []byte, val uint8) []byte AppendUints(dst []byte, vals []uint) []byte AppendUints16(dst []byte, vals []uint16) []byte AppendUints32(dst []byte, vals []uint32) []byte AppendUints64(dst []byte, vals []uint64) []byte AppendUints8(dst []byte, vals []uint8) []byte } zerolog-1.26.1/encoder_cbor.go000066400000000000000000000016551415647605600162620ustar00rootroot00000000000000// +build binary_log package zerolog // This file contains bindings to do binary encoding. import ( "github.com/rs/zerolog/internal/cbor" ) var ( _ encoder = (*cbor.Encoder)(nil) enc = cbor.Encoder{} ) func init() { // using closure to reflect the changes at runtime. cbor.JSONMarshalFunc = func(v interface{}) ([]byte, error) { return InterfaceMarshalFunc(v) } } func appendJSON(dst []byte, j []byte) []byte { return cbor.AppendEmbeddedJSON(dst, j) } // decodeIfBinaryToString - converts a binary formatted log msg to a // JSON formatted String Log message. func decodeIfBinaryToString(in []byte) string { return cbor.DecodeIfBinaryToString(in) } func decodeObjectToStr(in []byte) string { return cbor.DecodeObjectToStr(in) } // decodeIfBinaryToBytes - converts a binary formatted log msg to a // JSON formatted Bytes Log message. func decodeIfBinaryToBytes(in []byte) []byte { return cbor.DecodeIfBinaryToBytes(in) } zerolog-1.26.1/encoder_json.go000066400000000000000000000012501415647605600162750ustar00rootroot00000000000000// +build !binary_log package zerolog // encoder_json.go file contains bindings to generate // JSON encoded byte stream. import ( "github.com/rs/zerolog/internal/json" ) var ( _ encoder = (*json.Encoder)(nil) enc = json.Encoder{} ) func init() { // using closure to reflect the changes at runtime. json.JSONMarshalFunc = func(v interface{}) ([]byte, error) { return InterfaceMarshalFunc(v) } } func appendJSON(dst []byte, j []byte) []byte { return append(dst, j...) } func decodeIfBinaryToString(in []byte) string { return string(in) } func decodeObjectToStr(in []byte) string { return string(in) } func decodeIfBinaryToBytes(in []byte) []byte { return in } zerolog-1.26.1/event.go000066400000000000000000000457541415647605600147670ustar00rootroot00000000000000package zerolog import ( "fmt" "net" "os" "runtime" "sync" "time" ) var eventPool = &sync.Pool{ New: func() interface{} { return &Event{ buf: make([]byte, 0, 500), } }, } // 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 { buf []byte w LevelWriter level Level done func(msg string) stack bool // enable error stack trace ch []Hook // hooks from context skipFrame int // The number of additional frames to skip when printing the caller. } func putEvent(e *Event) { // Proper usage of a sync.Pool requires each entry to have approximately // the same memory cost. To obtain this property when the stored type // contains a variably-sized buffer, we add a hard limit on the maximum buffer // to place back in the pool. // // See https://golang.org/issue/23199 const maxSize = 1 << 16 // 64KiB if cap(e.buf) > maxSize { return } eventPool.Put(e) } // 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) } // 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) } func newEvent(w LevelWriter, level Level) *Event { e := eventPool.Get().(*Event) e.buf = e.buf[:0] e.ch = nil e.buf = enc.AppendBeginMarker(e.buf) e.w = w e.level = level e.stack = false e.skipFrame = 0 return e } func (e *Event) write() (err error) { if e == nil { return nil } if e.level != Disabled { e.buf = enc.AppendEndMarker(e.buf) e.buf = enc.AppendLineBreak(e.buf) if e.w != nil { _, err = e.w.WriteLevel(e.level, e.buf) } } putEvent(e) return } // Enabled return false if the *Event is going to be filtered out by // log level or sampling. func (e *Event) Enabled() bool { return e != nil && e.level != Disabled } // Discard disables the event so Msg(f) won't print it. func (e *Event) Discard() *Event { if e == nil { return e } e.level = Disabled return nil } // 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) Msg(msg string) { if e == nil { return } e.msg(msg) } // Send is equivalent to calling Msg(""). // // NOTICE: once this method is called, the *Event should be disposed. func (e *Event) Send() { if e == nil { return } e.msg("") } // 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) Msgf(format string, v ...interface{}) { if e == nil { return } e.msg(fmt.Sprintf(format, v...)) } func (e *Event) msg(msg string) { for _, hook := range e.ch { hook.Run(e, e.level, msg) } if msg != "" { e.buf = enc.AppendString(enc.AppendKey(e.buf, MessageFieldName), msg) } if e.done != nil { defer e.done(msg) } if err := e.write(); err != nil { if ErrorHandler != nil { ErrorHandler(err) } else { fmt.Fprintf(os.Stderr, "zerolog: could not write event: %v\n", err) } } } // 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. func (e *Event) Fields(fields interface{}) *Event { if e == nil { return e } e.buf = appendFields(e.buf, fields) return e } // Dict adds the field key with a dict to the event context. // Use zerolog.Dict() to create the dictionary. func (e *Event) Dict(key string, dict *Event) *Event { if e == nil { return e } dict.buf = enc.AppendEndMarker(dict.buf) e.buf = append(enc.AppendKey(e.buf, key), dict.buf...) putEvent(dict) return e } // 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 Dict() *Event { return newEvent(nil, 0) } // 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. func (e *Event) Array(key string, arr LogArrayMarshaler) *Event { if e == nil { return e } e.buf = enc.AppendKey(e.buf, key) var a *Array if aa, ok := arr.(*Array); ok { a = aa } else { a = Arr() arr.MarshalZerologArray(a) } e.buf = a.write(e.buf) return e } func (e *Event) appendObject(obj LogObjectMarshaler) { e.buf = enc.AppendBeginMarker(e.buf) obj.MarshalZerologObject(e) e.buf = enc.AppendEndMarker(e.buf) } // Object marshals an object that implement the LogObjectMarshaler interface. func (e *Event) Object(key string, obj LogObjectMarshaler) *Event { if e == nil { return e } e.buf = enc.AppendKey(e.buf, key) if obj == nil { e.buf = enc.AppendNil(e.buf) return e } e.appendObject(obj) return e } // Func allows an anonymous func to run only if the event is enabled. func (e *Event) Func(f func(e *Event)) *Event { if e != nil && e.Enabled() { f(e) } return e } // EmbedObject marshals an object that implement the LogObjectMarshaler interface. func (e *Event) EmbedObject(obj LogObjectMarshaler) *Event { if e == nil { return e } if obj == nil { return e } obj.MarshalZerologObject(e) return e } // Str adds the field key with val as a string to the *Event context. func (e *Event) Str(key, val string) *Event { if e == nil { return e } e.buf = enc.AppendString(enc.AppendKey(e.buf, key), val) return e } // Strs adds the field key with vals as a []string to the *Event context. func (e *Event) Strs(key string, vals []string) *Event { if e == nil { return e } e.buf = enc.AppendStrings(enc.AppendKey(e.buf, key), vals) return e } // Stringer adds the field key with val.String() (or null if val is nil) // to the *Event context. func (e *Event) Stringer(key string, val fmt.Stringer) *Event { if e == nil { return e } e.buf = enc.AppendStringer(enc.AppendKey(e.buf, key), val) return e } // 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) Stringers(key string, vals []fmt.Stringer) *Event { if e == nil { return e } e.buf = enc.AppendStringers(enc.AppendKey(e.buf, key), vals) return e } // 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) Bytes(key string, val []byte) *Event { if e == nil { return e } e.buf = enc.AppendBytes(enc.AppendKey(e.buf, key), val) return e } // Hex adds the field key with val as a hex string to the *Event context. func (e *Event) Hex(key string, val []byte) *Event { if e == nil { return e } e.buf = enc.AppendHex(enc.AppendKey(e.buf, key), val) return e } // 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) RawJSON(key string, b []byte) *Event { if e == nil { return e } e.buf = appendJSON(enc.AppendKey(e.buf, key), b) return e } // AnErr adds the field key with serialized err to the *Event context. // If err is nil, no field is added. func (e *Event) AnErr(key string, err error) *Event { if e == nil { return e } switch m := ErrorMarshalFunc(err).(type) { case nil: return e case LogObjectMarshaler: return e.Object(key, m) case error: if m == nil || isNilValue(m) { return e } else { return e.Str(key, m.Error()) } case string: return e.Str(key, m) default: return e.Interface(key, m) } } // Errs adds the field key with errs as an array of serialized errors to the // *Event context. func (e *Event) Errs(key string, errs []error) *Event { if e == nil { return e } arr := Arr() for _, err := range errs { switch m := ErrorMarshalFunc(err).(type) { case LogObjectMarshaler: arr = arr.Object(m) case error: arr = arr.Err(m) case string: arr = arr.Str(m) default: arr = arr.Interface(m) } } return e.Array(key, arr) } // 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) Err(err error) *Event { if e == nil { return e } if e.stack && ErrorStackMarshaler != nil { switch m := ErrorStackMarshaler(err).(type) { case nil: case LogObjectMarshaler: e.Object(ErrorStackFieldName, m) case error: if m != nil && !isNilValue(m) { e.Str(ErrorStackFieldName, m.Error()) } case string: e.Str(ErrorStackFieldName, m) default: e.Interface(ErrorStackFieldName, m) } } return e.AnErr(ErrorFieldName, err) } // Stack enables stack trace printing for the error passed to Err(). // // ErrorStackMarshaler must be set for this method to do something. func (e *Event) Stack() *Event { if e != nil { e.stack = true } return e } // Bool adds the field key with val as a bool to the *Event context. func (e *Event) Bool(key string, b bool) *Event { if e == nil { return e } e.buf = enc.AppendBool(enc.AppendKey(e.buf, key), b) return e } // Bools adds the field key with val as a []bool to the *Event context. func (e *Event) Bools(key string, b []bool) *Event { if e == nil { return e } e.buf = enc.AppendBools(enc.AppendKey(e.buf, key), b) return e } // Int adds the field key with i as a int to the *Event context. func (e *Event) Int(key string, i int) *Event { if e == nil { return e } e.buf = enc.AppendInt(enc.AppendKey(e.buf, key), i) return e } // Ints adds the field key with i as a []int to the *Event context. func (e *Event) Ints(key string, i []int) *Event { if e == nil { return e } e.buf = enc.AppendInts(enc.AppendKey(e.buf, key), i) return e } // Int8 adds the field key with i as a int8 to the *Event context. func (e *Event) Int8(key string, i int8) *Event { if e == nil { return e } e.buf = enc.AppendInt8(enc.AppendKey(e.buf, key), i) return e } // Ints8 adds the field key with i as a []int8 to the *Event context. func (e *Event) Ints8(key string, i []int8) *Event { if e == nil { return e } e.buf = enc.AppendInts8(enc.AppendKey(e.buf, key), i) return e } // Int16 adds the field key with i as a int16 to the *Event context. func (e *Event) Int16(key string, i int16) *Event { if e == nil { return e } e.buf = enc.AppendInt16(enc.AppendKey(e.buf, key), i) return e } // Ints16 adds the field key with i as a []int16 to the *Event context. func (e *Event) Ints16(key string, i []int16) *Event { if e == nil { return e } e.buf = enc.AppendInts16(enc.AppendKey(e.buf, key), i) return e } // Int32 adds the field key with i as a int32 to the *Event context. func (e *Event) Int32(key string, i int32) *Event { if e == nil { return e } e.buf = enc.AppendInt32(enc.AppendKey(e.buf, key), i) return e } // Ints32 adds the field key with i as a []int32 to the *Event context. func (e *Event) Ints32(key string, i []int32) *Event { if e == nil { return e } e.buf = enc.AppendInts32(enc.AppendKey(e.buf, key), i) return e } // Int64 adds the field key with i as a int64 to the *Event context. func (e *Event) Int64(key string, i int64) *Event { if e == nil { return e } e.buf = enc.AppendInt64(enc.AppendKey(e.buf, key), i) return e } // Ints64 adds the field key with i as a []int64 to the *Event context. func (e *Event) Ints64(key string, i []int64) *Event { if e == nil { return e } e.buf = enc.AppendInts64(enc.AppendKey(e.buf, key), i) return e } // Uint adds the field key with i as a uint to the *Event context. func (e *Event) Uint(key string, i uint) *Event { if e == nil { return e } e.buf = enc.AppendUint(enc.AppendKey(e.buf, key), i) return e } // Uints adds the field key with i as a []int to the *Event context. func (e *Event) Uints(key string, i []uint) *Event { if e == nil { return e } e.buf = enc.AppendUints(enc.AppendKey(e.buf, key), i) return e } // Uint8 adds the field key with i as a uint8 to the *Event context. func (e *Event) Uint8(key string, i uint8) *Event { if e == nil { return e } e.buf = enc.AppendUint8(enc.AppendKey(e.buf, key), i) return e } // Uints8 adds the field key with i as a []int8 to the *Event context. func (e *Event) Uints8(key string, i []uint8) *Event { if e == nil { return e } e.buf = enc.AppendUints8(enc.AppendKey(e.buf, key), i) return e } // Uint16 adds the field key with i as a uint16 to the *Event context. func (e *Event) Uint16(key string, i uint16) *Event { if e == nil { return e } e.buf = enc.AppendUint16(enc.AppendKey(e.buf, key), i) return e } // Uints16 adds the field key with i as a []int16 to the *Event context. func (e *Event) Uints16(key string, i []uint16) *Event { if e == nil { return e } e.buf = enc.AppendUints16(enc.AppendKey(e.buf, key), i) return e } // Uint32 adds the field key with i as a uint32 to the *Event context. func (e *Event) Uint32(key string, i uint32) *Event { if e == nil { return e } e.buf = enc.AppendUint32(enc.AppendKey(e.buf, key), i) return e } // Uints32 adds the field key with i as a []int32 to the *Event context. func (e *Event) Uints32(key string, i []uint32) *Event { if e == nil { return e } e.buf = enc.AppendUints32(enc.AppendKey(e.buf, key), i) return e } // Uint64 adds the field key with i as a uint64 to the *Event context. func (e *Event) Uint64(key string, i uint64) *Event { if e == nil { return e } e.buf = enc.AppendUint64(enc.AppendKey(e.buf, key), i) return e } // Uints64 adds the field key with i as a []int64 to the *Event context. func (e *Event) Uints64(key string, i []uint64) *Event { if e == nil { return e } e.buf = enc.AppendUints64(enc.AppendKey(e.buf, key), i) return e } // Float32 adds the field key with f as a float32 to the *Event context. func (e *Event) Float32(key string, f float32) *Event { if e == nil { return e } e.buf = enc.AppendFloat32(enc.AppendKey(e.buf, key), f) return e } // Floats32 adds the field key with f as a []float32 to the *Event context. func (e *Event) Floats32(key string, f []float32) *Event { if e == nil { return e } e.buf = enc.AppendFloats32(enc.AppendKey(e.buf, key), f) return e } // Float64 adds the field key with f as a float64 to the *Event context. func (e *Event) Float64(key string, f float64) *Event { if e == nil { return e } e.buf = enc.AppendFloat64(enc.AppendKey(e.buf, key), f) return e } // Floats64 adds the field key with f as a []float64 to the *Event context. func (e *Event) Floats64(key string, f []float64) *Event { if e == nil { return e } e.buf = enc.AppendFloats64(enc.AppendKey(e.buf, key), f) return e } // 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) Timestamp() *Event { if e == nil { return e } e.buf = enc.AppendTime(enc.AppendKey(e.buf, TimestampFieldName), TimestampFunc(), TimeFieldFormat) return e } // Time adds the field key with t formated as string using zerolog.TimeFieldFormat. func (e *Event) Time(key string, t time.Time) *Event { if e == nil { return e } e.buf = enc.AppendTime(enc.AppendKey(e.buf, key), t, TimeFieldFormat) return e } // Times adds the field key with t formated as string using zerolog.TimeFieldFormat. func (e *Event) Times(key string, t []time.Time) *Event { if e == nil { return e } e.buf = enc.AppendTimes(enc.AppendKey(e.buf, key), t, TimeFieldFormat) return e } // 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. func (e *Event) Dur(key string, d time.Duration) *Event { if e == nil { return e } e.buf = enc.AppendDuration(enc.AppendKey(e.buf, key), d, DurationFieldUnit, DurationFieldInteger) return e } // 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. func (e *Event) Durs(key string, d []time.Duration) *Event { if e == nil { return e } e.buf = enc.AppendDurations(enc.AppendKey(e.buf, key), d, DurationFieldUnit, DurationFieldInteger) return e } // 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) TimeDiff(key string, t time.Time, start time.Time) *Event { if e == nil { return e } var d time.Duration if t.After(start) { d = t.Sub(start) } e.buf = enc.AppendDuration(enc.AppendKey(e.buf, key), d, DurationFieldUnit, DurationFieldInteger) return e } // Interface adds the field key with i marshaled using reflection. func (e *Event) Interface(key string, i interface{}) *Event { if e == nil { return e } if obj, ok := i.(LogObjectMarshaler); ok { return e.Object(key, obj) } e.buf = enc.AppendInterface(enc.AppendKey(e.buf, key), i) return e } // 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) CallerSkipFrame(skip int) *Event { if e == nil { return e } e.skipFrame += skip return e } // 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) Caller(skip ...int) *Event { sk := CallerSkipFrameCount if len(skip) > 0 { sk = skip[0] + CallerSkipFrameCount } return e.caller(sk) } func (e *Event) caller(skip int) *Event { if e == nil { return e } _, file, line, ok := runtime.Caller(skip + e.skipFrame) if !ok { return e } e.buf = enc.AppendString(enc.AppendKey(e.buf, CallerFieldName), CallerMarshalFunc(file, line)) return e } // IPAddr adds IPv4 or IPv6 Address to the event func (e *Event) IPAddr(key string, ip net.IP) *Event { if e == nil { return e } e.buf = enc.AppendIPAddr(enc.AppendKey(e.buf, key), ip) return e } // IPPrefix adds IPv4 or IPv6 Prefix (address and mask) to the event func (e *Event) IPPrefix(key string, pfx net.IPNet) *Event { if e == nil { return e } e.buf = enc.AppendIPPrefix(enc.AppendKey(e.buf, key), pfx) return e } // MACAddr adds MAC address to the event func (e *Event) MACAddr(key string, ha net.HardwareAddr) *Event { if e == nil { return e } e.buf = enc.AppendMACAddr(enc.AppendKey(e.buf, key), ha) return e } zerolog-1.26.1/event_test.go000066400000000000000000000025001415647605600160040ustar00rootroot00000000000000// +build !binary_log package zerolog import ( "bytes" "errors" "strings" "testing" ) type nilError struct{} func (nilError) Error() string { return "" } func TestEvent_AnErr(t *testing.T) { tests := []struct { name string err error want string }{ {"nil", nil, `{}`}, {"error", errors.New("test"), `{"err":"test"}`}, {"nil interface", func() *nilError { return nil }(), `{}`}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { var buf bytes.Buffer e := newEvent(levelWriterAdapter{&buf}, DebugLevel) e.AnErr("err", tt.err) _ = e.write() if got, want := strings.TrimSpace(buf.String()), tt.want; got != want { t.Errorf("Event.AnErr() = %v, want %v", got, want) } }) } } func TestEvent_ObjectWithNil(t *testing.T) { var buf bytes.Buffer e := newEvent(levelWriterAdapter{&buf}, DebugLevel) _ = e.Object("obj", nil) _ = e.write() want := `{"obj":null}` got := strings.TrimSpace(buf.String()) if got != want { t.Errorf("Event.Object() = %q, want %q", got, want) } } func TestEvent_EmbedObjectWithNil(t *testing.T) { var buf bytes.Buffer e := newEvent(levelWriterAdapter{&buf}, DebugLevel) _ = e.EmbedObject(nil) _ = e.write() want := "{}" got := strings.TrimSpace(buf.String()) if got != want { t.Errorf("Event.EmbedObject() = %q, want %q", got, want) } } zerolog-1.26.1/fields.go000066400000000000000000000143311415647605600150770ustar00rootroot00000000000000package zerolog import ( "encoding/json" "net" "sort" "time" "unsafe" ) func isNilValue(i interface{}) bool { return (*[2]uintptr)(unsafe.Pointer(&i))[1] == 0 } func appendFields(dst []byte, fields interface{}) []byte { switch fields := fields.(type) { case []interface{}: if n := len(fields); n&0x1 == 1 { // odd number fields = fields[:n-1] } dst = appendFieldList(dst, fields) case map[string]interface{}: keys := make([]string, 0, len(fields)) for key := range fields { keys = append(keys, key) } sort.Strings(keys) kv := make([]interface{}, 2) for _, key := range keys { kv[0], kv[1] = key, fields[key] dst = appendFieldList(dst, kv) } } return dst } func appendFieldList(dst []byte, kvList []interface{}) []byte { for i, n := 0, len(kvList); i < n; i += 2 { key, val := kvList[i], kvList[i+1] if key, ok := key.(string); ok { dst = enc.AppendKey(dst, key) } else { continue } if val, ok := val.(LogObjectMarshaler); ok { e := newEvent(nil, 0) e.buf = e.buf[:0] e.appendObject(val) dst = append(dst, e.buf...) putEvent(e) continue } switch val := val.(type) { case string: dst = enc.AppendString(dst, val) case []byte: dst = enc.AppendBytes(dst, val) case error: switch m := ErrorMarshalFunc(val).(type) { case LogObjectMarshaler: e := newEvent(nil, 0) e.buf = e.buf[:0] e.appendObject(m) dst = append(dst, e.buf...) putEvent(e) case error: if m == nil || isNilValue(m) { dst = enc.AppendNil(dst) } else { dst = enc.AppendString(dst, m.Error()) } case string: dst = enc.AppendString(dst, m) default: dst = enc.AppendInterface(dst, m) } case []error: dst = enc.AppendArrayStart(dst) for i, err := range val { switch m := ErrorMarshalFunc(err).(type) { case LogObjectMarshaler: e := newEvent(nil, 0) e.buf = e.buf[:0] e.appendObject(m) dst = append(dst, e.buf...) putEvent(e) case error: if m == nil || isNilValue(m) { dst = enc.AppendNil(dst) } else { dst = enc.AppendString(dst, m.Error()) } case string: dst = enc.AppendString(dst, m) default: dst = enc.AppendInterface(dst, m) } if i < (len(val) - 1) { enc.AppendArrayDelim(dst) } } dst = enc.AppendArrayEnd(dst) case bool: dst = enc.AppendBool(dst, val) case int: dst = enc.AppendInt(dst, val) case int8: dst = enc.AppendInt8(dst, val) case int16: dst = enc.AppendInt16(dst, val) case int32: dst = enc.AppendInt32(dst, val) case int64: dst = enc.AppendInt64(dst, val) case uint: dst = enc.AppendUint(dst, val) case uint8: dst = enc.AppendUint8(dst, val) case uint16: dst = enc.AppendUint16(dst, val) case uint32: dst = enc.AppendUint32(dst, val) case uint64: dst = enc.AppendUint64(dst, val) case float32: dst = enc.AppendFloat32(dst, val) case float64: dst = enc.AppendFloat64(dst, val) case time.Time: dst = enc.AppendTime(dst, val, TimeFieldFormat) case time.Duration: dst = enc.AppendDuration(dst, val, DurationFieldUnit, DurationFieldInteger) case *string: if val != nil { dst = enc.AppendString(dst, *val) } else { dst = enc.AppendNil(dst) } case *bool: if val != nil { dst = enc.AppendBool(dst, *val) } else { dst = enc.AppendNil(dst) } case *int: if val != nil { dst = enc.AppendInt(dst, *val) } else { dst = enc.AppendNil(dst) } case *int8: if val != nil { dst = enc.AppendInt8(dst, *val) } else { dst = enc.AppendNil(dst) } case *int16: if val != nil { dst = enc.AppendInt16(dst, *val) } else { dst = enc.AppendNil(dst) } case *int32: if val != nil { dst = enc.AppendInt32(dst, *val) } else { dst = enc.AppendNil(dst) } case *int64: if val != nil { dst = enc.AppendInt64(dst, *val) } else { dst = enc.AppendNil(dst) } case *uint: if val != nil { dst = enc.AppendUint(dst, *val) } else { dst = enc.AppendNil(dst) } case *uint8: if val != nil { dst = enc.AppendUint8(dst, *val) } else { dst = enc.AppendNil(dst) } case *uint16: if val != nil { dst = enc.AppendUint16(dst, *val) } else { dst = enc.AppendNil(dst) } case *uint32: if val != nil { dst = enc.AppendUint32(dst, *val) } else { dst = enc.AppendNil(dst) } case *uint64: if val != nil { dst = enc.AppendUint64(dst, *val) } else { dst = enc.AppendNil(dst) } case *float32: if val != nil { dst = enc.AppendFloat32(dst, *val) } else { dst = enc.AppendNil(dst) } case *float64: if val != nil { dst = enc.AppendFloat64(dst, *val) } else { dst = enc.AppendNil(dst) } case *time.Time: if val != nil { dst = enc.AppendTime(dst, *val, TimeFieldFormat) } else { dst = enc.AppendNil(dst) } case *time.Duration: if val != nil { dst = enc.AppendDuration(dst, *val, DurationFieldUnit, DurationFieldInteger) } else { dst = enc.AppendNil(dst) } case []string: dst = enc.AppendStrings(dst, val) case []bool: dst = enc.AppendBools(dst, val) case []int: dst = enc.AppendInts(dst, val) case []int8: dst = enc.AppendInts8(dst, val) case []int16: dst = enc.AppendInts16(dst, val) case []int32: dst = enc.AppendInts32(dst, val) case []int64: dst = enc.AppendInts64(dst, val) case []uint: dst = enc.AppendUints(dst, val) // case []uint8: // dst = enc.AppendUints8(dst, val) case []uint16: dst = enc.AppendUints16(dst, val) case []uint32: dst = enc.AppendUints32(dst, val) case []uint64: dst = enc.AppendUints64(dst, val) case []float32: dst = enc.AppendFloats32(dst, val) case []float64: dst = enc.AppendFloats64(dst, val) case []time.Time: dst = enc.AppendTimes(dst, val, TimeFieldFormat) case []time.Duration: dst = enc.AppendDurations(dst, val, DurationFieldUnit, DurationFieldInteger) case nil: dst = enc.AppendNil(dst) case net.IP: dst = enc.AppendIPAddr(dst, val) case net.IPNet: dst = enc.AppendIPPrefix(dst, val) case net.HardwareAddr: dst = enc.AppendMACAddr(dst, val) case json.RawMessage: dst = appendJSON(dst, val) default: dst = enc.AppendInterface(dst, val) } } return dst } zerolog-1.26.1/globals.go000066400000000000000000000102201415647605600152450ustar00rootroot00000000000000package zerolog import ( "encoding/json" "strconv" "sync/atomic" "time" ) 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" ) 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(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 or TimeFormatUnixMicro, 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) // DefaultContextLogger is returned from Ctx() if there is no logger associated // with the context. DefaultContextLogger *Logger ) var ( gLevel = new(int32) disableSampling = new(int32) ) // 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 SetGlobalLevel(l Level) { atomic.StoreInt32(gLevel, int32(l)) } // GlobalLevel returns the current global log level func GlobalLevel() Level { return Level(atomic.LoadInt32(gLevel)) } // DisableSampling will disable sampling in all Loggers if true. func DisableSampling(v bool) { var i int32 if v { i = 1 } atomic.StoreInt32(disableSampling, i) } func samplingDisabled() bool { return atomic.LoadInt32(disableSampling) == 1 } zerolog-1.26.1/go.mod000066400000000000000000000003641415647605600144110ustar00rootroot00000000000000module github.com/rs/zerolog go 1.15 require ( github.com/coreos/go-systemd/v22 v22.3.2 github.com/pkg/errors v0.9.1 github.com/rs/xid v1.3.0 golang.org/x/crypto v0.0.0-20211215165025-cf75a172585e // indirect golang.org/x/tools v0.1.7 ) zerolog-1.26.1/go.sum000066400000000000000000000070101415647605600144310ustar00rootroot00000000000000github.com/coreos/go-systemd/v22 v22.3.2 h1:D9/bQk5vlXQFZ6Kwuu6zaiXJ9oTPe68++AzAJc1DzSI= github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/rs/xid v1.3.0 h1:6NjYksEUlhurdVehpc7S7dk6DAmcKv8V9gG0FsVN2U4= github.com/rs/xid v1.3.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20211215165025-cf75a172585e/go.mod h1:P+XmwS30IXTQdn5tA2iutPOUgjI07+tq3H3K9MVA1s8= golang.org/x/mod v0.4.2 h1:Gz96sIWK3OalVv/I/qNygP42zyoKp3xptRVCWRFEBvo= golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e h1:WUoyKPm6nCo1BnNUvPGnFG3T5DUVem42yDJZZ4CNxMA= golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.7 h1:6j8CgantCy3yc8JGBqkDLMKWqZ0RDU2g1HVgacojGWQ= golang.org/x/tools v0.1.7/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= zerolog-1.26.1/go112.go000066400000000000000000000002411415647605600144550ustar00rootroot00000000000000// +build go1.12 package zerolog // Since go 1.12, some auto generated init functions are hidden from // runtime.Caller. const contextCallerSkipFrameCount = 2 zerolog-1.26.1/hlog/000077500000000000000000000000001415647605600142315ustar00rootroot00000000000000zerolog-1.26.1/hlog/hlog.go000066400000000000000000000151551415647605600155200ustar00rootroot00000000000000// Package hlog provides a set of http.Handler helpers for zerolog. package hlog import ( "context" "net/http" "time" "github.com/rs/xid" "github.com/rs/zerolog" "github.com/rs/zerolog/hlog/internal/mutil" "github.com/rs/zerolog/log" ) // FromRequest gets the logger in the request's context. // This is a shortcut for log.Ctx(r.Context()) func FromRequest(r *http.Request) *zerolog.Logger { return log.Ctx(r.Context()) } // NewHandler injects log into requests context. func NewHandler(log zerolog.Logger) func(http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { // Create a copy of the logger (including internal context slice) // to prevent data race when using UpdateContext. l := log.With().Logger() r = r.WithContext(l.WithContext(r.Context())) next.ServeHTTP(w, r) }) } } // URLHandler adds the requested URL as a field to the context's logger // using fieldKey as field key. func URLHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, r.URL.String()) }) next.ServeHTTP(w, r) }) } } // MethodHandler adds the request method as a field to the context's logger // using fieldKey as field key. func MethodHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, r.Method) }) next.ServeHTTP(w, r) }) } } // RequestHandler adds the request method and URL as a field to the context's logger // using fieldKey as field key. func RequestHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, r.Method+" "+r.URL.String()) }) next.ServeHTTP(w, r) }) } } // RemoteAddrHandler adds the request's remote address as a field to the context's logger // using fieldKey as field key. func RemoteAddrHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if r.RemoteAddr != "" { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, r.RemoteAddr) }) } next.ServeHTTP(w, r) }) } } // UserAgentHandler adds the request's user-agent as a field to the context's logger // using fieldKey as field key. func UserAgentHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if ua := r.Header.Get("User-Agent"); ua != "" { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, ua) }) } next.ServeHTTP(w, r) }) } } // RefererHandler adds the request's referer as a field to the context's logger // using fieldKey as field key. func RefererHandler(fieldKey string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if ref := r.Header.Get("Referer"); ref != "" { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, ref) }) } next.ServeHTTP(w, r) }) } } type idKey struct{} // IDFromRequest returns the unique id associated to the request if any. func IDFromRequest(r *http.Request) (id xid.ID, ok bool) { if r == nil { return } return IDFromCtx(r.Context()) } // IDFromCtx returns the unique id associated to the context if any. func IDFromCtx(ctx context.Context) (id xid.ID, ok bool) { id, ok = ctx.Value(idKey{}).(xid.ID) return } // CtxWithID adds the given xid.ID to the context func CtxWithID(ctx context.Context, id xid.ID) context.Context { return context.WithValue(ctx, idKey{}, id) } // RequestIDHandler returns a handler setting a unique id to the request which can // be gathered using IDFromRequest(req). This generated id is added as a field to the // logger using the passed fieldKey as field name. The id is also added as a response // header if the headerName is not empty. // // The generated id is a URL safe base64 encoded mongo object-id-like unique id. // Mongo unique id generation algorithm has been selected as a trade-off between // size and ease of use: UUID is less space efficient and snowflake requires machine // configuration. func RequestIDHandler(fieldKey, headerName string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { ctx := r.Context() id, ok := IDFromRequest(r) if !ok { id = xid.New() ctx = CtxWithID(ctx, id) r = r.WithContext(ctx) } if fieldKey != "" { log := zerolog.Ctx(ctx) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, id.String()) }) } if headerName != "" { w.Header().Set(headerName, id.String()) } next.ServeHTTP(w, r) }) } } // CustomHeaderHandler adds given header from request's header as a field to // the context's logger using fieldKey as field key. func CustomHeaderHandler(fieldKey, header string) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if val := r.Header.Get(header); val != "" { log := zerolog.Ctx(r.Context()) log.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str(fieldKey, val) }) } next.ServeHTTP(w, r) }) } } // AccessHandler returns a handler that call f after each request. func AccessHandler(f func(r *http.Request, status, size int, duration time.Duration)) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { start := time.Now() lw := mutil.WrapWriter(w) next.ServeHTTP(lw, r) f(r, lw.Status(), lw.BytesWritten(), time.Since(start)) }) } } zerolog-1.26.1/hlog/hlog_example_test.go000066400000000000000000000035351415647605600202710ustar00rootroot00000000000000// +build !binary_log package hlog_test import ( "net/http" "os" "time" "net/http/httptest" "github.com/rs/zerolog" "github.com/rs/zerolog/hlog" ) // fake alice to avoid dep type middleware func(http.Handler) http.Handler type alice struct { m []middleware } func (a alice) Append(m middleware) alice { a.m = append(a.m, m) return a } func (a alice) Then(h http.Handler) http.Handler { for i := range a.m { h = a.m[len(a.m)-1-i](h) } return h } func init() { zerolog.TimestampFunc = func() time.Time { return time.Date(2001, time.February, 3, 4, 5, 6, 7, time.UTC) } } func Example_handler() { log := zerolog.New(os.Stdout).With(). Timestamp(). Str("role", "my-service"). Str("host", "local-hostname"). Logger() c := alice{} // Install the logger handler with default output on the console c = c.Append(hlog.NewHandler(log)) // Install some provided extra handler to set some request's context fields. // Thanks to those handler, all our logs will come with some pre-populated fields. c = c.Append(hlog.RemoteAddrHandler("ip")) c = c.Append(hlog.UserAgentHandler("user_agent")) c = c.Append(hlog.RefererHandler("referer")) //c = c.Append(hlog.RequestIDHandler("req_id", "Request-Id")) // Here is your final handler h := c.Then(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { // Get the logger from the request's context. You can safely assume it // will be always there: if the handler is removed, hlog.FromRequest // will return a no-op logger. hlog.FromRequest(r).Info(). Str("user", "current user"). Str("status", "ok"). Msg("Something happend") })) http.Handle("/", h) h.ServeHTTP(httptest.NewRecorder(), &http.Request{}) // Output: {"level":"info","role":"my-service","host":"local-hostname","user":"current user","status":"ok","time":"2001-02-03T04:05:06Z","message":"Something happend"} } zerolog-1.26.1/hlog/hlog_test.go000066400000000000000000000171231415647605600165540ustar00rootroot00000000000000// +build go1.7 package hlog import ( "bytes" "context" "fmt" "io/ioutil" "net/http" "net/http/httptest" "net/url" "reflect" "testing" "github.com/rs/xid" "github.com/rs/zerolog" "github.com/rs/zerolog/internal/cbor" ) func decodeIfBinary(out *bytes.Buffer) string { p := out.Bytes() if len(p) == 0 || p[0] < 0x7F { return out.String() } return cbor.DecodeObjectToStr(p) + "\n" } func TestNewHandler(t *testing.T) { log := zerolog.New(nil).With(). Str("foo", "bar"). Logger() lh := NewHandler(log) h := lh(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) if !reflect.DeepEqual(*l, log) { t.Fail() } })) h.ServeHTTP(nil, &http.Request{}) } func TestURLHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ URL: &url.URL{Path: "/path", RawQuery: "foo=bar"}, } h := URLHandler("url")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"url":"/path?foo=bar"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestMethodHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ Method: "POST", } h := MethodHandler("method")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"method":"POST"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestRequestHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ Method: "POST", URL: &url.URL{Path: "/path", RawQuery: "foo=bar"}, } h := RequestHandler("request")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"request":"POST /path?foo=bar"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestRemoteAddrHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ RemoteAddr: "1.2.3.4:1234", } h := RemoteAddrHandler("ip")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"ip":"1.2.3.4:1234"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestRemoteAddrHandlerIPv6(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ RemoteAddr: "[2001:db8:a0b:12f0::1]:1234", } h := RemoteAddrHandler("ip")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"ip":"[2001:db8:a0b:12f0::1]:1234"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestUserAgentHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ Header: http.Header{ "User-Agent": []string{"some user agent string"}, }, } h := UserAgentHandler("ua")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"ua":"some user agent string"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestRefererHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ Header: http.Header{ "Referer": []string{"http://foo.com/bar"}, }, } h := RefererHandler("referer")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"referer":"http://foo.com/bar"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestRequestIDHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ Header: http.Header{ "Referer": []string{"http://foo.com/bar"}, }, } h := RequestIDHandler("id", "Request-Id")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { id, ok := IDFromRequest(r) if !ok { t.Fatal("Missing id in request") } if want, got := id.String(), w.Header().Get("Request-Id"); got != want { t.Errorf("Invalid Request-Id header, got: %s, want: %s", got, want) } l := FromRequest(r) l.Log().Msg("") if want, got := fmt.Sprintf(`{"id":"%s"}`+"\n", id), decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(httptest.NewRecorder(), r) } func TestCustomHeaderHandler(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ Header: http.Header{ "X-Request-Id": []string{"514bbe5bb5251c92bd07a9846f4a1ab6"}, }, } h := CustomHeaderHandler("reqID", "X-Request-Id")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"reqID":"514bbe5bb5251c92bd07a9846f4a1ab6"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func TestCombinedHandlers(t *testing.T) { out := &bytes.Buffer{} r := &http.Request{ Method: "POST", URL: &url.URL{Path: "/path", RawQuery: "foo=bar"}, } h := MethodHandler("method")(RequestHandler("request")(URLHandler("url")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })))) h = NewHandler(zerolog.New(out))(h) h.ServeHTTP(nil, r) if want, got := `{"method":"POST","request":"POST /path?foo=bar","url":"/path?foo=bar"}`+"\n", decodeIfBinary(out); want != got { t.Errorf("Invalid log output, got: %s, want: %s", got, want) } } func BenchmarkHandlers(b *testing.B) { r := &http.Request{ Method: "POST", URL: &url.URL{Path: "/path", RawQuery: "foo=bar"}, } h1 := URLHandler("url")(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.Log().Msg("") })) h2 := MethodHandler("method")(RequestHandler("request")(h1)) handlers := map[string]http.Handler{ "Single": NewHandler(zerolog.New(ioutil.Discard))(h1), "Combined": NewHandler(zerolog.New(ioutil.Discard))(h2), "SingleDisabled": NewHandler(zerolog.New(ioutil.Discard).Level(zerolog.Disabled))(h1), "CombinedDisabled": NewHandler(zerolog.New(ioutil.Discard).Level(zerolog.Disabled))(h2), } for name := range handlers { h := handlers[name] b.Run(name, func(b *testing.B) { for i := 0; i < b.N; i++ { h.ServeHTTP(nil, r) } }) } } func BenchmarkDataRace(b *testing.B) { log := zerolog.New(nil).With(). Str("foo", "bar"). Logger() lh := NewHandler(log) h := lh(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { l := FromRequest(r) l.UpdateContext(func(c zerolog.Context) zerolog.Context { return c.Str("bar", "baz") }) l.Log().Msg("") })) b.RunParallel(func(pb *testing.PB) { for pb.Next() { h.ServeHTTP(nil, &http.Request{}) } }) } func TestCtxWithID(t *testing.T) { ctx := context.Background() id, _ := xid.FromString(`c0umremcie6smuu506pg`) want := context.Background() want = context.WithValue(want, idKey{}, id) if got := CtxWithID(ctx, id); !reflect.DeepEqual(got, want) { t.Errorf("CtxWithID() = %v, want %v", got, want) } } zerolog-1.26.1/hlog/internal/000077500000000000000000000000001415647605600160455ustar00rootroot00000000000000zerolog-1.26.1/hlog/internal/mutil/000077500000000000000000000000001415647605600171775ustar00rootroot00000000000000zerolog-1.26.1/hlog/internal/mutil/LICENSE000066400000000000000000000021121415647605600202000ustar00rootroot00000000000000Copyright (c) 2014, 2015, 2016 Carl Jackson (carl@avtok.com) MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. zerolog-1.26.1/hlog/internal/mutil/mutil.go000066400000000000000000000003451415647605600206620ustar00rootroot00000000000000// Package mutil contains various functions that are helpful when writing http // middleware. // // It has been vendored from Goji v1.0, with the exception of the code for Go 1.8: // https://github.com/zenazn/goji/ package mutil zerolog-1.26.1/hlog/internal/mutil/writer_proxy.go000066400000000000000000000073101415647605600223040ustar00rootroot00000000000000package mutil import ( "bufio" "io" "net" "net/http" ) // WriterProxy is a proxy around an http.ResponseWriter that allows you to hook // into various parts of the response process. type WriterProxy interface { http.ResponseWriter // Status returns the HTTP status of the request, or 0 if one has not // yet been sent. Status() int // BytesWritten returns the total number of bytes sent to the client. BytesWritten() int // Tee causes the response body to be written to the given io.Writer in // addition to proxying the writes through. Only one io.Writer can be // tee'd to at once: setting a second one will overwrite the first. // Writes will be sent to the proxy before being written to this // io.Writer. It is illegal for the tee'd writer to be modified // concurrently with writes. Tee(io.Writer) // Unwrap returns the original proxied target. Unwrap() http.ResponseWriter } // WrapWriter wraps an http.ResponseWriter, returning a proxy that allows you to // hook into various parts of the response process. func WrapWriter(w http.ResponseWriter) WriterProxy { _, cn := w.(http.CloseNotifier) _, fl := w.(http.Flusher) _, hj := w.(http.Hijacker) _, rf := w.(io.ReaderFrom) bw := basicWriter{ResponseWriter: w} if cn && fl && hj && rf { return &fancyWriter{bw} } if fl { return &flushWriter{bw} } return &bw } // basicWriter wraps a http.ResponseWriter that implements the minimal // http.ResponseWriter interface. type basicWriter struct { http.ResponseWriter wroteHeader bool code int bytes int tee io.Writer } func (b *basicWriter) WriteHeader(code int) { if !b.wroteHeader { b.code = code b.wroteHeader = true b.ResponseWriter.WriteHeader(code) } } func (b *basicWriter) Write(buf []byte) (int, error) { b.WriteHeader(http.StatusOK) n, err := b.ResponseWriter.Write(buf) if b.tee != nil { _, err2 := b.tee.Write(buf[:n]) // Prefer errors generated by the proxied writer. if err == nil { err = err2 } } b.bytes += n return n, err } func (b *basicWriter) maybeWriteHeader() { if !b.wroteHeader { b.WriteHeader(http.StatusOK) } } func (b *basicWriter) Status() int { return b.code } func (b *basicWriter) BytesWritten() int { return b.bytes } func (b *basicWriter) Tee(w io.Writer) { b.tee = w } func (b *basicWriter) Unwrap() http.ResponseWriter { return b.ResponseWriter } // fancyWriter is a writer that additionally satisfies http.CloseNotifier, // http.Flusher, http.Hijacker, and io.ReaderFrom. It exists for the common case // of wrapping the http.ResponseWriter that package http gives you, in order to // make the proxied object support the full method set of the proxied object. type fancyWriter struct { basicWriter } func (f *fancyWriter) CloseNotify() <-chan bool { cn := f.basicWriter.ResponseWriter.(http.CloseNotifier) return cn.CloseNotify() } func (f *fancyWriter) Flush() { fl := f.basicWriter.ResponseWriter.(http.Flusher) fl.Flush() } func (f *fancyWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) { hj := f.basicWriter.ResponseWriter.(http.Hijacker) return hj.Hijack() } func (f *fancyWriter) ReadFrom(r io.Reader) (int64, error) { if f.basicWriter.tee != nil { n, err := io.Copy(&f.basicWriter, r) f.bytes += int(n) return n, err } rf := f.basicWriter.ResponseWriter.(io.ReaderFrom) f.basicWriter.maybeWriteHeader() n, err := rf.ReadFrom(r) f.bytes += int(n) return n, err } type flushWriter struct { basicWriter } func (f *flushWriter) Flush() { fl := f.basicWriter.ResponseWriter.(http.Flusher) fl.Flush() } var ( _ http.CloseNotifier = &fancyWriter{} _ http.Flusher = &fancyWriter{} _ http.Hijacker = &fancyWriter{} _ io.ReaderFrom = &fancyWriter{} _ http.Flusher = &flushWriter{} ) zerolog-1.26.1/hook.go000066400000000000000000000027461415647605600146000ustar00rootroot00000000000000package zerolog // 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) // Run implements the Hook interface. func (h HookFunc) Run(e *Event, level Level, message string) { h(e, level, message) } // LevelHook applies a different hook for each level. type LevelHook struct { NoLevelHook, TraceHook, DebugHook, InfoHook, WarnHook, ErrorHook, FatalHook, PanicHook Hook } // Run implements the Hook interface. func (h LevelHook) Run(e *Event, level Level, message string) { switch level { case TraceLevel: if h.TraceHook != nil { h.TraceHook.Run(e, level, message) } case DebugLevel: if h.DebugHook != nil { h.DebugHook.Run(e, level, message) } case InfoLevel: if h.InfoHook != nil { h.InfoHook.Run(e, level, message) } case WarnLevel: if h.WarnHook != nil { h.WarnHook.Run(e, level, message) } case ErrorLevel: if h.ErrorHook != nil { h.ErrorHook.Run(e, level, message) } case FatalLevel: if h.FatalHook != nil { h.FatalHook.Run(e, level, message) } case PanicLevel: if h.PanicHook != nil { h.PanicHook.Run(e, level, message) } case NoLevel: if h.NoLevelHook != nil { h.NoLevelHook.Run(e, level, message) } } } // NewLevelHook returns a new LevelHook. func NewLevelHook() LevelHook { return LevelHook{} } zerolog-1.26.1/hook_test.go000066400000000000000000000130141415647605600156250ustar00rootroot00000000000000package zerolog import ( "bytes" "io/ioutil" "testing" ) var ( levelNameHook = HookFunc(func(e *Event, level Level, msg string) { levelName := level.String() if level == NoLevel { levelName = "nolevel" } e.Str("level_name", levelName) }) simpleHook = HookFunc(func(e *Event, level Level, msg string) { e.Bool("has_level", level != NoLevel) e.Str("test", "logged") }) copyHook = HookFunc(func(e *Event, level Level, msg string) { hasLevel := level != NoLevel e.Bool("copy_has_level", hasLevel) if hasLevel { e.Str("copy_level", level.String()) } e.Str("copy_msg", msg) }) nopHook = HookFunc(func(e *Event, level Level, message string) { }) discardHook = HookFunc(func(e *Event, level Level, message string) { e.Discard() }) ) func TestHook(t *testing.T) { tests := []struct { name string want string test func(log Logger) }{ {"Message", `{"level_name":"nolevel","message":"test message"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook) log.Log().Msg("test message") }}, {"NoLevel", `{"level_name":"nolevel"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook) log.Log().Msg("") }}, {"Print", `{"level":"debug","level_name":"debug"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook) log.Print("") }}, {"Error", `{"level":"error","level_name":"error"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook) log.Error().Msg("") }}, {"Copy/1", `{"copy_has_level":false,"copy_msg":""}` + "\n", func(log Logger) { log = log.Hook(copyHook) log.Log().Msg("") }}, {"Copy/2", `{"level":"info","copy_has_level":true,"copy_level":"info","copy_msg":"a message","message":"a message"}` + "\n", func(log Logger) { log = log.Hook(copyHook) log.Info().Msg("a message") }}, {"Multi", `{"level":"error","level_name":"error","has_level":true,"test":"logged"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook).Hook(simpleHook) log.Error().Msg("") }}, {"Multi/Message", `{"level":"error","level_name":"error","has_level":true,"test":"logged","message":"a message"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook).Hook(simpleHook) log.Error().Msg("a message") }}, {"Output/single/pre", `{"level":"error","level_name":"error"}` + "\n", func(log Logger) { ignored := &bytes.Buffer{} log = New(ignored).Hook(levelNameHook).Output(log.w) log.Error().Msg("") }}, {"Output/single/post", `{"level":"error","level_name":"error"}` + "\n", func(log Logger) { ignored := &bytes.Buffer{} log = New(ignored).Output(log.w).Hook(levelNameHook) log.Error().Msg("") }}, {"Output/multi/pre", `{"level":"error","level_name":"error","has_level":true,"test":"logged"}` + "\n", func(log Logger) { ignored := &bytes.Buffer{} log = New(ignored).Hook(levelNameHook).Hook(simpleHook).Output(log.w) log.Error().Msg("") }}, {"Output/multi/post", `{"level":"error","level_name":"error","has_level":true,"test":"logged"}` + "\n", func(log Logger) { ignored := &bytes.Buffer{} log = New(ignored).Output(log.w).Hook(levelNameHook).Hook(simpleHook) log.Error().Msg("") }}, {"Output/mixed", `{"level":"error","level_name":"error","has_level":true,"test":"logged"}` + "\n", func(log Logger) { ignored := &bytes.Buffer{} log = New(ignored).Hook(levelNameHook).Output(log.w).Hook(simpleHook) log.Error().Msg("") }}, {"With/single/pre", `{"level":"error","with":"pre","level_name":"error"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook).With().Str("with", "pre").Logger() log.Error().Msg("") }}, {"With/single/post", `{"level":"error","with":"post","level_name":"error"}` + "\n", func(log Logger) { log = log.With().Str("with", "post").Logger().Hook(levelNameHook) log.Error().Msg("") }}, {"With/multi/pre", `{"level":"error","with":"pre","level_name":"error","has_level":true,"test":"logged"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook).Hook(simpleHook).With().Str("with", "pre").Logger() log.Error().Msg("") }}, {"With/multi/post", `{"level":"error","with":"post","level_name":"error","has_level":true,"test":"logged"}` + "\n", func(log Logger) { log = log.With().Str("with", "post").Logger().Hook(levelNameHook).Hook(simpleHook) log.Error().Msg("") }}, {"With/mixed", `{"level":"error","with":"mixed","level_name":"error","has_level":true,"test":"logged"}` + "\n", func(log Logger) { log = log.Hook(levelNameHook).With().Str("with", "mixed").Logger().Hook(simpleHook) log.Error().Msg("") }}, {"Discard", "", func(log Logger) { log = log.Hook(discardHook) log.Log().Msg("test message") }}, {"None", `{"level":"error"}` + "\n", func(log Logger) { log.Error().Msg("") }}, } for _, tt := range tests { tt := tt t.Run(tt.name, func(t *testing.T) { out := &bytes.Buffer{} log := New(out) tt.test(log) if got, want := decodeIfBinaryToString(out.Bytes()), tt.want; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) } } func BenchmarkHooks(b *testing.B) { logger := New(ioutil.Discard) b.ResetTimer() b.Run("Nop/Single", func(b *testing.B) { log := logger.Hook(nopHook) b.RunParallel(func(pb *testing.PB) { for pb.Next() { log.Log().Msg("") } }) }) b.Run("Nop/Multi", func(b *testing.B) { log := logger.Hook(nopHook).Hook(nopHook) b.RunParallel(func(pb *testing.PB) { for pb.Next() { log.Log().Msg("") } }) }) b.Run("Simple", func(b *testing.B) { log := logger.Hook(simpleHook) b.RunParallel(func(pb *testing.PB) { for pb.Next() { log.Log().Msg("") } }) }) } zerolog-1.26.1/internal/000077500000000000000000000000001415647605600151145ustar00rootroot00000000000000zerolog-1.26.1/internal/cbor/000077500000000000000000000000001415647605600160415ustar00rootroot00000000000000zerolog-1.26.1/internal/cbor/README.md000066400000000000000000000067161415647605600173320ustar00rootroot00000000000000## Reference: CBOR Encoding is described in [RFC7049](https://tools.ietf.org/html/rfc7049) ## Comparison of JSON vs CBOR Two main areas of reduction are: 1. CPU usage to write a log msg 2. Size (in bytes) of log messages. CPU Usage savings are below: ``` name JSON time/op CBOR time/op delta Info-32 15.3ns ± 1% 11.7ns ± 3% -23.78% (p=0.000 n=9+10) ContextFields-32 16.2ns ± 2% 12.3ns ± 3% -23.97% (p=0.000 n=9+9) ContextAppend-32 6.70ns ± 0% 6.20ns ± 0% -7.44% (p=0.000 n=9+9) LogFields-32 66.4ns ± 0% 24.6ns ± 2% -62.89% (p=0.000 n=10+9) LogArrayObject-32 911ns ±11% 768ns ± 6% -15.64% (p=0.000 n=10+10) LogFieldType/Floats-32 70.3ns ± 2% 29.5ns ± 1% -57.98% (p=0.000 n=10+10) LogFieldType/Err-32 14.0ns ± 3% 12.1ns ± 8% -13.20% (p=0.000 n=8+10) LogFieldType/Dur-32 17.2ns ± 2% 13.1ns ± 1% -24.27% (p=0.000 n=10+9) LogFieldType/Object-32 54.3ns ±11% 52.3ns ± 7% ~ (p=0.239 n=10+10) LogFieldType/Ints-32 20.3ns ± 2% 15.1ns ± 2% -25.50% (p=0.000 n=9+10) LogFieldType/Interfaces-32 642ns ±11% 621ns ± 9% ~ (p=0.118 n=10+10) LogFieldType/Interface(Objects)-32 635ns ±13% 632ns ± 9% ~ (p=0.592 n=10+10) LogFieldType/Times-32 294ns ± 0% 27ns ± 1% -90.71% (p=0.000 n=10+9) LogFieldType/Durs-32 121ns ± 0% 33ns ± 2% -72.44% (p=0.000 n=9+9) LogFieldType/Interface(Object)-32 56.6ns ± 8% 52.3ns ± 8% -7.54% (p=0.007 n=10+10) LogFieldType/Errs-32 17.8ns ± 3% 16.1ns ± 2% -9.71% (p=0.000 n=10+9) LogFieldType/Time-32 40.5ns ± 1% 12.7ns ± 6% -68.66% (p=0.000 n=8+9) LogFieldType/Bool-32 12.0ns ± 5% 10.2ns ± 2% -15.18% (p=0.000 n=10+8) LogFieldType/Bools-32 17.2ns ± 2% 12.6ns ± 4% -26.63% (p=0.000 n=10+10) LogFieldType/Int-32 12.3ns ± 2% 11.2ns ± 4% -9.27% (p=0.000 n=9+10) LogFieldType/Float-32 16.7ns ± 1% 12.6ns ± 2% -24.42% (p=0.000 n=7+9) LogFieldType/Str-32 12.7ns ± 7% 11.3ns ± 7% -10.88% (p=0.000 n=10+9) LogFieldType/Strs-32 20.3ns ± 3% 18.2ns ± 3% -10.25% (p=0.000 n=9+10) LogFieldType/Interface-32 183ns ±12% 175ns ± 9% ~ (p=0.078 n=10+10) ``` Log message size savings is greatly dependent on the number and type of fields in the log message. Assuming this log message (with an Integer, timestamp and string, in addition to level). `{"level":"error","Fault":41650,"time":"2018-04-01T15:18:19-07:00","message":"Some Message"}` Two measurements were done for the log file sizes - one without any compression, second using [compress/zlib](https://golang.org/pkg/compress/zlib/). Results for 10,000 log messages: | Log Format | Plain File Size (in KB) | Compressed File Size (in KB) | | :--- | :---: | :---: | | JSON | 920 | 28 | | CBOR | 550 | 28 | The example used to calculate the above data is available in [Examples](examples). zerolog-1.26.1/internal/cbor/base.go000066400000000000000000000012401415647605600172770ustar00rootroot00000000000000package cbor // JSONMarshalFunc is used to marshal interface to JSON encoded byte slice. // Making it package level instead of embedded in Encoder brings // some extra efforts at importing, but avoids value copy when the functions // of Encoder being invoked. // DO REMEMBER to set this variable at importing, or // you might get a nil pointer dereference panic at runtime. var JSONMarshalFunc func(v interface{}) ([]byte, error) type Encoder struct{} // AppendKey adds a key (string) to the binary encoded log message func (e Encoder) AppendKey(dst []byte, key string) []byte { if len(dst) < 1 { dst = e.AppendBeginMarker(dst) } return e.AppendString(dst, key) } zerolog-1.26.1/internal/cbor/cbor.go000066400000000000000000000055311415647605600173210ustar00rootroot00000000000000// Package cbor provides primitives for storing different data // in the CBOR (binary) format. CBOR is defined in RFC7049. package cbor import "time" const ( majorOffset = 5 additionalMax = 23 // Non Values. additionalTypeBoolFalse byte = 20 additionalTypeBoolTrue byte = 21 additionalTypeNull byte = 22 // Integer (+ve and -ve) Sub-types. additionalTypeIntUint8 byte = 24 additionalTypeIntUint16 byte = 25 additionalTypeIntUint32 byte = 26 additionalTypeIntUint64 byte = 27 // Float Sub-types. additionalTypeFloat16 byte = 25 additionalTypeFloat32 byte = 26 additionalTypeFloat64 byte = 27 additionalTypeBreak byte = 31 // Tag Sub-types. additionalTypeTimestamp byte = 01 // Extended Tags - from https://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml additionalTypeTagNetworkAddr uint16 = 260 additionalTypeTagNetworkPrefix uint16 = 261 additionalTypeEmbeddedJSON uint16 = 262 additionalTypeTagHexString uint16 = 263 // Unspecified number of elements. additionalTypeInfiniteCount byte = 31 ) const ( majorTypeUnsignedInt byte = iota << majorOffset // Major type 0 majorTypeNegativeInt // Major type 1 majorTypeByteString // Major type 2 majorTypeUtf8String // Major type 3 majorTypeArray // Major type 4 majorTypeMap // Major type 5 majorTypeTags // Major type 6 majorTypeSimpleAndFloat // Major type 7 ) const ( maskOutAdditionalType byte = (7 << majorOffset) maskOutMajorType byte = 31 ) const ( float32Nan = "\xfa\x7f\xc0\x00\x00" float32PosInfinity = "\xfa\x7f\x80\x00\x00" float32NegInfinity = "\xfa\xff\x80\x00\x00" float64Nan = "\xfb\x7f\xf8\x00\x00\x00\x00\x00\x00" float64PosInfinity = "\xfb\x7f\xf0\x00\x00\x00\x00\x00\x00" float64NegInfinity = "\xfb\xff\xf0\x00\x00\x00\x00\x00\x00" ) // IntegerTimeFieldFormat indicates the format of timestamp decoded // from an integer (time in seconds). var IntegerTimeFieldFormat = time.RFC3339 // NanoTimeFieldFormat indicates the format of timestamp decoded // from a float value (time in seconds and nano seconds). var NanoTimeFieldFormat = time.RFC3339Nano func appendCborTypePrefix(dst []byte, major byte, number uint64) []byte { byteCount := 8 var minor byte switch { case number < 256: byteCount = 1 minor = additionalTypeIntUint8 case number < 65536: byteCount = 2 minor = additionalTypeIntUint16 case number < 4294967296: byteCount = 4 minor = additionalTypeIntUint32 default: byteCount = 8 minor = additionalTypeIntUint64 } dst = append(dst, byte(major|minor)) byteCount-- for ; byteCount >= 0; byteCount-- { dst = append(dst, byte(number>>(uint(byteCount)*8))) } return dst } zerolog-1.26.1/internal/cbor/decode_stream.go000066400000000000000000000355131415647605600211750ustar00rootroot00000000000000package cbor // This file contains code to decode a stream of CBOR Data into JSON. import ( "bufio" "bytes" "fmt" "io" "math" "net" "runtime" "strconv" "strings" "time" "unicode/utf8" ) var decodeTimeZone *time.Location const hexTable = "0123456789abcdef" const isFloat32 = 4 const isFloat64 = 8 func readNBytes(src *bufio.Reader, n int) []byte { ret := make([]byte, n) for i := 0; i < n; i++ { ch, e := src.ReadByte() if e != nil { panic(fmt.Errorf("Tried to Read %d Bytes.. But hit end of file", n)) } ret[i] = ch } return ret } func readByte(src *bufio.Reader) byte { b, e := src.ReadByte() if e != nil { panic(fmt.Errorf("Tried to Read 1 Byte.. But hit end of file")) } return b } func decodeIntAdditonalType(src *bufio.Reader, minor byte) int64 { val := int64(0) if minor <= 23 { val = int64(minor) } else { bytesToRead := 0 switch minor { case additionalTypeIntUint8: bytesToRead = 1 case additionalTypeIntUint16: bytesToRead = 2 case additionalTypeIntUint32: bytesToRead = 4 case additionalTypeIntUint64: bytesToRead = 8 default: panic(fmt.Errorf("Invalid Additional Type: %d in decodeInteger (expected <28)", minor)) } pb := readNBytes(src, bytesToRead) for i := 0; i < bytesToRead; i++ { val = val * 256 val += int64(pb[i]) } } return val } func decodeInteger(src *bufio.Reader) int64 { pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeUnsignedInt && major != majorTypeNegativeInt { panic(fmt.Errorf("Major type is: %d in decodeInteger!! (expected 0 or 1)", major)) } val := decodeIntAdditonalType(src, minor) if major == 0 { return val } return (-1 - val) } func decodeFloat(src *bufio.Reader) (float64, int) { pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeSimpleAndFloat { panic(fmt.Errorf("Incorrect Major type is: %d in decodeFloat", major)) } switch minor { case additionalTypeFloat16: panic(fmt.Errorf("float16 is not suppported in decodeFloat")) case additionalTypeFloat32: pb := readNBytes(src, 4) switch string(pb) { case float32Nan: return math.NaN(), isFloat32 case float32PosInfinity: return math.Inf(0), isFloat32 case float32NegInfinity: return math.Inf(-1), isFloat32 } n := uint32(0) for i := 0; i < 4; i++ { n = n * 256 n += uint32(pb[i]) } val := math.Float32frombits(n) return float64(val), isFloat32 case additionalTypeFloat64: pb := readNBytes(src, 8) switch string(pb) { case float64Nan: return math.NaN(), isFloat64 case float64PosInfinity: return math.Inf(0), isFloat64 case float64NegInfinity: return math.Inf(-1), isFloat64 } n := uint64(0) for i := 0; i < 8; i++ { n = n * 256 n += uint64(pb[i]) } val := math.Float64frombits(n) return val, isFloat64 } panic(fmt.Errorf("Invalid Additional Type: %d in decodeFloat", minor)) } func decodeStringComplex(dst []byte, s string, pos uint) []byte { i := int(pos) start := 0 for i < len(s) { b := s[i] if b >= utf8.RuneSelf { r, size := utf8.DecodeRuneInString(s[i:]) if r == utf8.RuneError && size == 1 { // In case of error, first append previous simple characters to // the byte slice if any and append a replacement character code // in place of the invalid sequence. if start < i { dst = append(dst, s[start:i]...) } dst = append(dst, `\ufffd`...) i += size start = i continue } i += size continue } if b >= 0x20 && b <= 0x7e && b != '\\' && b != '"' { i++ continue } // We encountered a character that needs to be encoded. // Let's append the previous simple characters to the byte slice // and switch our operation to read and encode the remainder // characters byte-by-byte. if start < i { dst = append(dst, s[start:i]...) } switch b { case '"', '\\': dst = append(dst, '\\', b) case '\b': dst = append(dst, '\\', 'b') case '\f': dst = append(dst, '\\', 'f') case '\n': dst = append(dst, '\\', 'n') case '\r': dst = append(dst, '\\', 'r') case '\t': dst = append(dst, '\\', 't') default: dst = append(dst, '\\', 'u', '0', '0', hexTable[b>>4], hexTable[b&0xF]) } i++ start = i } if start < len(s) { dst = append(dst, s[start:]...) } return dst } func decodeString(src *bufio.Reader, noQuotes bool) []byte { pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeByteString { panic(fmt.Errorf("Major type is: %d in decodeString", major)) } result := []byte{} if !noQuotes { result = append(result, '"') } length := decodeIntAdditonalType(src, minor) len := int(length) pbs := readNBytes(src, len) result = append(result, pbs...) if noQuotes { return result } return append(result, '"') } func decodeUTF8String(src *bufio.Reader) []byte { pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeUtf8String { panic(fmt.Errorf("Major type is: %d in decodeUTF8String", major)) } result := []byte{'"'} length := decodeIntAdditonalType(src, minor) len := int(length) pbs := readNBytes(src, len) for i := 0; i < len; i++ { // Check if the character needs encoding. Control characters, slashes, // and the double quote need json encoding. Bytes above the ascii // boundary needs utf8 encoding. if pbs[i] < 0x20 || pbs[i] > 0x7e || pbs[i] == '\\' || pbs[i] == '"' { // We encountered a character that needs to be encoded. Switch // to complex version of the algorithm. dst := []byte{'"'} dst = decodeStringComplex(dst, string(pbs), uint(i)) return append(dst, '"') } } // The string has no need for encoding an therefore is directly // appended to the byte slice. result = append(result, pbs...) return append(result, '"') } func array2Json(src *bufio.Reader, dst io.Writer) { dst.Write([]byte{'['}) pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeArray { panic(fmt.Errorf("Major type is: %d in array2Json", major)) } len := 0 unSpecifiedCount := false if minor == additionalTypeInfiniteCount { unSpecifiedCount = true } else { length := decodeIntAdditonalType(src, minor) len = int(length) } for i := 0; unSpecifiedCount || i < len; i++ { if unSpecifiedCount { pb, e := src.Peek(1) if e != nil { panic(e) } if pb[0] == byte(majorTypeSimpleAndFloat|additionalTypeBreak) { readByte(src) break } } cbor2JsonOneObject(src, dst) if unSpecifiedCount { pb, e := src.Peek(1) if e != nil { panic(e) } if pb[0] == byte(majorTypeSimpleAndFloat|additionalTypeBreak) { readByte(src) break } dst.Write([]byte{','}) } else if i+1 < len { dst.Write([]byte{','}) } } dst.Write([]byte{']'}) } func map2Json(src *bufio.Reader, dst io.Writer) { pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeMap { panic(fmt.Errorf("Major type is: %d in map2Json", major)) } len := 0 unSpecifiedCount := false if minor == additionalTypeInfiniteCount { unSpecifiedCount = true } else { length := decodeIntAdditonalType(src, minor) len = int(length) } dst.Write([]byte{'{'}) for i := 0; unSpecifiedCount || i < len; i++ { if unSpecifiedCount { pb, e := src.Peek(1) if e != nil { panic(e) } if pb[0] == byte(majorTypeSimpleAndFloat|additionalTypeBreak) { readByte(src) break } } cbor2JsonOneObject(src, dst) if i%2 == 0 { // Even position values are keys. dst.Write([]byte{':'}) } else { if unSpecifiedCount { pb, e := src.Peek(1) if e != nil { panic(e) } if pb[0] == byte(majorTypeSimpleAndFloat|additionalTypeBreak) { readByte(src) break } dst.Write([]byte{','}) } else if i+1 < len { dst.Write([]byte{','}) } } } dst.Write([]byte{'}'}) } func decodeTagData(src *bufio.Reader) []byte { pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeTags { panic(fmt.Errorf("Major type is: %d in decodeTagData", major)) } switch minor { case additionalTypeTimestamp: return decodeTimeStamp(src) // Tag value is larger than 256 (so uint16). case additionalTypeIntUint16: val := decodeIntAdditonalType(src, minor) switch uint16(val) { case additionalTypeEmbeddedJSON: pb := readByte(src) dataMajor := pb & maskOutAdditionalType if dataMajor != majorTypeByteString { panic(fmt.Errorf("Unsupported embedded Type: %d in decodeEmbeddedJSON", dataMajor)) } src.UnreadByte() return decodeString(src, true) case additionalTypeTagNetworkAddr: octets := decodeString(src, true) ss := []byte{'"'} switch len(octets) { case 6: // MAC address. ha := net.HardwareAddr(octets) ss = append(append(ss, ha.String()...), '"') case 4: // IPv4 address. fallthrough case 16: // IPv6 address. ip := net.IP(octets) ss = append(append(ss, ip.String()...), '"') default: panic(fmt.Errorf("Unexpected Network Address length: %d (expected 4,6,16)", len(octets))) } return ss case additionalTypeTagNetworkPrefix: pb := readByte(src) if pb != byte(majorTypeMap|0x1) { panic(fmt.Errorf("IP Prefix is NOT of MAP of 1 elements as expected")) } octets := decodeString(src, true) val := decodeInteger(src) ip := net.IP(octets) var mask net.IPMask pfxLen := int(val) if len(octets) == 4 { mask = net.CIDRMask(pfxLen, 32) } else { mask = net.CIDRMask(pfxLen, 128) } ipPfx := net.IPNet{IP: ip, Mask: mask} ss := []byte{'"'} ss = append(append(ss, ipPfx.String()...), '"') return ss case additionalTypeTagHexString: octets := decodeString(src, true) ss := []byte{'"'} for _, v := range octets { ss = append(ss, hexTable[v>>4], hexTable[v&0x0f]) } return append(ss, '"') default: panic(fmt.Errorf("Unsupported Additional Tag Type: %d in decodeTagData", val)) } } panic(fmt.Errorf("Unsupported Additional Type: %d in decodeTagData", minor)) } func decodeTimeStamp(src *bufio.Reader) []byte { pb := readByte(src) src.UnreadByte() tsMajor := pb & maskOutAdditionalType if tsMajor == majorTypeUnsignedInt || tsMajor == majorTypeNegativeInt { n := decodeInteger(src) t := time.Unix(n, 0) if decodeTimeZone != nil { t = t.In(decodeTimeZone) } else { t = t.In(time.UTC) } tsb := []byte{} tsb = append(tsb, '"') tsb = t.AppendFormat(tsb, IntegerTimeFieldFormat) tsb = append(tsb, '"') return tsb } else if tsMajor == majorTypeSimpleAndFloat { n, _ := decodeFloat(src) secs := int64(n) n -= float64(secs) n *= float64(1e9) t := time.Unix(secs, int64(n)) if decodeTimeZone != nil { t = t.In(decodeTimeZone) } else { t = t.In(time.UTC) } tsb := []byte{} tsb = append(tsb, '"') tsb = t.AppendFormat(tsb, NanoTimeFieldFormat) tsb = append(tsb, '"') return tsb } panic(fmt.Errorf("TS format is neigther int nor float: %d", tsMajor)) } func decodeSimpleFloat(src *bufio.Reader) []byte { pb := readByte(src) major := pb & maskOutAdditionalType minor := pb & maskOutMajorType if major != majorTypeSimpleAndFloat { panic(fmt.Errorf("Major type is: %d in decodeSimpleFloat", major)) } switch minor { case additionalTypeBoolTrue: return []byte("true") case additionalTypeBoolFalse: return []byte("false") case additionalTypeNull: return []byte("null") case additionalTypeFloat16: fallthrough case additionalTypeFloat32: fallthrough case additionalTypeFloat64: src.UnreadByte() v, bc := decodeFloat(src) ba := []byte{} switch { case math.IsNaN(v): return []byte("\"NaN\"") case math.IsInf(v, 1): return []byte("\"+Inf\"") case math.IsInf(v, -1): return []byte("\"-Inf\"") } if bc == isFloat32 { ba = strconv.AppendFloat(ba, v, 'f', -1, 32) } else if bc == isFloat64 { ba = strconv.AppendFloat(ba, v, 'f', -1, 64) } else { panic(fmt.Errorf("Invalid Float precision from decodeFloat: %d", bc)) } return ba default: panic(fmt.Errorf("Invalid Additional Type: %d in decodeSimpleFloat", minor)) } } func cbor2JsonOneObject(src *bufio.Reader, dst io.Writer) { pb, e := src.Peek(1) if e != nil { panic(e) } major := (pb[0] & maskOutAdditionalType) switch major { case majorTypeUnsignedInt: fallthrough case majorTypeNegativeInt: n := decodeInteger(src) dst.Write([]byte(strconv.Itoa(int(n)))) case majorTypeByteString: s := decodeString(src, false) dst.Write(s) case majorTypeUtf8String: s := decodeUTF8String(src) dst.Write(s) case majorTypeArray: array2Json(src, dst) case majorTypeMap: map2Json(src, dst) case majorTypeTags: s := decodeTagData(src) dst.Write(s) case majorTypeSimpleAndFloat: s := decodeSimpleFloat(src) dst.Write(s) } } func moreBytesToRead(src *bufio.Reader) bool { _, e := src.ReadByte() if e == nil { src.UnreadByte() return true } return false } // Cbor2JsonManyObjects decodes all the CBOR Objects read from src // reader. It keeps on decoding until reader returns EOF (error when reading). // Decoded string is written to the dst. At the end of every CBOR Object // newline is written to the output stream. // // Returns error (if any) that was encountered during decode. // The child functions will generate a panic when error is encountered and // this function will recover non-runtime Errors and return the reason as error. func Cbor2JsonManyObjects(src io.Reader, dst io.Writer) (err error) { defer func() { if r := recover(); r != nil { if _, ok := r.(runtime.Error); ok { panic(r) } err = r.(error) } }() bufRdr := bufio.NewReader(src) for moreBytesToRead(bufRdr) { cbor2JsonOneObject(bufRdr, dst) dst.Write([]byte("\n")) } return nil } // Detect if the bytes to be printed is Binary or not. func binaryFmt(p []byte) bool { if len(p) > 0 && p[0] > 0x7F { return true } return false } func getReader(str string) *bufio.Reader { return bufio.NewReader(strings.NewReader(str)) } // DecodeIfBinaryToString converts a binary formatted log msg to a // JSON formatted String Log message - suitable for printing to Console/Syslog. func DecodeIfBinaryToString(in []byte) string { if binaryFmt(in) { var b bytes.Buffer Cbor2JsonManyObjects(strings.NewReader(string(in)), &b) return b.String() } return string(in) } // DecodeObjectToStr checks if the input is a binary format, if so, // it will decode a single Object and return the decoded string. func DecodeObjectToStr(in []byte) string { if binaryFmt(in) { var b bytes.Buffer cbor2JsonOneObject(getReader(string(in)), &b) return b.String() } return string(in) } // DecodeIfBinaryToBytes checks if the input is a binary format, if so, // it will decode all Objects and return the decoded string as byte array. func DecodeIfBinaryToBytes(in []byte) []byte { if binaryFmt(in) { var b bytes.Buffer Cbor2JsonManyObjects(bytes.NewReader(in), &b) return b.Bytes() } return in } zerolog-1.26.1/internal/cbor/decoder_test.go000066400000000000000000000151761415647605600210460ustar00rootroot00000000000000package cbor import ( "bytes" "encoding/hex" "testing" "time" ) func TestDecodeInteger(t *testing.T) { for _, tc := range integerTestCases { gotv := decodeInteger(getReader(tc.binary)) if gotv != int64(tc.val) { t.Errorf("decodeInteger(0x%s)=0x%d, want: 0x%d", hex.EncodeToString([]byte(tc.binary)), gotv, tc.val) } } } func TestDecodeString(t *testing.T) { for _, tt := range encodeStringTests { got := decodeUTF8String(getReader(tt.binary)) if string(got) != "\""+tt.json+"\"" { t.Errorf("DecodeString(0x%s)=%s, want:\"%s\"\n", hex.EncodeToString([]byte(tt.binary)), string(got), hex.EncodeToString([]byte(tt.json))) } } } func TestDecodeArray(t *testing.T) { for _, tc := range integerArrayTestCases { buf := bytes.NewBuffer([]byte{}) array2Json(getReader(tc.binary), buf) if buf.String() != tc.json { t.Errorf("array2Json(0x%s)=%s, want: %s", hex.EncodeToString([]byte(tc.binary)), buf.String(), tc.json) } } //Unspecified Length Array var infiniteArrayTestCases = []struct { in string out string }{ {"\x9f\x20\x00\x18\xc8\x14\xff", "[-1,0,200,20]"}, {"\x9f\x38\xc7\x29\x18\xc8\x19\x01\x90\xff", "[-200,-10,200,400]"}, {"\x9f\x01\x02\x03\xff", "[1,2,3]"}, {"\x9f\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x18\x18\x19\xff", "[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25]"}, } for _, tc := range infiniteArrayTestCases { buf := bytes.NewBuffer([]byte{}) array2Json(getReader(tc.in), buf) if buf.String() != tc.out { t.Errorf("array2Json(0x%s)=%s, want: %s", hex.EncodeToString([]byte(tc.out)), buf.String(), tc.out) } } for _, tc := range booleanArrayTestCases { buf := bytes.NewBuffer([]byte{}) array2Json(getReader(tc.binary), buf) if buf.String() != tc.json { t.Errorf("array2Json(0x%s)=%s, want: %s", hex.EncodeToString([]byte(tc.binary)), buf.String(), tc.json) } } //TODO add cases for arrays of other types } var infiniteMapDecodeTestCases = []struct { bin []byte json string }{ {[]byte("\xbf\x64IETF\x20\xff"), "{\"IETF\":-1}"}, {[]byte("\xbf\x65Array\x84\x20\x00\x18\xc8\x14\xff"), "{\"Array\":[-1,0,200,20]}"}, } var mapDecodeTestCases = []struct { bin []byte json string }{ {[]byte("\xa2\x64IETF\x20"), "{\"IETF\":-1}"}, {[]byte("\xa2\x65Array\x84\x20\x00\x18\xc8\x14"), "{\"Array\":[-1,0,200,20]}"}, } func TestDecodeMap(t *testing.T) { for _, tc := range mapDecodeTestCases { buf := bytes.NewBuffer([]byte{}) map2Json(getReader(string(tc.bin)), buf) if buf.String() != tc.json { t.Errorf("map2Json(0x%s)=%s, want: %s", hex.EncodeToString(tc.bin), buf.String(), tc.json) } } for _, tc := range infiniteMapDecodeTestCases { buf := bytes.NewBuffer([]byte{}) map2Json(getReader(string(tc.bin)), buf) if buf.String() != tc.json { t.Errorf("map2Json(0x%s)=%s, want: %s", hex.EncodeToString(tc.bin), buf.String(), tc.json) } } } func TestDecodeBool(t *testing.T) { for _, tc := range booleanTestCases { got := decodeSimpleFloat(getReader(tc.binary)) if string(got) != tc.json { t.Errorf("decodeSimpleFloat(0x%s)=%s, want:%s", hex.EncodeToString([]byte(tc.binary)), string(got), tc.json) } } } func TestDecodeFloat(t *testing.T) { for _, tc := range float32TestCases { got, _ := decodeFloat(getReader(tc.binary)) if got != float64(tc.val) { t.Errorf("decodeFloat(0x%s)=%f, want:%f", hex.EncodeToString([]byte(tc.binary)), got, tc.val) } } } func TestDecodeTimestamp(t *testing.T) { decodeTimeZone, _ = time.LoadLocation("UTC") for _, tc := range timeIntegerTestcases { tm := decodeTagData(getReader(tc.binary)) if string(tm) != "\""+tc.rfcStr+"\"" { t.Errorf("decodeFloat(0x%s)=%s, want:%s", hex.EncodeToString([]byte(tc.binary)), tm, tc.rfcStr) } } for _, tc := range timeFloatTestcases { tm := decodeTagData(getReader(tc.out)) //Since we convert to float and back - it may be slightly off - so //we cannot check for exact equality instead, we'll check it is //very close to each other Less than a Microsecond (lets not yet do nanosec) got, _ := time.Parse(string(tm), string(tm)) want, _ := time.Parse(tc.rfcStr, tc.rfcStr) if got.Sub(want) > time.Microsecond { t.Errorf("decodeFloat(0x%s)=%s, want:%s", hex.EncodeToString([]byte(tc.out)), tm, tc.rfcStr) } } } func TestDecodeNetworkAddr(t *testing.T) { for _, tc := range ipAddrTestCases { d1 := decodeTagData(getReader(tc.binary)) if string(d1) != tc.text { t.Errorf("decodeNetworkAddr(0x%s)=%s, want:%s", hex.EncodeToString([]byte(tc.binary)), d1, tc.text) } } } func TestDecodeMACAddr(t *testing.T) { for _, tc := range macAddrTestCases { d1 := decodeTagData(getReader(tc.binary)) if string(d1) != tc.text { t.Errorf("decodeNetworkAddr(0x%s)=%s, want:%s", hex.EncodeToString([]byte(tc.binary)), d1, tc.text) } } } func TestDecodeIPPrefix(t *testing.T) { for _, tc := range IPPrefixTestCases { d1 := decodeTagData(getReader(tc.binary)) if string(d1) != tc.text { t.Errorf("decodeIPPrefix(0x%s)=%s, want:%s", hex.EncodeToString([]byte(tc.binary)), d1, tc.text) } } } var compositeCborTestCases = []struct { binary []byte json string }{ {[]byte("\xbf\x64IETF\x20\x65Array\x9f\x20\x00\x18\xc8\x14\xff\xff"), "{\"IETF\":-1,\"Array\":[-1,0,200,20]}\n"}, {[]byte("\xbf\x64IETF\x64YES!\x65Array\x9f\x20\x00\x18\xc8\x14\xff\xff"), "{\"IETF\":\"YES!\",\"Array\":[-1,0,200,20]}\n"}, } func TestDecodeCbor2Json(t *testing.T) { for _, tc := range compositeCborTestCases { buf := bytes.NewBuffer([]byte{}) err := Cbor2JsonManyObjects(getReader(string(tc.binary)), buf) if buf.String() != tc.json || err != nil { t.Errorf("cbor2JsonManyObjects(0x%s)=%s, want: %s, err:%s", hex.EncodeToString(tc.binary), buf.String(), tc.json, err.Error()) } } } var negativeCborTestCases = []struct { binary []byte errStr string }{ {[]byte("\xb9\x64IETF\x20\x65Array\x9f\x20\x00\x18\xc8\x14"), "Tried to Read 18 Bytes.. But hit end of file"}, {[]byte("\xbf\x64IETF\x20\x65Array\x9f\x20\x00\x18\xc8\x14"), "EOF"}, {[]byte("\xbf\x14IETF\x20\x65Array\x9f\x20\x00\x18\xc8\x14"), "Tried to Read 40736 Bytes.. But hit end of file"}, {[]byte("\xbf\x64IETF"), "EOF"}, {[]byte("\xbf\x64IETF\x20\x65Array\x9f\x20\x00\x18\xc8\xff\xff\xff"), "Invalid Additional Type: 31 in decodeSimpleFloat"}, {[]byte("\xbf\x64IETF\x20\x65Array"), "EOF"}, {[]byte("\xbf\x64"), "Tried to Read 4 Bytes.. But hit end of file"}, } func TestDecodeNegativeCbor2Json(t *testing.T) { for _, tc := range negativeCborTestCases { buf := bytes.NewBuffer([]byte{}) err := Cbor2JsonManyObjects(getReader(string(tc.binary)), buf) if err == nil || err.Error() != tc.errStr { t.Errorf("Expected error got:%s, want:%s", err, tc.errStr) } } } zerolog-1.26.1/internal/cbor/examples/000077500000000000000000000000001415647605600176575ustar00rootroot00000000000000zerolog-1.26.1/internal/cbor/examples/genLog.go000066400000000000000000000021071415647605600214210ustar00rootroot00000000000000package main import ( "compress/zlib" "flag" "io" "log" "os" "time" "github.com/rs/zerolog" ) func writeLog(fname string, count int, useCompress bool) { opFile := os.Stdout if fname != "" { fil, _ := os.Create(fname) opFile = fil defer func() { if err := fil.Close(); err != nil { log.Fatal(err) } }() } var f io.WriteCloser = opFile if useCompress { f = zlib.NewWriter(f) defer func() { if err := f.Close(); err != nil { log.Fatal(err) } }() } zerolog.TimestampFunc = func() time.Time { return time.Now().Round(time.Second) } log := zerolog.New(f).With(). Timestamp(). Logger() for i := 0; i < count; i++ { log.Error(). Int("Fault", 41650+i).Msg("Some Message") } } func main() { outFile := flag.String("out", "", "Output File to which logs will be written to (WILL overwrite if already present).") numLogs := flag.Int("num", 10, "Number of log messages to generate.") doCompress := flag.Bool("compress", false, "Enable inline compressed writer") flag.Parse() writeLog(*outFile, *numLogs, *doCompress) } zerolog-1.26.1/internal/cbor/examples/makefile000066400000000000000000000003051415647605600213550ustar00rootroot00000000000000all: genLogJSON genLogCBOR genLogJSON: genLog.go go build -o genLogJSON genLog.go genLogCBOR: genLog.go go build -tags binary_log -o genLogCBOR genLog.go clean: rm -f genLogJSON genLogCBOR zerolog-1.26.1/internal/cbor/string.go000066400000000000000000000045571415647605600177110ustar00rootroot00000000000000package cbor import "fmt" // AppendStrings encodes and adds an array of strings to the dst byte array. func (e Encoder) AppendStrings(dst []byte, vals []string) []byte { major := majorTypeArray l := len(vals) if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendString(dst, v) } return dst } // AppendString encodes and adds a string to the dst byte array. func (Encoder) AppendString(dst []byte, s string) []byte { major := majorTypeUtf8String l := len(s) if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, majorTypeUtf8String, uint64(l)) } return append(dst, s...) } // AppendStringers encodes and adds an array of Stringer values // to the dst byte array. func (e Encoder) AppendStringers(dst []byte, vals []fmt.Stringer) []byte { if len(vals) == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } dst = e.AppendArrayStart(dst) dst = e.AppendStringer(dst, vals[0]) if len(vals) > 1 { for _, val := range vals[1:] { dst = e.AppendStringer(dst, val) } } return e.AppendArrayEnd(dst) } // AppendStringer encodes and adds the Stringer value to the dst // byte array. func (e Encoder) AppendStringer(dst []byte, val fmt.Stringer) []byte { if val == nil { return e.AppendNil(dst) } return e.AppendString(dst, val.String()) } // AppendBytes encodes and adds an array of bytes to the dst byte array. func (Encoder) AppendBytes(dst, s []byte) []byte { major := majorTypeByteString l := len(s) if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } return append(dst, s...) } // AppendEmbeddedJSON adds a tag and embeds input JSON as such. func AppendEmbeddedJSON(dst, s []byte) []byte { major := majorTypeTags minor := additionalTypeEmbeddedJSON // Append the TAG to indicate this is Embedded JSON. dst = append(dst, byte(major|additionalTypeIntUint16)) dst = append(dst, byte(minor>>8)) dst = append(dst, byte(minor&0xff)) // Append the JSON Object as Byte String. major = majorTypeByteString l := len(s) if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } return append(dst, s...) } zerolog-1.26.1/internal/cbor/string_test.go000066400000000000000000000112511415647605600207350ustar00rootroot00000000000000package cbor import ( "bytes" "testing" ) var encodeStringTests = []struct { plain string binary string json string //begin and end quotes are implied }{ {"", "\x60", ""}, {"\\", "\x61\x5c", "\\\\"}, {"\x00", "\x61\x00", "\\u0000"}, {"\x01", "\x61\x01", "\\u0001"}, {"\x02", "\x61\x02", "\\u0002"}, {"\x03", "\x61\x03", "\\u0003"}, {"\x04", "\x61\x04", "\\u0004"}, {"*", "\x61*", "*"}, {"a", "\x61a", "a"}, {"IETF", "\x64IETF", "IETF"}, {"abcdefghijklmnopqrstuvwxyzABCD", "\x78\x1eabcdefghijklmnopqrstuvwxyzABCD", "abcdefghijklmnopqrstuvwxyzABCD"}, {"<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->", "\x79\x01\x2c<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->", "<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->"}, {"emoji \u2764\ufe0f!", "\x6demoji ❤️!", "emoji \u2764\ufe0f!"}, } var encodeByteTests = []struct { plain []byte binary string }{ {[]byte{}, "\x40"}, {[]byte("\\"), "\x41\x5c"}, {[]byte("\x00"), "\x41\x00"}, {[]byte("\x01"), "\x41\x01"}, {[]byte("\x02"), "\x41\x02"}, {[]byte("\x03"), "\x41\x03"}, {[]byte("\x04"), "\x41\x04"}, {[]byte("*"), "\x41*"}, {[]byte("a"), "\x41a"}, {[]byte("IETF"), "\x44IETF"}, {[]byte("abcdefghijklmnopqrstuvwxyzABCD"), "\x58\x1eabcdefghijklmnopqrstuvwxyzABCD"}, {[]byte("<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->"), "\x59\x01\x2c<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->" + "<------------------------------------ This is a 100 character string ----------------------------->"}, {[]byte("emoji \u2764\ufe0f!"), "\x4demoji ❤️!"}, } func TestAppendString(t *testing.T) { for _, tt := range encodeStringTests { b := enc.AppendString([]byte{}, tt.plain) if got, want := string(b), tt.binary; got != want { t.Errorf("appendString(%q) = %#q, want %#q", tt.plain, got, want) } } //Test a large string > 65535 length var buffer bytes.Buffer for i := 0; i < 0x00011170; i++ { //70,000 character string buffer.WriteString("a") } inp := buffer.String() want := "\x7a\x00\x01\x11\x70" + inp b := enc.AppendString([]byte{}, inp) if got := string(b); got != want { t.Errorf("appendString(%q) = %#q, want %#q", inp, got, want) } } func TestAppendBytes(t *testing.T) { for _, tt := range encodeByteTests { b := enc.AppendBytes([]byte{}, tt.plain) if got, want := string(b), tt.binary; got != want { t.Errorf("appendString(%q) = %#q, want %#q", tt.plain, got, want) } } //Test a large string > 65535 length inp := []byte{} for i := 0; i < 0x00011170; i++ { //70,000 character string inp = append(inp, byte('a')) } want := "\x5a\x00\x01\x11\x70" + string(inp) b := enc.AppendBytes([]byte{}, inp) if got := string(b); got != want { t.Errorf("appendString(%q) = %#q, want %#q", inp, got, want) } } func BenchmarkAppendString(b *testing.B) { tests := map[string]string{ "NoEncoding": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingFirst": `"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingMiddle": `aaaaaaaaaaaaaaaaaaaaaaaaa"aaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingLast": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"`, "MultiBytesFirst": `❤️aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "MultiBytesMiddle": `aaaaaaaaaaaaaaaaaaaaaaaaa❤️aaaaaaaaaaaaaaaaaaaaaaaa`, "MultiBytesLast": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa❤️`, } for name, str := range tests { b.Run(name, func(b *testing.B) { buf := make([]byte, 0, 120) for i := 0; i < b.N; i++ { _ = enc.AppendString(buf, str) } }) } } zerolog-1.26.1/internal/cbor/time.go000066400000000000000000000050011415647605600173220ustar00rootroot00000000000000package cbor import ( "time" ) func appendIntegerTimestamp(dst []byte, t time.Time) []byte { major := majorTypeTags minor := additionalTypeTimestamp dst = append(dst, byte(major|minor)) secs := t.Unix() var val uint64 if secs < 0 { major = majorTypeNegativeInt val = uint64(-secs - 1) } else { major = majorTypeUnsignedInt val = uint64(secs) } dst = appendCborTypePrefix(dst, major, uint64(val)) return dst } func (e Encoder) appendFloatTimestamp(dst []byte, t time.Time) []byte { major := majorTypeTags minor := additionalTypeTimestamp dst = append(dst, byte(major|minor)) secs := t.Unix() nanos := t.Nanosecond() var val float64 val = float64(secs)*1.0 + float64(nanos)*1E-9 return e.AppendFloat64(dst, val) } // AppendTime encodes and adds a timestamp to the dst byte array. func (e Encoder) AppendTime(dst []byte, t time.Time, unused string) []byte { utc := t.UTC() if utc.Nanosecond() == 0 { return appendIntegerTimestamp(dst, utc) } return e.appendFloatTimestamp(dst, utc) } // AppendTimes encodes and adds an array of timestamps to the dst byte array. func (e Encoder) AppendTimes(dst []byte, vals []time.Time, unused string) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, t := range vals { dst = e.AppendTime(dst, t, unused) } return dst } // AppendDuration encodes and adds a duration to the dst byte array. // useInt field indicates whether to store the duration as seconds (integer) or // as seconds+nanoseconds (float). func (e Encoder) AppendDuration(dst []byte, d time.Duration, unit time.Duration, useInt bool) []byte { if useInt { return e.AppendInt64(dst, int64(d/unit)) } return e.AppendFloat64(dst, float64(d)/float64(unit)) } // AppendDurations encodes and adds an array of durations to the dst byte array. // useInt field indicates whether to store the duration as seconds (integer) or // as seconds+nanoseconds (float). func (e Encoder) AppendDurations(dst []byte, vals []time.Duration, unit time.Duration, useInt bool) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, d := range vals { dst = e.AppendDuration(dst, d, unit, useInt) } return dst } zerolog-1.26.1/internal/cbor/time_test.go000066400000000000000000000050371415647605600203720ustar00rootroot00000000000000package cbor import ( "encoding/hex" "fmt" "math" "testing" "time" ) func TestAppendTimeNow(t *testing.T) { tm := time.Now() s := enc.AppendTime([]byte{}, tm, "unused") got := string(s) tm1 := float64(tm.Unix()) + float64(tm.Nanosecond())*1E-9 tm2 := math.Float64bits(tm1) var tm3 [8]byte for i := uint(0); i < 8; i++ { tm3[i] = byte(tm2 >> ((8 - i - 1) * 8)) } want := append([]byte{0xc1, 0xfb}, tm3[:]...) if got != string(want) { t.Errorf("Appendtime(%s)=0x%s, want: 0x%s", "time.Now()", hex.EncodeToString(s), hex.EncodeToString(want)) } } var timeIntegerTestcases = []struct { txt string binary string rfcStr string }{ {"2013-02-03T19:54:00-08:00", "\xc1\x1a\x51\x0f\x30\xd8", "2013-02-04T03:54:00Z"}, {"1950-02-03T19:54:00-08:00", "\xc1\x3a\x25\x71\x93\xa7", "1950-02-04T03:54:00Z"}, } func TestAppendTimePastPresentInteger(t *testing.T) { for _, tt := range timeIntegerTestcases { tin, err := time.Parse(time.RFC3339, tt.txt) if err != nil { fmt.Println("Cannot parse input", tt.txt, ".. Skipping!", err) continue } b := enc.AppendTime([]byte{}, tin, "unused") if got, want := string(b), tt.binary; got != want { t.Errorf("appendString(%s) = 0x%s, want 0x%s", tt.txt, hex.EncodeToString(b), hex.EncodeToString([]byte(want))) } } } var timeFloatTestcases = []struct { rfcStr string out string }{ {"2006-01-02T15:04:05.999999-08:00", "\xc1\xfb\x41\xd0\xee\x6c\x59\x7f\xff\xfc"}, {"1956-01-02T15:04:05.999999-08:00", "\xc1\xfb\xc1\xba\x53\x81\x1a\x00\x00\x11"}, } func TestAppendTimePastPresentFloat(t *testing.T) { const timeFloatFmt = "2006-01-02T15:04:05.999999-07:00" for _, tt := range timeFloatTestcases { tin, err := time.Parse(timeFloatFmt, tt.rfcStr) if err != nil { fmt.Println("Cannot parse input", tt.rfcStr, ".. Skipping!") continue } b := enc.AppendTime([]byte{}, tin, "unused") if got, want := string(b), tt.out; got != want { t.Errorf("appendString(%s) = 0x%s, want 0x%s", tt.rfcStr, hex.EncodeToString(b), hex.EncodeToString([]byte(want))) } } } func BenchmarkAppendTime(b *testing.B) { tests := map[string]string{ "Integer": "Feb 3, 2013 at 7:54pm (PST)", "Float": "2006-01-02T15:04:05.999999-08:00", } const timeFloatFmt = "2006-01-02T15:04:05.999999-07:00" for name, str := range tests { t, err := time.Parse(time.RFC3339, str) if err != nil { t, _ = time.Parse(timeFloatFmt, str) } b.Run(name, func(b *testing.B) { buf := make([]byte, 0, 100) for i := 0; i < b.N; i++ { _ = enc.AppendTime(buf, t, "unused") } }) } } zerolog-1.26.1/internal/cbor/types.go000066400000000000000000000331761415647605600175460ustar00rootroot00000000000000package cbor import ( "fmt" "math" "net" ) // AppendNil inserts a 'Nil' object into the dst byte array. func (Encoder) AppendNil(dst []byte) []byte { return append(dst, byte(majorTypeSimpleAndFloat|additionalTypeNull)) } // AppendBeginMarker inserts a map start into the dst byte array. func (Encoder) AppendBeginMarker(dst []byte) []byte { return append(dst, byte(majorTypeMap|additionalTypeInfiniteCount)) } // AppendEndMarker inserts a map end into the dst byte array. func (Encoder) AppendEndMarker(dst []byte) []byte { return append(dst, byte(majorTypeSimpleAndFloat|additionalTypeBreak)) } // AppendObjectData takes an object in form of a byte array and appends to dst. func (Encoder) AppendObjectData(dst []byte, o []byte) []byte { // BeginMarker is present in the dst, which // should not be copied when appending to existing data. return append(dst, o[1:]...) } // AppendArrayStart adds markers to indicate the start of an array. func (Encoder) AppendArrayStart(dst []byte) []byte { return append(dst, byte(majorTypeArray|additionalTypeInfiniteCount)) } // AppendArrayEnd adds markers to indicate the end of an array. func (Encoder) AppendArrayEnd(dst []byte) []byte { return append(dst, byte(majorTypeSimpleAndFloat|additionalTypeBreak)) } // AppendArrayDelim adds markers to indicate end of a particular array element. func (Encoder) AppendArrayDelim(dst []byte) []byte { //No delimiters needed in cbor return dst } // AppendLineBreak is a noop that keep API compat with json encoder. func (Encoder) AppendLineBreak(dst []byte) []byte { // No line breaks needed in binary format. return dst } // AppendBool encodes and inserts a boolean value into the dst byte array. func (Encoder) AppendBool(dst []byte, val bool) []byte { b := additionalTypeBoolFalse if val { b = additionalTypeBoolTrue } return append(dst, byte(majorTypeSimpleAndFloat|b)) } // AppendBools encodes and inserts an array of boolean values into the dst byte array. func (e Encoder) AppendBools(dst []byte, vals []bool) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendBool(dst, v) } return dst } // AppendInt encodes and inserts an integer value into the dst byte array. func (Encoder) AppendInt(dst []byte, val int) []byte { major := majorTypeUnsignedInt contentVal := val if val < 0 { major = majorTypeNegativeInt contentVal = -val - 1 } if contentVal <= additionalMax { lb := byte(contentVal) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(contentVal)) } return dst } // AppendInts encodes and inserts an array of integer values into the dst byte array. func (e Encoder) AppendInts(dst []byte, vals []int) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendInt(dst, v) } return dst } // AppendInt8 encodes and inserts an int8 value into the dst byte array. func (e Encoder) AppendInt8(dst []byte, val int8) []byte { return e.AppendInt(dst, int(val)) } // AppendInts8 encodes and inserts an array of integer values into the dst byte array. func (e Encoder) AppendInts8(dst []byte, vals []int8) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendInt(dst, int(v)) } return dst } // AppendInt16 encodes and inserts a int16 value into the dst byte array. func (e Encoder) AppendInt16(dst []byte, val int16) []byte { return e.AppendInt(dst, int(val)) } // AppendInts16 encodes and inserts an array of int16 values into the dst byte array. func (e Encoder) AppendInts16(dst []byte, vals []int16) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendInt(dst, int(v)) } return dst } // AppendInt32 encodes and inserts a int32 value into the dst byte array. func (e Encoder) AppendInt32(dst []byte, val int32) []byte { return e.AppendInt(dst, int(val)) } // AppendInts32 encodes and inserts an array of int32 values into the dst byte array. func (e Encoder) AppendInts32(dst []byte, vals []int32) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendInt(dst, int(v)) } return dst } // AppendInt64 encodes and inserts a int64 value into the dst byte array. func (Encoder) AppendInt64(dst []byte, val int64) []byte { major := majorTypeUnsignedInt contentVal := val if val < 0 { major = majorTypeNegativeInt contentVal = -val - 1 } if contentVal <= additionalMax { lb := byte(contentVal) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(contentVal)) } return dst } // AppendInts64 encodes and inserts an array of int64 values into the dst byte array. func (e Encoder) AppendInts64(dst []byte, vals []int64) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendInt64(dst, v) } return dst } // AppendUint encodes and inserts an unsigned integer value into the dst byte array. func (e Encoder) AppendUint(dst []byte, val uint) []byte { return e.AppendInt64(dst, int64(val)) } // AppendUints encodes and inserts an array of unsigned integer values into the dst byte array. func (e Encoder) AppendUints(dst []byte, vals []uint) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendUint(dst, v) } return dst } // AppendUint8 encodes and inserts a unsigned int8 value into the dst byte array. func (e Encoder) AppendUint8(dst []byte, val uint8) []byte { return e.AppendUint(dst, uint(val)) } // AppendUints8 encodes and inserts an array of uint8 values into the dst byte array. func (e Encoder) AppendUints8(dst []byte, vals []uint8) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendUint8(dst, v) } return dst } // AppendUint16 encodes and inserts a uint16 value into the dst byte array. func (e Encoder) AppendUint16(dst []byte, val uint16) []byte { return e.AppendUint(dst, uint(val)) } // AppendUints16 encodes and inserts an array of uint16 values into the dst byte array. func (e Encoder) AppendUints16(dst []byte, vals []uint16) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendUint16(dst, v) } return dst } // AppendUint32 encodes and inserts a uint32 value into the dst byte array. func (e Encoder) AppendUint32(dst []byte, val uint32) []byte { return e.AppendUint(dst, uint(val)) } // AppendUints32 encodes and inserts an array of uint32 values into the dst byte array. func (e Encoder) AppendUints32(dst []byte, vals []uint32) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendUint32(dst, v) } return dst } // AppendUint64 encodes and inserts a uint64 value into the dst byte array. func (Encoder) AppendUint64(dst []byte, val uint64) []byte { major := majorTypeUnsignedInt contentVal := val if contentVal <= additionalMax { lb := byte(contentVal) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(contentVal)) } return dst } // AppendUints64 encodes and inserts an array of uint64 values into the dst byte array. func (e Encoder) AppendUints64(dst []byte, vals []uint64) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendUint64(dst, v) } return dst } // AppendFloat32 encodes and inserts a single precision float value into the dst byte array. func (Encoder) AppendFloat32(dst []byte, val float32) []byte { switch { case math.IsNaN(float64(val)): return append(dst, "\xfa\x7f\xc0\x00\x00"...) case math.IsInf(float64(val), 1): return append(dst, "\xfa\x7f\x80\x00\x00"...) case math.IsInf(float64(val), -1): return append(dst, "\xfa\xff\x80\x00\x00"...) } major := majorTypeSimpleAndFloat subType := additionalTypeFloat32 n := math.Float32bits(val) var buf [4]byte for i := uint(0); i < 4; i++ { buf[i] = byte(n >> ((3 - i) * 8)) } return append(append(dst, byte(major|subType)), buf[0], buf[1], buf[2], buf[3]) } // AppendFloats32 encodes and inserts an array of single precision float value into the dst byte array. func (e Encoder) AppendFloats32(dst []byte, vals []float32) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendFloat32(dst, v) } return dst } // AppendFloat64 encodes and inserts a double precision float value into the dst byte array. func (Encoder) AppendFloat64(dst []byte, val float64) []byte { switch { case math.IsNaN(val): return append(dst, "\xfb\x7f\xf8\x00\x00\x00\x00\x00\x00"...) case math.IsInf(val, 1): return append(dst, "\xfb\x7f\xf0\x00\x00\x00\x00\x00\x00"...) case math.IsInf(val, -1): return append(dst, "\xfb\xff\xf0\x00\x00\x00\x00\x00\x00"...) } major := majorTypeSimpleAndFloat subType := additionalTypeFloat64 n := math.Float64bits(val) dst = append(dst, byte(major|subType)) for i := uint(1); i <= 8; i++ { b := byte(n >> ((8 - i) * 8)) dst = append(dst, b) } return dst } // AppendFloats64 encodes and inserts an array of double precision float values into the dst byte array. func (e Encoder) AppendFloats64(dst []byte, vals []float64) []byte { major := majorTypeArray l := len(vals) if l == 0 { return e.AppendArrayEnd(e.AppendArrayStart(dst)) } if l <= additionalMax { lb := byte(l) dst = append(dst, byte(major|lb)) } else { dst = appendCborTypePrefix(dst, major, uint64(l)) } for _, v := range vals { dst = e.AppendFloat64(dst, v) } return dst } // AppendInterface takes an arbitrary object and converts it to JSON and embeds it dst. func (e Encoder) AppendInterface(dst []byte, i interface{}) []byte { marshaled, err := JSONMarshalFunc(i) if err != nil { return e.AppendString(dst, fmt.Sprintf("marshaling error: %v", err)) } return AppendEmbeddedJSON(dst, marshaled) } // AppendIPAddr encodes and inserts an IP Address (IPv4 or IPv6). func (e Encoder) AppendIPAddr(dst []byte, ip net.IP) []byte { dst = append(dst, byte(majorTypeTags|additionalTypeIntUint16)) dst = append(dst, byte(additionalTypeTagNetworkAddr>>8)) dst = append(dst, byte(additionalTypeTagNetworkAddr&0xff)) return e.AppendBytes(dst, ip) } // AppendIPPrefix encodes and inserts an IP Address Prefix (Address + Mask Length). func (e Encoder) AppendIPPrefix(dst []byte, pfx net.IPNet) []byte { dst = append(dst, byte(majorTypeTags|additionalTypeIntUint16)) dst = append(dst, byte(additionalTypeTagNetworkPrefix>>8)) dst = append(dst, byte(additionalTypeTagNetworkPrefix&0xff)) // Prefix is a tuple (aka MAP of 1 pair of elements) - // first element is prefix, second is mask length. dst = append(dst, byte(majorTypeMap|0x1)) dst = e.AppendBytes(dst, pfx.IP) maskLen, _ := pfx.Mask.Size() return e.AppendUint8(dst, uint8(maskLen)) } // AppendMACAddr encodes and inserts an Hardware (MAC) address. func (e Encoder) AppendMACAddr(dst []byte, ha net.HardwareAddr) []byte { dst = append(dst, byte(majorTypeTags|additionalTypeIntUint16)) dst = append(dst, byte(additionalTypeTagNetworkAddr>>8)) dst = append(dst, byte(additionalTypeTagNetworkAddr&0xff)) return e.AppendBytes(dst, ha) } // AppendHex adds a TAG and inserts a hex bytes as a string. func (e Encoder) AppendHex(dst []byte, val []byte) []byte { dst = append(dst, byte(majorTypeTags|additionalTypeIntUint16)) dst = append(dst, byte(additionalTypeTagHexString>>8)) dst = append(dst, byte(additionalTypeTagHexString&0xff)) return e.AppendBytes(dst, val) } zerolog-1.26.1/internal/cbor/types_64_test.go000066400000000000000000000013561415647605600211110ustar00rootroot00000000000000// +build !386 package cbor import ( "encoding/hex" "testing" ) var enc2 = Encoder{} var integerTestCases_64bit = []struct { val int binary string }{ // Value in 8 bytes. {0xabcd100000000, "\x1b\x00\x0a\xbc\xd1\x00\x00\x00\x00"}, {1000000000000, "\x1b\x00\x00\x00\xe8\xd4\xa5\x10\x00"}, // Value in 8 bytes. {-0xabcd100000001, "\x3b\x00\x0a\xbc\xd1\x00\x00\x00\x00"}, {-1000000000001, "\x3b\x00\x00\x00\xe8\xd4\xa5\x10\x00"}, } func TestAppendInt_64bit(t *testing.T) { for _, tc := range integerTestCases_64bit { s := enc2.AppendInt([]byte{}, tc.val) got := string(s) if got != tc.binary { t.Errorf("AppendInt(0x%x)=0x%s, want: 0x%s", tc.val, hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } zerolog-1.26.1/internal/cbor/types_test.go000066400000000000000000000201061415647605600205720ustar00rootroot00000000000000package cbor import ( "encoding/hex" "net" "testing" ) var enc = Encoder{} func TestAppendNil(t *testing.T) { s := enc.AppendNil([]byte{}) got := string(s) want := "\xf6" if got != want { t.Errorf("appendNull() = 0x%s, want: 0x%s", hex.EncodeToString(s), hex.EncodeToString([]byte(want))) } } var booleanTestCases = []struct { val bool binary string json string }{ {true, "\xf5", "true"}, {false, "\xf4", "false"}, } func TestAppendBool(t *testing.T) { for _, tc := range booleanTestCases { s := enc.AppendBool([]byte{}, tc.val) got := string(s) if got != tc.binary { t.Errorf("AppendBool(%s)=0x%s, want: 0x%s", tc.json, hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } var booleanArrayTestCases = []struct { val []bool binary string json string }{ {[]bool{true, false, true}, "\x83\xf5\xf4\xf5", "[true,false,true]"}, {[]bool{true, false, false, true, false, true}, "\x86\xf5\xf4\xf4\xf5\xf4\xf5", "[true,false,false,true,false,true]"}, } func TestAppendBoolArray(t *testing.T) { for _, tc := range booleanArrayTestCases { s := enc.AppendBools([]byte{}, tc.val) got := string(s) if got != tc.binary { t.Errorf("AppendBools(%s)=0x%s, want: 0x%s", tc.json, hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } var integerTestCases = []struct { val int binary string }{ // Value included in the type. {0, "\x00"}, {1, "\x01"}, {2, "\x02"}, {3, "\x03"}, {8, "\x08"}, {9, "\x09"}, {10, "\x0a"}, {22, "\x16"}, {23, "\x17"}, // Value in 1 byte. {24, "\x18\x18"}, {25, "\x18\x19"}, {26, "\x18\x1a"}, {100, "\x18\x64"}, {254, "\x18\xfe"}, {255, "\x18\xff"}, // Value in 2 bytes. {256, "\x19\x01\x00"}, {257, "\x19\x01\x01"}, {1000, "\x19\x03\xe8"}, {0xFFFF, "\x19\xff\xff"}, // Value in 4 bytes. {0x10000, "\x1a\x00\x01\x00\x00"}, {0x7FFFFFFE, "\x1a\x7f\xff\xff\xfe"}, {1000000, "\x1a\x00\x0f\x42\x40"}, // Negative number test cases. // Value included in the type. {-1, "\x20"}, {-2, "\x21"}, {-3, "\x22"}, {-10, "\x29"}, {-21, "\x34"}, {-22, "\x35"}, {-23, "\x36"}, {-24, "\x37"}, // Value in 1 byte. {-25, "\x38\x18"}, {-26, "\x38\x19"}, {-100, "\x38\x63"}, {-254, "\x38\xfd"}, {-255, "\x38\xfe"}, {-256, "\x38\xff"}, // Value in 2 bytes. {-257, "\x39\x01\x00"}, {-258, "\x39\x01\x01"}, {-1000, "\x39\x03\xe7"}, // Value in 4 bytes. {-0x10001, "\x3a\x00\x01\x00\x00"}, {-0x7FFFFFFE, "\x3a\x7f\xff\xff\xfd"}, {-1000000, "\x3a\x00\x0f\x42\x3f"}, } func TestAppendInt(t *testing.T) { for _, tc := range integerTestCases { s := enc.AppendInt([]byte{}, tc.val) got := string(s) if got != tc.binary { t.Errorf("AppendInt(0x%x)=0x%s, want: 0x%s", tc.val, hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } var integerArrayTestCases = []struct { val []int binary string json string }{ {[]int{-1, 0, 200, 20}, "\x84\x20\x00\x18\xc8\x14", "[-1,0,200,20]"}, {[]int{-200, -10, 200, 400}, "\x84\x38\xc7\x29\x18\xc8\x19\x01\x90", "[-200,-10,200,400]"}, {[]int{1, 2, 3}, "\x83\x01\x02\x03", "[1,2,3]"}, {[]int{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25}, "\x98\x19\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x18\x18\x19", "[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25]"}, } func TestAppendIntArray(t *testing.T) { for _, tc := range integerArrayTestCases { s := enc.AppendInts([]byte{}, tc.val) got := string(s) if got != tc.binary { t.Errorf("AppendInts(%s)=0x%s, want: 0x%s", tc.json, hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } var float32TestCases = []struct { val float32 binary string }{ {0.0, "\xfa\x00\x00\x00\x00"}, {-0.0, "\xfa\x00\x00\x00\x00"}, {1.0, "\xfa\x3f\x80\x00\x00"}, {1.5, "\xfa\x3f\xc0\x00\x00"}, {65504.0, "\xfa\x47\x7f\xe0\x00"}, {-4.0, "\xfa\xc0\x80\x00\x00"}, {0.00006103515625, "\xfa\x38\x80\x00\x00"}, } func TestAppendFloat32(t *testing.T) { for _, tc := range float32TestCases { s := enc.AppendFloat32([]byte{}, tc.val) got := string(s) if got != tc.binary { t.Errorf("AppendFloat32(%f)=0x%s, want: 0x%s", tc.val, hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } var ipAddrTestCases = []struct { ipaddr net.IP text string // ASCII representation of ipaddr binary string // CBOR representation of ipaddr }{ {net.IP{10, 0, 0, 1}, "\"10.0.0.1\"", "\xd9\x01\x04\x44\x0a\x00\x00\x01"}, {net.IP{0x20, 0x01, 0x0d, 0xb8, 0x85, 0xa3, 0x0, 0x0, 0x0, 0x0, 0x8a, 0x2e, 0x03, 0x70, 0x73, 0x34}, "\"2001:db8:85a3::8a2e:370:7334\"", "\xd9\x01\x04\x50\x20\x01\x0d\xb8\x85\xa3\x00\x00\x00\x00\x8a\x2e\x03\x70\x73\x34"}, } func TestAppendNetworkAddr(t *testing.T) { for _, tc := range ipAddrTestCases { s := enc.AppendIPAddr([]byte{}, tc.ipaddr) got := string(s) if got != tc.binary { t.Errorf("AppendIPAddr(%s)=0x%s, want: 0x%s", tc.ipaddr, hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } var macAddrTestCases = []struct { macaddr net.HardwareAddr text string // ASCII representation of macaddr binary string // CBOR representation of macaddr }{ {net.HardwareAddr{0x12, 0x34, 0x56, 0x78, 0x90, 0xab}, "\"12:34:56:78:90:ab\"", "\xd9\x01\x04\x46\x12\x34\x56\x78\x90\xab"}, {net.HardwareAddr{0x20, 0x01, 0x0d, 0xb8, 0x85, 0xa3}, "\"20:01:0d:b8:85:a3\"", "\xd9\x01\x04\x46\x20\x01\x0d\xb8\x85\xa3"}, } func TestAppendMacAddr(t *testing.T) { for _, tc := range macAddrTestCases { s := enc.AppendMACAddr([]byte{}, tc.macaddr) got := string(s) if got != tc.binary { t.Errorf("AppendMACAddr(%s)=0x%s, want: 0x%s", tc.macaddr.String(), hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } var IPPrefixTestCases = []struct { pfx net.IPNet text string // ASCII representation of pfx binary string // CBOR representation of pfx }{ {net.IPNet{IP: net.IP{0, 0, 0, 0}, Mask: net.CIDRMask(0, 32)}, "\"0.0.0.0/0\"", "\xd9\x01\x05\xa1\x44\x00\x00\x00\x00\x00"}, {net.IPNet{IP: net.IP{192, 168, 0, 100}, Mask: net.CIDRMask(24, 32)}, "\"192.168.0.100/24\"", "\xd9\x01\x05\xa1\x44\xc0\xa8\x00\x64\x18\x18"}, } func TestAppendIPPrefix(t *testing.T) { for _, tc := range IPPrefixTestCases { s := enc.AppendIPPrefix([]byte{}, tc.pfx) got := string(s) if got != tc.binary { t.Errorf("AppendIPPrefix(%s)=0x%s, want: 0x%s", tc.pfx.String(), hex.EncodeToString(s), hex.EncodeToString([]byte(tc.binary))) } } } func BenchmarkAppendInt(b *testing.B) { type st struct { sz byte val int64 } tests := map[string]st{ "int-Positive": {sz: 0, val: 10000}, "int-Negative": {sz: 0, val: -10000}, "uint8": {sz: 1, val: 100}, "uint16": {sz: 2, val: 0xfff}, "uint32": {sz: 4, val: 0xffffff}, "uint64": {sz: 8, val: 0xffffffffff}, "int8": {sz: 21, val: -120}, "int16": {sz: 22, val: -1200}, "int32": {sz: 23, val: 32000}, "int64": {sz: 24, val: 0xffffffffff}, } for name, str := range tests { b.Run(name, func(b *testing.B) { buf := make([]byte, 0, 100) for i := 0; i < b.N; i++ { switch str.sz { case 0: _ = enc.AppendInt(buf, int(str.val)) case 1: _ = enc.AppendUint8(buf, uint8(str.val)) case 2: _ = enc.AppendUint16(buf, uint16(str.val)) case 4: _ = enc.AppendUint32(buf, uint32(str.val)) case 8: _ = enc.AppendUint64(buf, uint64(str.val)) case 21: _ = enc.AppendInt8(buf, int8(str.val)) case 22: _ = enc.AppendInt16(buf, int16(str.val)) case 23: _ = enc.AppendInt32(buf, int32(str.val)) case 24: _ = enc.AppendInt64(buf, int64(str.val)) } } }) } } func BenchmarkAppendFloat(b *testing.B) { type st struct { sz byte val float64 } tests := map[string]st{ "Float32": {sz: 4, val: 10000.12345}, "Float64": {sz: 8, val: -10000.54321}, } for name, str := range tests { b.Run(name, func(b *testing.B) { buf := make([]byte, 0, 100) for i := 0; i < b.N; i++ { switch str.sz { case 4: _ = enc.AppendFloat32(buf, float32(str.val)) case 8: _ = enc.AppendFloat64(buf, str.val) } } }) } } zerolog-1.26.1/internal/json/000077500000000000000000000000001415647605600160655ustar00rootroot00000000000000zerolog-1.26.1/internal/json/base.go000066400000000000000000000012371415647605600173310ustar00rootroot00000000000000package json // JSONMarshalFunc is used to marshal interface to JSON encoded byte slice. // Making it package level instead of embedded in Encoder brings // some extra efforts at importing, but avoids value copy when the functions // of Encoder being invoked. // DO REMEMBER to set this variable at importing, or // you might get a nil pointer dereference panic at runtime. var JSONMarshalFunc func(v interface{}) ([]byte, error) type Encoder struct{} // AppendKey appends a new key to the output JSON. func (e Encoder) AppendKey(dst []byte, key string) []byte { if dst[len(dst)-1] != '{' { dst = append(dst, ',') } return append(e.AppendString(dst, key), ':') } zerolog-1.26.1/internal/json/bytes.go000066400000000000000000000036621415647605600175510ustar00rootroot00000000000000package json import "unicode/utf8" // AppendBytes is a mirror of appendString with []byte arg func (Encoder) AppendBytes(dst, s []byte) []byte { dst = append(dst, '"') for i := 0; i < len(s); i++ { if !noEscapeTable[s[i]] { dst = appendBytesComplex(dst, s, i) return append(dst, '"') } } dst = append(dst, s...) return append(dst, '"') } // AppendHex encodes the input bytes to a hex string and appends // the encoded string to the input byte slice. // // The operation loops though each byte and encodes it as hex using // the hex lookup table. func (Encoder) AppendHex(dst, s []byte) []byte { dst = append(dst, '"') for _, v := range s { dst = append(dst, hex[v>>4], hex[v&0x0f]) } return append(dst, '"') } // appendBytesComplex is a mirror of the appendStringComplex // with []byte arg func appendBytesComplex(dst, s []byte, i int) []byte { start := 0 for i < len(s) { b := s[i] if b >= utf8.RuneSelf { r, size := utf8.DecodeRune(s[i:]) if r == utf8.RuneError && size == 1 { if start < i { dst = append(dst, s[start:i]...) } dst = append(dst, `\ufffd`...) i += size start = i continue } i += size continue } if noEscapeTable[b] { i++ continue } // We encountered a character that needs to be encoded. // Let's append the previous simple characters to the byte slice // and switch our operation to read and encode the remainder // characters byte-by-byte. if start < i { dst = append(dst, s[start:i]...) } switch b { case '"', '\\': dst = append(dst, '\\', b) case '\b': dst = append(dst, '\\', 'b') case '\f': dst = append(dst, '\\', 'f') case '\n': dst = append(dst, '\\', 'n') case '\r': dst = append(dst, '\\', 'r') case '\t': dst = append(dst, '\\', 't') default: dst = append(dst, '\\', 'u', '0', '0', hex[b>>4], hex[b&0xF]) } i++ start = i } if start < len(s) { dst = append(dst, s[start:]...) } return dst } zerolog-1.26.1/internal/json/bytes_test.go000066400000000000000000000044321415647605600206040ustar00rootroot00000000000000package json import ( "testing" "unicode" ) var enc = Encoder{} func TestAppendBytes(t *testing.T) { for _, tt := range encodeStringTests { b := enc.AppendBytes([]byte{}, []byte(tt.in)) if got, want := string(b), tt.out; got != want { t.Errorf("appendBytes(%q) = %#q, want %#q", tt.in, got, want) } } } func TestAppendHex(t *testing.T) { for _, tt := range encodeHexTests { b := enc.AppendHex([]byte{}, []byte{tt.in}) if got, want := string(b), tt.out; got != want { t.Errorf("appendHex(%x) = %s, want %s", tt.in, got, want) } } } func TestStringBytes(t *testing.T) { t.Parallel() // Test that encodeState.stringBytes and encodeState.string use the same encoding. var r []rune for i := '\u0000'; i <= unicode.MaxRune; i++ { r = append(r, i) } s := string(r) + "\xff\xff\xffhello" // some invalid UTF-8 too encStr := string(enc.AppendString([]byte{}, s)) encBytes := string(enc.AppendBytes([]byte{}, []byte(s))) if encStr != encBytes { i := 0 for i < len(encStr) && i < len(encBytes) && encStr[i] == encBytes[i] { i++ } encStr = encStr[i:] encBytes = encBytes[i:] i = 0 for i < len(encStr) && i < len(encBytes) && encStr[len(encStr)-i-1] == encBytes[len(encBytes)-i-1] { i++ } encStr = encStr[:len(encStr)-i] encBytes = encBytes[:len(encBytes)-i] if len(encStr) > 20 { encStr = encStr[:20] + "..." } if len(encBytes) > 20 { encBytes = encBytes[:20] + "..." } t.Errorf("encodings differ at %#q vs %#q", encStr, encBytes) } } func BenchmarkAppendBytes(b *testing.B) { tests := map[string]string{ "NoEncoding": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingFirst": `"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingMiddle": `aaaaaaaaaaaaaaaaaaaaaaaaa"aaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingLast": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"`, "MultiBytesFirst": `❤️aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "MultiBytesMiddle": `aaaaaaaaaaaaaaaaaaaaaaaaa❤️aaaaaaaaaaaaaaaaaaaaaaaa`, "MultiBytesLast": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa❤️`, } for name, str := range tests { byt := []byte(str) b.Run(name, func(b *testing.B) { buf := make([]byte, 0, 100) for i := 0; i < b.N; i++ { _ = enc.AppendBytes(buf, byt) } }) } } zerolog-1.26.1/internal/json/string.go000066400000000000000000000100501415647605600177160ustar00rootroot00000000000000package json import ( "fmt" "unicode/utf8" ) const hex = "0123456789abcdef" var noEscapeTable = [256]bool{} func init() { for i := 0; i <= 0x7e; i++ { noEscapeTable[i] = i >= 0x20 && i != '\\' && i != '"' } } // AppendStrings encodes the input strings to json and // appends the encoded string list to the input byte slice. func (e Encoder) AppendStrings(dst []byte, vals []string) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = e.AppendString(dst, vals[0]) if len(vals) > 1 { for _, val := range vals[1:] { dst = e.AppendString(append(dst, ','), val) } } dst = append(dst, ']') return dst } // AppendString encodes the input string to json and appends // the encoded string to the input byte slice. // // The operation loops though each byte in the string looking // for characters that need json or utf8 encoding. If the string // does not need encoding, then the string is appended in it's // entirety to the byte slice. // If we encounter a byte that does need encoding, switch up // the operation and perform a byte-by-byte read-encode-append. func (Encoder) AppendString(dst []byte, s string) []byte { // Start with a double quote. dst = append(dst, '"') // Loop through each character in the string. for i := 0; i < len(s); i++ { // Check if the character needs encoding. Control characters, slashes, // and the double quote need json encoding. Bytes above the ascii // boundary needs utf8 encoding. if !noEscapeTable[s[i]] { // We encountered a character that needs to be encoded. Switch // to complex version of the algorithm. dst = appendStringComplex(dst, s, i) return append(dst, '"') } } // The string has no need for encoding an therefore is directly // appended to the byte slice. dst = append(dst, s...) // End with a double quote return append(dst, '"') } // AppendStringers encodes the provided Stringer list to json and // appends the encoded Stringer list to the input byte slice. func (e Encoder) AppendStringers(dst []byte, vals []fmt.Stringer) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = e.AppendStringer(dst, vals[0]) if len(vals) > 1 { for _, val := range vals[1:] { dst = e.AppendStringer(append(dst, ','), val) } } return append(dst, ']') } // AppendStringer encodes the input Stringer to json and appends the // encoded Stringer value to the input byte slice. func (e Encoder) AppendStringer(dst []byte, val fmt.Stringer) []byte { if val == nil { return e.AppendInterface(dst, nil) } return e.AppendString(dst, val.String()) } //// appendStringComplex is used by appendString to take over an in // progress JSON string encoding that encountered a character that needs // to be encoded. func appendStringComplex(dst []byte, s string, i int) []byte { start := 0 for i < len(s) { b := s[i] if b >= utf8.RuneSelf { r, size := utf8.DecodeRuneInString(s[i:]) if r == utf8.RuneError && size == 1 { // In case of error, first append previous simple characters to // the byte slice if any and append a remplacement character code // in place of the invalid sequence. if start < i { dst = append(dst, s[start:i]...) } dst = append(dst, `\ufffd`...) i += size start = i continue } i += size continue } if noEscapeTable[b] { i++ continue } // We encountered a character that needs to be encoded. // Let's append the previous simple characters to the byte slice // and switch our operation to read and encode the remainder // characters byte-by-byte. if start < i { dst = append(dst, s[start:i]...) } switch b { case '"', '\\': dst = append(dst, '\\', b) case '\b': dst = append(dst, '\\', 'b') case '\f': dst = append(dst, '\\', 'f') case '\n': dst = append(dst, '\\', 'n') case '\r': dst = append(dst, '\\', 'r') case '\t': dst = append(dst, '\\', 't') default: dst = append(dst, '\\', 'u', '0', '0', hex[b>>4], hex[b&0xF]) } i++ start = i } if start < len(s) { dst = append(dst, s[start:]...) } return dst } zerolog-1.26.1/internal/json/string_test.go000066400000000000000000000044371415647605600207710ustar00rootroot00000000000000package json import ( "testing" ) var encodeStringTests = []struct { in string out string }{ {"", `""`}, {"\\", `"\\"`}, {"\x00", `"\u0000"`}, {"\x01", `"\u0001"`}, {"\x02", `"\u0002"`}, {"\x03", `"\u0003"`}, {"\x04", `"\u0004"`}, {"\x05", `"\u0005"`}, {"\x06", `"\u0006"`}, {"\x07", `"\u0007"`}, {"\x08", `"\b"`}, {"\x09", `"\t"`}, {"\x0a", `"\n"`}, {"\x0b", `"\u000b"`}, {"\x0c", `"\f"`}, {"\x0d", `"\r"`}, {"\x0e", `"\u000e"`}, {"\x0f", `"\u000f"`}, {"\x10", `"\u0010"`}, {"\x11", `"\u0011"`}, {"\x12", `"\u0012"`}, {"\x13", `"\u0013"`}, {"\x14", `"\u0014"`}, {"\x15", `"\u0015"`}, {"\x16", `"\u0016"`}, {"\x17", `"\u0017"`}, {"\x18", `"\u0018"`}, {"\x19", `"\u0019"`}, {"\x1a", `"\u001a"`}, {"\x1b", `"\u001b"`}, {"\x1c", `"\u001c"`}, {"\x1d", `"\u001d"`}, {"\x1e", `"\u001e"`}, {"\x1f", `"\u001f"`}, {"✭", `"✭"`}, {"foo\xc2\x7fbar", `"foo\ufffd\u007fbar"`}, // invalid sequence {"ascii", `"ascii"`}, {"\"a", `"\"a"`}, {"\x1fa", `"\u001fa"`}, {"foo\"bar\"baz", `"foo\"bar\"baz"`}, {"\x1ffoo\x1fbar\x1fbaz", `"\u001ffoo\u001fbar\u001fbaz"`}, {"emoji \u2764\ufe0f!", `"emoji ❤️!"`}, } var encodeHexTests = []struct { in byte out string }{ {0x00, `"00"`}, {0x0f, `"0f"`}, {0x10, `"10"`}, {0xf0, `"f0"`}, {0xff, `"ff"`}, } func TestAppendString(t *testing.T) { for _, tt := range encodeStringTests { b := enc.AppendString([]byte{}, tt.in) if got, want := string(b), tt.out; got != want { t.Errorf("appendString(%q) = %#q, want %#q", tt.in, got, want) } } } func BenchmarkAppendString(b *testing.B) { tests := map[string]string{ "NoEncoding": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingFirst": `"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingMiddle": `aaaaaaaaaaaaaaaaaaaaaaaaa"aaaaaaaaaaaaaaaaaaaaaaaa`, "EncodingLast": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"`, "MultiBytesFirst": `❤️aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa`, "MultiBytesMiddle": `aaaaaaaaaaaaaaaaaaaaaaaaa❤️aaaaaaaaaaaaaaaaaaaaaaaa`, "MultiBytesLast": `aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa❤️`, } for name, str := range tests { b.Run(name, func(b *testing.B) { buf := make([]byte, 0, 100) for i := 0; i < b.N; i++ { _ = enc.AppendString(buf, str) } }) } } zerolog-1.26.1/internal/json/time.go000066400000000000000000000055711415647605600173620ustar00rootroot00000000000000package json import ( "strconv" "time" ) const ( // Import from zerolog/global.go timeFormatUnix = "" timeFormatUnixMs = "UNIXMS" timeFormatUnixMicro = "UNIXMICRO" ) // AppendTime formats the input time with the given format // and appends the encoded string to the input byte slice. func (e Encoder) AppendTime(dst []byte, t time.Time, format string) []byte { switch format { case timeFormatUnix: return e.AppendInt64(dst, t.Unix()) case timeFormatUnixMs: return e.AppendInt64(dst, t.UnixNano()/1000000) case timeFormatUnixMicro: return e.AppendInt64(dst, t.UnixNano()/1000) } return append(t.AppendFormat(append(dst, '"'), format), '"') } // AppendTimes converts the input times with the given format // and appends the encoded string list to the input byte slice. func (Encoder) AppendTimes(dst []byte, vals []time.Time, format string) []byte { switch format { case timeFormatUnix: return appendUnixTimes(dst, vals) case timeFormatUnixMs: return appendUnixMsTimes(dst, vals) } if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = append(vals[0].AppendFormat(append(dst, '"'), format), '"') if len(vals) > 1 { for _, t := range vals[1:] { dst = append(t.AppendFormat(append(dst, ',', '"'), format), '"') } } dst = append(dst, ']') return dst } func appendUnixTimes(dst []byte, vals []time.Time) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendInt(dst, vals[0].Unix(), 10) if len(vals) > 1 { for _, t := range vals[1:] { dst = strconv.AppendInt(append(dst, ','), t.Unix(), 10) } } dst = append(dst, ']') return dst } func appendUnixMsTimes(dst []byte, vals []time.Time) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendInt(dst, vals[0].UnixNano()/1000000, 10) if len(vals) > 1 { for _, t := range vals[1:] { dst = strconv.AppendInt(append(dst, ','), t.UnixNano()/1000000, 10) } } dst = append(dst, ']') return dst } // AppendDuration formats the input duration with the given unit & format // and appends the encoded string to the input byte slice. func (e Encoder) AppendDuration(dst []byte, d time.Duration, unit time.Duration, useInt bool) []byte { if useInt { return strconv.AppendInt(dst, int64(d/unit), 10) } return e.AppendFloat64(dst, float64(d)/float64(unit)) } // AppendDurations formats the input durations with the given unit & format // and appends the encoded string list to the input byte slice. func (e Encoder) AppendDurations(dst []byte, vals []time.Duration, unit time.Duration, useInt bool) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = e.AppendDuration(dst, vals[0], unit, useInt) if len(vals) > 1 { for _, d := range vals[1:] { dst = e.AppendDuration(append(dst, ','), d, unit, useInt) } } dst = append(dst, ']') return dst } zerolog-1.26.1/internal/json/types.go000066400000000000000000000271601415647605600175660ustar00rootroot00000000000000package json import ( "fmt" "math" "net" "strconv" ) // AppendNil inserts a 'Nil' object into the dst byte array. func (Encoder) AppendNil(dst []byte) []byte { return append(dst, "null"...) } // AppendBeginMarker inserts a map start into the dst byte array. func (Encoder) AppendBeginMarker(dst []byte) []byte { return append(dst, '{') } // AppendEndMarker inserts a map end into the dst byte array. func (Encoder) AppendEndMarker(dst []byte) []byte { return append(dst, '}') } // AppendLineBreak appends a line break. func (Encoder) AppendLineBreak(dst []byte) []byte { return append(dst, '\n') } // AppendArrayStart adds markers to indicate the start of an array. func (Encoder) AppendArrayStart(dst []byte) []byte { return append(dst, '[') } // AppendArrayEnd adds markers to indicate the end of an array. func (Encoder) AppendArrayEnd(dst []byte) []byte { return append(dst, ']') } // AppendArrayDelim adds markers to indicate end of a particular array element. func (Encoder) AppendArrayDelim(dst []byte) []byte { if len(dst) > 0 { return append(dst, ',') } return dst } // AppendBool converts the input bool to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendBool(dst []byte, val bool) []byte { return strconv.AppendBool(dst, val) } // AppendBools encodes the input bools to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendBools(dst []byte, vals []bool) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendBool(dst, vals[0]) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendBool(append(dst, ','), val) } } dst = append(dst, ']') return dst } // AppendInt converts the input int to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendInt(dst []byte, val int) []byte { return strconv.AppendInt(dst, int64(val), 10) } // AppendInts encodes the input ints to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendInts(dst []byte, vals []int) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendInt(dst, int64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendInt(append(dst, ','), int64(val), 10) } } dst = append(dst, ']') return dst } // AppendInt8 converts the input []int8 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendInt8(dst []byte, val int8) []byte { return strconv.AppendInt(dst, int64(val), 10) } // AppendInts8 encodes the input int8s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendInts8(dst []byte, vals []int8) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendInt(dst, int64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendInt(append(dst, ','), int64(val), 10) } } dst = append(dst, ']') return dst } // AppendInt16 converts the input int16 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendInt16(dst []byte, val int16) []byte { return strconv.AppendInt(dst, int64(val), 10) } // AppendInts16 encodes the input int16s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendInts16(dst []byte, vals []int16) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendInt(dst, int64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendInt(append(dst, ','), int64(val), 10) } } dst = append(dst, ']') return dst } // AppendInt32 converts the input int32 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendInt32(dst []byte, val int32) []byte { return strconv.AppendInt(dst, int64(val), 10) } // AppendInts32 encodes the input int32s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendInts32(dst []byte, vals []int32) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendInt(dst, int64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendInt(append(dst, ','), int64(val), 10) } } dst = append(dst, ']') return dst } // AppendInt64 converts the input int64 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendInt64(dst []byte, val int64) []byte { return strconv.AppendInt(dst, val, 10) } // AppendInts64 encodes the input int64s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendInts64(dst []byte, vals []int64) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendInt(dst, vals[0], 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendInt(append(dst, ','), val, 10) } } dst = append(dst, ']') return dst } // AppendUint converts the input uint to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendUint(dst []byte, val uint) []byte { return strconv.AppendUint(dst, uint64(val), 10) } // AppendUints encodes the input uints to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendUints(dst []byte, vals []uint) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendUint(dst, uint64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendUint(append(dst, ','), uint64(val), 10) } } dst = append(dst, ']') return dst } // AppendUint8 converts the input uint8 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendUint8(dst []byte, val uint8) []byte { return strconv.AppendUint(dst, uint64(val), 10) } // AppendUints8 encodes the input uint8s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendUints8(dst []byte, vals []uint8) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendUint(dst, uint64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendUint(append(dst, ','), uint64(val), 10) } } dst = append(dst, ']') return dst } // AppendUint16 converts the input uint16 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendUint16(dst []byte, val uint16) []byte { return strconv.AppendUint(dst, uint64(val), 10) } // AppendUints16 encodes the input uint16s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendUints16(dst []byte, vals []uint16) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendUint(dst, uint64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendUint(append(dst, ','), uint64(val), 10) } } dst = append(dst, ']') return dst } // AppendUint32 converts the input uint32 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendUint32(dst []byte, val uint32) []byte { return strconv.AppendUint(dst, uint64(val), 10) } // AppendUints32 encodes the input uint32s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendUints32(dst []byte, vals []uint32) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendUint(dst, uint64(vals[0]), 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendUint(append(dst, ','), uint64(val), 10) } } dst = append(dst, ']') return dst } // AppendUint64 converts the input uint64 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendUint64(dst []byte, val uint64) []byte { return strconv.AppendUint(dst, uint64(val), 10) } // AppendUints64 encodes the input uint64s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendUints64(dst []byte, vals []uint64) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = strconv.AppendUint(dst, vals[0], 10) if len(vals) > 1 { for _, val := range vals[1:] { dst = strconv.AppendUint(append(dst, ','), val, 10) } } dst = append(dst, ']') return dst } func appendFloat(dst []byte, val float64, bitSize int) []byte { // JSON does not permit NaN or Infinity. A typical JSON encoder would fail // with an error, but a logging library wants the data to get thru so we // make a tradeoff and store those types as string. switch { case math.IsNaN(val): return append(dst, `"NaN"`...) case math.IsInf(val, 1): return append(dst, `"+Inf"`...) case math.IsInf(val, -1): return append(dst, `"-Inf"`...) } return strconv.AppendFloat(dst, val, 'f', -1, bitSize) } // AppendFloat32 converts the input float32 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendFloat32(dst []byte, val float32) []byte { return appendFloat(dst, float64(val), 32) } // AppendFloats32 encodes the input float32s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendFloats32(dst []byte, vals []float32) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = appendFloat(dst, float64(vals[0]), 32) if len(vals) > 1 { for _, val := range vals[1:] { dst = appendFloat(append(dst, ','), float64(val), 32) } } dst = append(dst, ']') return dst } // AppendFloat64 converts the input float64 to a string and // appends the encoded string to the input byte slice. func (Encoder) AppendFloat64(dst []byte, val float64) []byte { return appendFloat(dst, val, 64) } // AppendFloats64 encodes the input float64s to json and // appends the encoded string list to the input byte slice. func (Encoder) AppendFloats64(dst []byte, vals []float64) []byte { if len(vals) == 0 { return append(dst, '[', ']') } dst = append(dst, '[') dst = appendFloat(dst, vals[0], 64) if len(vals) > 1 { for _, val := range vals[1:] { dst = appendFloat(append(dst, ','), val, 64) } } dst = append(dst, ']') return dst } // AppendInterface marshals the input interface to a string and // appends the encoded string to the input byte slice. func (e Encoder) AppendInterface(dst []byte, i interface{}) []byte { marshaled, err := JSONMarshalFunc(i) if err != nil { return e.AppendString(dst, fmt.Sprintf("marshaling error: %v", err)) } return append(dst, marshaled...) } // AppendObjectData takes in an object that is already in a byte array // and adds it to the dst. func (Encoder) AppendObjectData(dst []byte, o []byte) []byte { // Three conditions apply here: // 1. new content starts with '{' - which should be dropped OR // 2. new content starts with '{' - which should be replaced with ',' // to separate with existing content OR // 3. existing content has already other fields if o[0] == '{' { if len(dst) > 1 { dst = append(dst, ',') } o = o[1:] } else if len(dst) > 1 { dst = append(dst, ',') } return append(dst, o...) } // AppendIPAddr adds IPv4 or IPv6 address to dst. func (e Encoder) AppendIPAddr(dst []byte, ip net.IP) []byte { return e.AppendString(dst, ip.String()) } // AppendIPPrefix adds IPv4 or IPv6 Prefix (address & mask) to dst. func (e Encoder) AppendIPPrefix(dst []byte, pfx net.IPNet) []byte { return e.AppendString(dst, pfx.String()) } // AppendMACAddr adds MAC address to dst. func (e Encoder) AppendMACAddr(dst []byte, ha net.HardwareAddr) []byte { return e.AppendString(dst, ha.String()) } zerolog-1.26.1/internal/json/types_test.go000066400000000000000000000162151415647605600206240ustar00rootroot00000000000000package json import ( "math" "net" "reflect" "testing" ) func TestAppendType(t *testing.T) { w := map[string]func(interface{}) []byte{ "AppendInt": func(v interface{}) []byte { return enc.AppendInt([]byte{}, v.(int)) }, "AppendInt8": func(v interface{}) []byte { return enc.AppendInt8([]byte{}, v.(int8)) }, "AppendInt16": func(v interface{}) []byte { return enc.AppendInt16([]byte{}, v.(int16)) }, "AppendInt32": func(v interface{}) []byte { return enc.AppendInt32([]byte{}, v.(int32)) }, "AppendInt64": func(v interface{}) []byte { return enc.AppendInt64([]byte{}, v.(int64)) }, "AppendUint": func(v interface{}) []byte { return enc.AppendUint([]byte{}, v.(uint)) }, "AppendUint8": func(v interface{}) []byte { return enc.AppendUint8([]byte{}, v.(uint8)) }, "AppendUint16": func(v interface{}) []byte { return enc.AppendUint16([]byte{}, v.(uint16)) }, "AppendUint32": func(v interface{}) []byte { return enc.AppendUint32([]byte{}, v.(uint32)) }, "AppendUint64": func(v interface{}) []byte { return enc.AppendUint64([]byte{}, v.(uint64)) }, "AppendFloat32": func(v interface{}) []byte { return enc.AppendFloat32([]byte{}, v.(float32)) }, "AppendFloat64": func(v interface{}) []byte { return enc.AppendFloat64([]byte{}, v.(float64)) }, } tests := []struct { name string fn string input interface{} want []byte }{ {"AppendInt8(math.MaxInt8)", "AppendInt8", int8(math.MaxInt8), []byte("127")}, {"AppendInt16(math.MaxInt16)", "AppendInt16", int16(math.MaxInt16), []byte("32767")}, {"AppendInt32(math.MaxInt32)", "AppendInt32", int32(math.MaxInt32), []byte("2147483647")}, {"AppendInt64(math.MaxInt64)", "AppendInt64", int64(math.MaxInt64), []byte("9223372036854775807")}, {"AppendUint8(math.MaxUint8)", "AppendUint8", uint8(math.MaxUint8), []byte("255")}, {"AppendUint16(math.MaxUint16)", "AppendUint16", uint16(math.MaxUint16), []byte("65535")}, {"AppendUint32(math.MaxUint32)", "AppendUint32", uint32(math.MaxUint32), []byte("4294967295")}, {"AppendUint64(math.MaxUint64)", "AppendUint64", uint64(math.MaxUint64), []byte("18446744073709551615")}, {"AppendFloat32(-Inf)", "AppendFloat32", float32(math.Inf(-1)), []byte(`"-Inf"`)}, {"AppendFloat32(+Inf)", "AppendFloat32", float32(math.Inf(1)), []byte(`"+Inf"`)}, {"AppendFloat32(NaN)", "AppendFloat32", float32(math.NaN()), []byte(`"NaN"`)}, {"AppendFloat32(0)", "AppendFloat32", float32(0), []byte(`0`)}, {"AppendFloat32(-1.1)", "AppendFloat32", float32(-1.1), []byte(`-1.1`)}, {"AppendFloat32(1e20)", "AppendFloat32", float32(1e20), []byte(`100000000000000000000`)}, {"AppendFloat32(1e21)", "AppendFloat32", float32(1e21), []byte(`1000000000000000000000`)}, {"AppendFloat64(-Inf)", "AppendFloat64", float64(math.Inf(-1)), []byte(`"-Inf"`)}, {"AppendFloat64(+Inf)", "AppendFloat64", float64(math.Inf(1)), []byte(`"+Inf"`)}, {"AppendFloat64(NaN)", "AppendFloat64", float64(math.NaN()), []byte(`"NaN"`)}, {"AppendFloat64(0)", "AppendFloat64", float64(0), []byte(`0`)}, {"AppendFloat64(-1.1)", "AppendFloat64", float64(-1.1), []byte(`-1.1`)}, {"AppendFloat64(1e20)", "AppendFloat64", float64(1e20), []byte(`100000000000000000000`)}, {"AppendFloat64(1e21)", "AppendFloat64", float64(1e21), []byte(`1000000000000000000000`)}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { if got := w[tt.fn](tt.input); !reflect.DeepEqual(got, tt.want) { t.Errorf("got %s, want %s", got, tt.want) } }) } } func Test_appendMAC(t *testing.T) { MACtests := []struct { input string want []byte }{ {"01:23:45:67:89:ab", []byte(`"01:23:45:67:89:ab"`)}, {"cd:ef:11:22:33:44", []byte(`"cd:ef:11:22:33:44"`)}, } for _, tt := range MACtests { t.Run("MAC", func(t *testing.T) { ha, _ := net.ParseMAC(tt.input) if got := enc.AppendMACAddr([]byte{}, ha); !reflect.DeepEqual(got, tt.want) { t.Errorf("appendMACAddr() = %s, want %s", got, tt.want) } }) } } func Test_appendIP(t *testing.T) { IPv4tests := []struct { input net.IP want []byte }{ {net.IP{0, 0, 0, 0}, []byte(`"0.0.0.0"`)}, {net.IP{192, 0, 2, 200}, []byte(`"192.0.2.200"`)}, } for _, tt := range IPv4tests { t.Run("IPv4", func(t *testing.T) { if got := enc.AppendIPAddr([]byte{}, tt.input); !reflect.DeepEqual(got, tt.want) { t.Errorf("appendIPAddr() = %s, want %s", got, tt.want) } }) } IPv6tests := []struct { input net.IP want []byte }{ {net.IPv6zero, []byte(`"::"`)}, {net.IPv6linklocalallnodes, []byte(`"ff02::1"`)}, {net.IP{0x20, 0x01, 0x0d, 0xb8, 0x85, 0xa3, 0x00, 0x00, 0x00, 0x00, 0x8a, 0x2e, 0x03, 0x70, 0x73, 0x34}, []byte(`"2001:db8:85a3::8a2e:370:7334"`)}, } for _, tt := range IPv6tests { t.Run("IPv6", func(t *testing.T) { if got := enc.AppendIPAddr([]byte{}, tt.input); !reflect.DeepEqual(got, tt.want) { t.Errorf("appendIPAddr() = %s, want %s", got, tt.want) } }) } } func Test_appendIPPrefix(t *testing.T) { IPv4Prefixtests := []struct { input net.IPNet want []byte }{ {net.IPNet{IP: net.IP{0, 0, 0, 0}, Mask: net.IPv4Mask(0, 0, 0, 0)}, []byte(`"0.0.0.0/0"`)}, {net.IPNet{IP: net.IP{192, 0, 2, 200}, Mask: net.IPv4Mask(255, 255, 255, 0)}, []byte(`"192.0.2.200/24"`)}, } for _, tt := range IPv4Prefixtests { t.Run("IPv4", func(t *testing.T) { if got := enc.AppendIPPrefix([]byte{}, tt.input); !reflect.DeepEqual(got, tt.want) { t.Errorf("appendIPPrefix() = %s, want %s", got, tt.want) } }) } IPv6Prefixtests := []struct { input net.IPNet want []byte }{ {net.IPNet{IP: net.IPv6zero, Mask: net.CIDRMask(0, 128)}, []byte(`"::/0"`)}, {net.IPNet{IP: net.IPv6linklocalallnodes, Mask: net.CIDRMask(128, 128)}, []byte(`"ff02::1/128"`)}, {net.IPNet{IP: net.IP{0x20, 0x01, 0x0d, 0xb8, 0x85, 0xa3, 0x00, 0x00, 0x00, 0x00, 0x8a, 0x2e, 0x03, 0x70, 0x73, 0x34}, Mask: net.CIDRMask(64, 128)}, []byte(`"2001:db8:85a3::8a2e:370:7334/64"`)}, } for _, tt := range IPv6Prefixtests { t.Run("IPv6", func(t *testing.T) { if got := enc.AppendIPPrefix([]byte{}, tt.input); !reflect.DeepEqual(got, tt.want) { t.Errorf("appendIPPrefix() = %s, want %s", got, tt.want) } }) } } func Test_appendMac(t *testing.T) { MACtests := []struct { input net.HardwareAddr want []byte }{ {net.HardwareAddr{0x12, 0x34, 0x56, 0x78, 0x90, 0xab}, []byte(`"12:34:56:78:90:ab"`)}, {net.HardwareAddr{0x12, 0x34, 0x00, 0x00, 0x90, 0xab}, []byte(`"12:34:00:00:90:ab"`)}, } for _, tt := range MACtests { t.Run("MAC", func(t *testing.T) { if got := enc.AppendMACAddr([]byte{}, tt.input); !reflect.DeepEqual(got, tt.want) { t.Errorf("appendMAC() = %s, want %s", got, tt.want) } }) } } func Test_appendObjectData(t *testing.T) { tests := []struct { dst []byte obj []byte want []byte }{ {[]byte{}, []byte(`{"foo":"bar"}`), []byte(`"foo":"bar"}`)}, {[]byte(`{"qux":"quz"`), []byte(`{"foo":"bar"}`), []byte(`{"qux":"quz","foo":"bar"}`)}, {[]byte{}, []byte(`"foo":"bar"`), []byte(`"foo":"bar"`)}, {[]byte(`{"qux":"quz"`), []byte(`"foo":"bar"`), []byte(`{"qux":"quz","foo":"bar"`)}, } for _, tt := range tests { t.Run("ObjectData", func(t *testing.T) { if got := enc.AppendObjectData(tt.dst, tt.obj); !reflect.DeepEqual(got, tt.want) { t.Errorf("appendObjectData() = %s, want %s", got, tt.want) } }) } } zerolog-1.26.1/journald/000077500000000000000000000000001415647605600151165ustar00rootroot00000000000000zerolog-1.26.1/journald/journald.go000066400000000000000000000055361415647605600172740ustar00rootroot00000000000000// +build !windows // Package journald provides a io.Writer to send the logs // to journalD component of systemd. package journald // This file provides a zerolog writer so that logs printed // using zerolog library can be sent to a journalD. // Zerolog's Top level key/Value Pairs are translated to // journald's args - all Values are sent to journald as strings. // And all key strings are converted to uppercase before sending // to journald (as required by journald). // In addition, entire log message (all Key Value Pairs), is also // sent to journald under the key "JSON". import ( "bytes" "encoding/json" "fmt" "io" "strings" "github.com/coreos/go-systemd/v22/journal" "github.com/rs/zerolog" "github.com/rs/zerolog/internal/cbor" ) const defaultJournalDPrio = journal.PriNotice // NewJournalDWriter returns a zerolog log destination // to be used as parameter to New() calls. Writing logs // to this writer will send the log messages to journalD // running in this system. func NewJournalDWriter() io.Writer { return journalWriter{} } type journalWriter struct { } // levelToJPrio converts zerolog Level string into // journalD's priority values. JournalD has more // priorities than zerolog. func levelToJPrio(zLevel string) journal.Priority { lvl, _ := zerolog.ParseLevel(zLevel) switch lvl { case zerolog.TraceLevel: return journal.PriDebug case zerolog.DebugLevel: return journal.PriDebug case zerolog.InfoLevel: return journal.PriInfo case zerolog.WarnLevel: return journal.PriWarning case zerolog.ErrorLevel: return journal.PriErr case zerolog.FatalLevel: return journal.PriCrit case zerolog.PanicLevel: return journal.PriEmerg case zerolog.NoLevel: return journal.PriNotice } return defaultJournalDPrio } func (w journalWriter) Write(p []byte) (n int, err error) { if !journal.Enabled() { err = fmt.Errorf("cannot connect to journalD") return } var event map[string]interface{} origPLen := len(p) p = cbor.DecodeIfBinaryToBytes(p) d := json.NewDecoder(bytes.NewReader(p)) d.UseNumber() err = d.Decode(&event) jPrio := defaultJournalDPrio args := make(map[string]string, 0) if err != nil { return } if l, ok := event[zerolog.LevelFieldName].(string); ok { jPrio = levelToJPrio(l) } msg := "" for key, value := range event { jKey := strings.ToUpper(key) switch key { case zerolog.LevelFieldName, zerolog.TimestampFieldName: continue case zerolog.MessageFieldName: msg, _ = value.(string) continue } switch value.(type) { case string: args[jKey], _ = value.(string) case json.Number: args[jKey] = fmt.Sprint(value) default: b, err := json.Marshal(value) if err != nil { args[jKey] = fmt.Sprintf("[error: %v]", err) } else { args[jKey] = string(b) } } } args["JSON"] = string(p) err = journal.Send(msg, jPrio, args) if err == nil { n = origPLen } return } zerolog-1.26.1/journald/journald_test.go000066400000000000000000000041031415647605600203200ustar00rootroot00000000000000// +build linux package journald_test import ( "bytes" "io" "testing" "github.com/rs/zerolog" "github.com/rs/zerolog/journald" ) func ExampleNewJournalDWriter() { log := zerolog.New(journald.NewJournalDWriter()) log.Info().Str("foo", "bar").Uint64("small", 123).Float64("float", 3.14).Uint64("big", 1152921504606846976).Msg("Journal Test") // Output: } /* There is no automated way to verify the output - since the output is sent to journald process and method to retrieve is journalctl. Will find a way to automate the process and fix this test. $ journalctl -o verbose -f Thu 2018-04-26 22:30:20.768136 PDT [s=3284d695bde946e4b5017c77a399237f;i=329f0;b=98c0dca0debc4b98a5b9534e910e7dd6;m=7a702e35dd4;t=56acdccd2ed0a;x=4690034cf0348614] PRIORITY=6 _AUDIT_LOGINUID=1000 _BOOT_ID=98c0dca0debc4b98a5b9534e910e7dd6 _MACHINE_ID=926ed67eb4744580948de70fb474975e _HOSTNAME=sprint _UID=1000 _GID=1000 _CAP_EFFECTIVE=0 _SYSTEMD_SLICE=-.slice _TRANSPORT=journal _SYSTEMD_CGROUP=/ _AUDIT_SESSION=2945 MESSAGE=Journal Test FOO=bar BIG=1152921504606846976 _COMM=journald.test SMALL=123 FLOAT=3.14 JSON={"level":"info","foo":"bar","small":123,"float":3.14,"big":1152921504606846976,"message":"Journal Test"} _PID=27103 _SOURCE_REALTIME_TIMESTAMP=1524807020768136 */ func TestWriteReturnsNoOfWrittenBytes(t *testing.T) { input := []byte(`{"level":"info","time":1570912626,"message":"Starting..."}`) wr := journald.NewJournalDWriter() want := len(input) got, err := wr.Write(input) if err != nil { t.Errorf("Unexpected error %v", err) } if want != got { t.Errorf("Expected %d bytes to be written got %d", want, got) } } func TestMultiWrite(t *testing.T) { var ( w1 = new(bytes.Buffer) w2 = new(bytes.Buffer) w3 = journald.NewJournalDWriter() ) zerolog.ErrorHandler = func(err error) { if err == io.ErrShortWrite { t.Errorf("Unexpected ShortWriteError") t.FailNow() } } log := zerolog.New(io.MultiWriter(w1, w2, w3)).With().Logger() for i := 0; i < 10; i++ { log.Info().Msg("Tick!") } } zerolog-1.26.1/log.go000066400000000000000000000305371415647605600144200ustar00rootroot00000000000000// Package zerolog provides a lightweight logging library dedicated to JSON logging. // // A global Logger can be use for simple logging: // // import "github.com/rs/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/rs/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"} // // In this case, many consumers will take the last value, // but this is not guaranteed; check yours if in doubt. package zerolog import ( "fmt" "io" "io/ioutil" "os" "strconv" ) // 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 // Values less than TraceLevel are handled as numbers. ) func (l Level) String() string { switch l { case TraceLevel: return LevelTraceValue case DebugLevel: return LevelDebugValue case InfoLevel: return LevelInfoValue case WarnLevel: return LevelWarnValue case ErrorLevel: return LevelErrorValue case FatalLevel: return LevelFatalValue case PanicLevel: return LevelPanicValue case Disabled: return "disabled" case NoLevel: return "" } return strconv.Itoa(int(l)) } // ParseLevel converts a level string into a zerolog Level value. // returns an error if the input string does not match known values. func ParseLevel(levelStr string) (Level, error) { switch levelStr { case LevelFieldMarshalFunc(TraceLevel): return TraceLevel, nil case LevelFieldMarshalFunc(DebugLevel): return DebugLevel, nil case LevelFieldMarshalFunc(InfoLevel): return InfoLevel, nil case LevelFieldMarshalFunc(WarnLevel): return WarnLevel, nil case LevelFieldMarshalFunc(ErrorLevel): return ErrorLevel, nil case LevelFieldMarshalFunc(FatalLevel): return FatalLevel, nil case LevelFieldMarshalFunc(PanicLevel): return PanicLevel, nil case LevelFieldMarshalFunc(Disabled): return Disabled, nil case LevelFieldMarshalFunc(NoLevel): return NoLevel, nil } i, err := strconv.Atoi(levelStr) if err != nil { return NoLevel, fmt.Errorf("Unknown Level String: '%s', defaulting to NoLevel", levelStr) } if i > 127 || i < -128 { return NoLevel, fmt.Errorf("Out-Of-Bounds Level: '%d', defaulting to NoLevel", i) } return Level(i), nil } // 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 { w LevelWriter level Level sampler Sampler context []byte hooks []Hook stack bool } // 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. func New(w io.Writer) Logger { if w == nil { w = ioutil.Discard } lw, ok := w.(LevelWriter) if !ok { lw = levelWriterAdapter{w} } return Logger{w: lw, level: TraceLevel} } // Nop returns a disabled logger for which all operation are no-op. func Nop() Logger { return New(nil).Level(Disabled) } // Output duplicates the current logger and sets w as its output. func (l Logger) Output(w io.Writer) Logger { l2 := New(w) l2.level = l.level l2.sampler = l.sampler l2.stack = l.stack if len(l.hooks) > 0 { l2.hooks = append(l2.hooks, l.hooks...) } if l.context != nil { l2.context = make([]byte, len(l.context), cap(l.context)) copy(l2.context, l.context) } return l2 } // With creates a child logger with the field added to its context. func (l Logger) With() Context { context := l.context l.context = make([]byte, 0, 500) if context != nil { l.context = append(l.context, context...) } else { // This is needed for AppendKey to not check len of input // thus making it inlinable l.context = enc.AppendBeginMarker(l.context) } return Context{l} } // UpdateContext updates the internal logger's context. // // Use this method with caution. If unsure, prefer the With method. func (l *Logger) UpdateContext(update func(c Context) Context) { if l == disabledLogger { return } if cap(l.context) == 0 { l.context = make([]byte, 0, 500) } if len(l.context) == 0 { l.context = enc.AppendBeginMarker(l.context) } c := update(Context{*l}) l.context = c.l.context } // Level creates a child logger with the minimum accepted level set to level. func (l Logger) Level(lvl Level) Logger { l.level = lvl return l } // GetLevel returns the current Level of l. func (l Logger) GetLevel() Level { return l.level } // Sample returns a logger with the s sampler. func (l Logger) Sample(s Sampler) Logger { l.sampler = s return l } // Hook returns a logger with the h Hook. func (l Logger) Hook(h Hook) Logger { l.hooks = append(l.hooks, h) return l } // Trace starts a new message with trace level. // // You must call Msg on the returned event in order to send the event. func (l *Logger) Trace() *Event { return l.newEvent(TraceLevel, nil) } // Debug starts a new message with debug level. // // You must call Msg on the returned event in order to send the event. func (l *Logger) Debug() *Event { return l.newEvent(DebugLevel, nil) } // Info starts a new message with info level. // // You must call Msg on the returned event in order to send the event. func (l *Logger) Info() *Event { return l.newEvent(InfoLevel, nil) } // Warn starts a new message with warn level. // // You must call Msg on the returned event in order to send the event. func (l *Logger) Warn() *Event { return l.newEvent(WarnLevel, nil) } // Error starts a new message with error level. // // You must call Msg on the returned event in order to send the event. func (l *Logger) Error() *Event { return l.newEvent(ErrorLevel, nil) } // 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) Err(err error) *Event { if err != nil { return l.Error().Err(err) } return l.Info() } // 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) Fatal() *Event { return l.newEvent(FatalLevel, func(msg string) { os.Exit(1) }) } // 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) Panic() *Event { return l.newEvent(PanicLevel, func(msg string) { panic(msg) }) } // 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. func (l *Logger) WithLevel(level Level) *Event { switch level { case TraceLevel: return l.Trace() case DebugLevel: return l.Debug() case InfoLevel: return l.Info() case WarnLevel: return l.Warn() case ErrorLevel: return l.Error() case FatalLevel: return l.newEvent(FatalLevel, nil) case PanicLevel: return l.newEvent(PanicLevel, nil) case NoLevel: return l.Log() case Disabled: return nil default: return l.newEvent(level, nil) } } // 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. func (l *Logger) Log() *Event { return l.newEvent(NoLevel, nil) } // Print sends a log event using debug level and no extra field. // Arguments are handled in the manner of fmt.Print. func (l *Logger) Print(v ...interface{}) { if e := l.Debug(); e.Enabled() { e.CallerSkipFrame(1).Msg(fmt.Sprint(v...)) } } // Printf sends a log event using debug level and no extra field. // Arguments are handled in the manner of fmt.Printf. func (l *Logger) Printf(format string, v ...interface{}) { if e := l.Debug(); e.Enabled() { e.CallerSkipFrame(1).Msg(fmt.Sprintf(format, v...)) } } // Write implements the io.Writer interface. This is useful to set as a writer // for the standard library log. func (l Logger) Write(p []byte) (n int, err error) { n = len(p) if n > 0 && p[n-1] == '\n' { // Trim CR added by stdlog. p = p[0 : n-1] } l.Log().CallerSkipFrame(1).Msg(string(p)) return } func (l *Logger) newEvent(level Level, done func(string)) *Event { enabled := l.should(level) if !enabled { return nil } e := newEvent(l.w, level) e.done = done e.ch = l.hooks if level != NoLevel && LevelFieldName != "" { e.Str(LevelFieldName, LevelFieldMarshalFunc(level)) } if l.context != nil && len(l.context) > 1 { e.buf = enc.AppendObjectData(e.buf, l.context) } if l.stack { e.Stack() } return e } // should returns true if the log event should be logged. func (l *Logger) should(lvl Level) bool { if lvl < l.level || lvl < GlobalLevel() { return false } if l.sampler != nil && !samplingDisabled() { return l.sampler.Sample(lvl) } return true } zerolog-1.26.1/log/000077500000000000000000000000001415647605600140615ustar00rootroot00000000000000zerolog-1.26.1/log/log.go000066400000000000000000000067711415647605600152040ustar00rootroot00000000000000// Package log provides a global logger for zerolog. package log import ( "context" "fmt" "io" "os" "github.com/rs/zerolog" ) // Logger is the global logger. var Logger = zerolog.New(os.Stderr).With().Timestamp().Logger() // Output duplicates the global logger and sets w as its output. func Output(w io.Writer) zerolog.Logger { return Logger.Output(w) } // With creates a child logger with the field added to its context. func With() zerolog.Context { return Logger.With() } // Level creates a child logger with the minimum accepted level set to level. func Level(level zerolog.Level) zerolog.Logger { return Logger.Level(level) } // Sample returns a logger with the s sampler. func Sample(s zerolog.Sampler) zerolog.Logger { return Logger.Sample(s) } // Hook returns a logger with the h Hook. func Hook(h zerolog.Hook) zerolog.Logger { return Logger.Hook(h) } // 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 Err(err error) *zerolog.Event { return Logger.Err(err) } // Trace starts a new message with trace level. // // You must call Msg on the returned event in order to send the event. func Trace() *zerolog.Event { return Logger.Trace() } // Debug starts a new message with debug level. // // You must call Msg on the returned event in order to send the event. func Debug() *zerolog.Event { return Logger.Debug() } // Info starts a new message with info level. // // You must call Msg on the returned event in order to send the event. func Info() *zerolog.Event { return Logger.Info() } // Warn starts a new message with warn level. // // You must call Msg on the returned event in order to send the event. func Warn() *zerolog.Event { return Logger.Warn() } // Error starts a new message with error level. // // You must call Msg on the returned event in order to send the event. func Error() *zerolog.Event { return Logger.Error() } // Fatal starts a new message with fatal level. The os.Exit(1) function // is called by the Msg method. // // You must call Msg on the returned event in order to send the event. func Fatal() *zerolog.Event { return Logger.Fatal() } // Panic starts a new message with panic level. The message is also sent // to the panic function. // // You must call Msg on the returned event in order to send the event. func Panic() *zerolog.Event { return Logger.Panic() } // WithLevel starts a new message with level. // // You must call Msg on the returned event in order to send the event. func WithLevel(level zerolog.Level) *zerolog.Event { return Logger.WithLevel(level) } // Log starts a new message with no level. Setting zerolog.GlobalLevel to // zerolog.Disabled will still disable events produced by this method. // // You must call Msg on the returned event in order to send the event. func Log() *zerolog.Event { return Logger.Log() } // Print sends a log event using debug level and no extra field. // Arguments are handled in the manner of fmt.Print. func Print(v ...interface{}) { Logger.Debug().CallerSkipFrame(1).Msg(fmt.Sprint(v...)) } // Printf sends a log event using debug level and no extra field. // Arguments are handled in the manner of fmt.Printf. func Printf(format string, v ...interface{}) { Logger.Debug().CallerSkipFrame(1).Msgf(format, v...) } // Ctx returns the Logger associated with the ctx. If no logger // is associated, a disabled logger is returned. func Ctx(ctx context.Context) *zerolog.Logger { return zerolog.Ctx(ctx) } zerolog-1.26.1/log/log_example_test.go000066400000000000000000000103311415647605600177410ustar00rootroot00000000000000// +build !binary_log package log_test import ( "errors" "flag" "os" "time" "github.com/rs/zerolog" "github.com/rs/zerolog/log" ) // setup would normally be an init() function, however, there seems // to be something awry with the testing framework when we set the // global Logger from an init() func setup() { // UNIX Time is faster and smaller than most timestamps // If you set zerolog.TimeFieldFormat to an empty string, // logs will write with UNIX time zerolog.TimeFieldFormat = "" // In order to always output a static time to stdout for these // examples to pass, we need to override zerolog.TimestampFunc // and log.Logger globals -- you would not normally need to do this zerolog.TimestampFunc = func() time.Time { return time.Date(2008, 1, 8, 17, 5, 05, 0, time.UTC) } log.Logger = zerolog.New(os.Stdout).With().Timestamp().Logger() } // Simple logging example using the Print function in the log package // Note that both Print and Printf are at the debug log level by default func ExamplePrint() { setup() log.Print("hello world") // Output: {"level":"debug","time":1199811905,"message":"hello world"} } // Simple logging example using the Printf function in the log package func ExamplePrintf() { setup() log.Printf("hello %s", "world") // Output: {"level":"debug","time":1199811905,"message":"hello world"} } // Example of a log with no particular "level" func ExampleLog() { setup() log.Log().Msg("hello world") // Output: {"time":1199811905,"message":"hello world"} } // Example of a conditional level based on the presence of an error. func ExampleErr() { setup() err := errors.New("some error") log.Err(err).Msg("hello world") log.Err(nil).Msg("hello world") // Output: {"level":"error","error":"some error","time":1199811905,"message":"hello world"} // {"level":"info","time":1199811905,"message":"hello world"} } // Example of a log at a particular "level" (in this case, "trace") func ExampleTrace() { setup() log.Trace().Msg("hello world") // Output: {"level":"trace","time":1199811905,"message":"hello world"} } // Example of a log at a particular "level" (in this case, "debug") func ExampleDebug() { setup() log.Debug().Msg("hello world") // Output: {"level":"debug","time":1199811905,"message":"hello world"} } // Example of a log at a particular "level" (in this case, "info") func ExampleInfo() { setup() log.Info().Msg("hello world") // Output: {"level":"info","time":1199811905,"message":"hello world"} } // Example of a log at a particular "level" (in this case, "warn") func ExampleWarn() { setup() log.Warn().Msg("hello world") // Output: {"level":"warn","time":1199811905,"message":"hello world"} } // Example of a log at a particular "level" (in this case, "error") func ExampleError() { setup() log.Error().Msg("hello world") // Output: {"level":"error","time":1199811905,"message":"hello world"} } // Example of a log at a particular "level" (in this case, "fatal") func ExampleFatal() { setup() err := errors.New("A repo man spends his life getting into tense situations") service := "myservice" log.Fatal(). Err(err). Str("service", service). Msgf("Cannot start %s", service) // Outputs: {"level":"fatal","time":1199811905,"error":"A repo man spends his life getting into tense situations","service":"myservice","message":"Cannot start myservice"} } // TODO: Panic // This example uses command-line flags to demonstrate various outputs // depending on the chosen log level. func Example() { setup() debug := flag.Bool("debug", false, "sets log level to debug") flag.Parse() // Default level for this example is info, unless debug flag is present zerolog.SetGlobalLevel(zerolog.InfoLevel) if *debug { zerolog.SetGlobalLevel(zerolog.DebugLevel) } log.Debug().Msg("This message appears only when log level set to Debug") log.Info().Msg("This message appears when log level set to Debug or Info") if e := log.Debug(); e.Enabled() { // Compute log output only if enabled. value := "bar" e.Str("foo", value).Msg("some debug message") } // Output: {"level":"info","time":1199811905,"message":"This message appears when log level set to Debug or Info"} } // TODO: Output // TODO: With // TODO: Level // TODO: Sample // TODO: Hook // TODO: WithLevel // TODO: Ctx zerolog-1.26.1/log_example_test.go000066400000000000000000000256401415647605600171710ustar00rootroot00000000000000// +build !binary_log package zerolog_test import ( "errors" "fmt" stdlog "log" "net" "os" "time" "github.com/rs/zerolog" ) func ExampleNew() { log := zerolog.New(os.Stdout) log.Info().Msg("hello world") // Output: {"level":"info","message":"hello world"} } func ExampleLogger_With() { log := zerolog.New(os.Stdout). With(). Str("foo", "bar"). Logger() log.Info().Msg("hello world") // Output: {"level":"info","foo":"bar","message":"hello world"} } func ExampleLogger_Level() { log := zerolog.New(os.Stdout).Level(zerolog.WarnLevel) log.Info().Msg("filtered out message") log.Error().Msg("kept message") // Output: {"level":"error","message":"kept message"} } func ExampleLogger_Sample() { 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: {"level":"info","message":"message 1"} // {"level":"info","message":"message 3"} } 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 ExampleLogger_Hook() { var levelNameHook LevelNameHook var messageHook MessageHook = "The message" log := zerolog.New(os.Stdout).Hook(levelNameHook).Hook(messageHook) log.Info().Msg("hello world") // Output: {"level":"info","level_name":"info","the_message":"hello world","message":"hello world"} } func ExampleLogger_Print() { log := zerolog.New(os.Stdout) log.Print("hello world") // Output: {"level":"debug","message":"hello world"} } func ExampleLogger_Printf() { log := zerolog.New(os.Stdout) log.Printf("hello %s", "world") // Output: {"level":"debug","message":"hello world"} } func ExampleLogger_Trace() { log := zerolog.New(os.Stdout) log.Trace(). Str("foo", "bar"). Int("n", 123). Msg("hello world") // Output: {"level":"trace","foo":"bar","n":123,"message":"hello world"} } func ExampleLogger_Debug() { log := zerolog.New(os.Stdout) log.Debug(). Str("foo", "bar"). Int("n", 123). Msg("hello world") // Output: {"level":"debug","foo":"bar","n":123,"message":"hello world"} } func ExampleLogger_Info() { log := zerolog.New(os.Stdout) log.Info(). Str("foo", "bar"). Int("n", 123). Msg("hello world") // Output: {"level":"info","foo":"bar","n":123,"message":"hello world"} } func ExampleLogger_Warn() { log := zerolog.New(os.Stdout) log.Warn(). Str("foo", "bar"). Msg("a warning message") // Output: {"level":"warn","foo":"bar","message":"a warning message"} } func ExampleLogger_Error() { log := zerolog.New(os.Stdout) log.Error(). Err(errors.New("some error")). Msg("error doing something") // Output: {"level":"error","error":"some error","message":"error doing something"} } func ExampleLogger_WithLevel() { log := zerolog.New(os.Stdout) log.WithLevel(zerolog.InfoLevel). Msg("hello world") // Output: {"level":"info","message":"hello world"} } func ExampleLogger_Write() { log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Logger() stdlog.SetFlags(0) stdlog.SetOutput(log) stdlog.Print("hello world") // Output: {"foo":"bar","message":"hello world"} } func ExampleLogger_Log() { log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Str("bar", "baz"). Msg("") // Output: {"foo":"bar","bar":"baz"} } func ExampleEvent_Dict() { log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Dict("dict", zerolog.Dict(). Str("bar", "baz"). Int("n", 1), ). Msg("hello world") // Output: {"foo":"bar","dict":{"bar":"baz","n":1},"message":"hello world"} } type User struct { Name string Age int Created time.Time } func (u User) MarshalZerologObject(e *zerolog.Event) { e.Str("name", u.Name). Int("age", u.Age). Time("created", u.Created) } type Price struct { val uint64 prec int unit string } func (p Price) MarshalZerologObject(e *zerolog.Event) { denom := uint64(1) for i := 0; i < p.prec; i++ { denom *= 10 } result := []byte(p.unit) result = append(result, fmt.Sprintf("%d.%d", p.val/denom, p.val%denom)...) e.Str("price", string(result)) } type Users []User func (uu Users) MarshalZerologArray(a *zerolog.Array) { for _, u := range uu { a.Object(u) } } func ExampleEvent_Array() { log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Array("array", zerolog.Arr(). Str("baz"). Int(1). Dict(zerolog.Dict(). Str("bar", "baz"). Int("n", 1), ), ). Msg("hello world") // Output: {"foo":"bar","array":["baz",1,{"bar":"baz","n":1}],"message":"hello world"} } func ExampleEvent_Array_object() { log := zerolog.New(os.Stdout) // Users implements zerolog.LogArrayMarshaler u := Users{ User{"John", 35, time.Time{}}, User{"Bob", 55, time.Time{}}, } log.Log(). Str("foo", "bar"). Array("users", u). Msg("hello world") // Output: {"foo":"bar","users":[{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},{"name":"Bob","age":55,"created":"0001-01-01T00:00:00Z"}],"message":"hello world"} } func ExampleEvent_Object() { log := zerolog.New(os.Stdout) // User implements zerolog.LogObjectMarshaler u := User{"John", 35, time.Time{}} log.Log(). Str("foo", "bar"). Object("user", u). Msg("hello world") // Output: {"foo":"bar","user":{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},"message":"hello world"} } func ExampleEvent_EmbedObject() { log := zerolog.New(os.Stdout) price := Price{val: 6449, prec: 2, unit: "$"} log.Log(). Str("foo", "bar"). EmbedObject(price). Msg("hello world") // Output: {"foo":"bar","price":"$64.49","message":"hello world"} } func ExampleEvent_Interface() { 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"},"message":"hello world"} } func ExampleEvent_Dur() { 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,"message":"hello world"} } func ExampleEvent_Durs() { 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],"message":"hello world"} } func ExampleEvent_Fields_map() { fields := map[string]interface{}{ "bar": "baz", "n": 1, } log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Fields(fields). Msg("hello world") // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } func ExampleEvent_Fields_slice() { fields := []interface{}{ "bar", "baz", "n", 1, } log := zerolog.New(os.Stdout) log.Log(). Str("foo", "bar"). Fields(fields). Msg("hello world") // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } func ExampleContext_Dict() { log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Dict("dict", zerolog.Dict(). Str("bar", "baz"). Int("n", 1), ).Logger() log.Log().Msg("hello world") // Output: {"foo":"bar","dict":{"bar":"baz","n":1},"message":"hello world"} } func ExampleContext_Array() { log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Array("array", zerolog.Arr(). Str("baz"). Int(1), ).Logger() log.Log().Msg("hello world") // Output: {"foo":"bar","array":["baz",1],"message":"hello world"} } func ExampleContext_Array_object() { // Users implements zerolog.LogArrayMarshaler u := Users{ User{"John", 35, time.Time{}}, User{"Bob", 55, time.Time{}}, } log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Array("users", u). Logger() log.Log().Msg("hello world") // Output: {"foo":"bar","users":[{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},{"name":"Bob","age":55,"created":"0001-01-01T00:00:00Z"}],"message":"hello world"} } func ExampleContext_Object() { // User implements zerolog.LogObjectMarshaler u := User{"John", 35, time.Time{}} log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Object("user", u). Logger() log.Log().Msg("hello world") // Output: {"foo":"bar","user":{"name":"John","age":35,"created":"0001-01-01T00:00:00Z"},"message":"hello world"} } func ExampleContext_EmbedObject() { price := Price{val: 6449, prec: 2, unit: "$"} log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). EmbedObject(price). Logger() log.Log().Msg("hello world") // Output: {"foo":"bar","price":"$64.49","message":"hello world"} } func ExampleContext_Interface() { 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"},"message":"hello world"} } func ExampleContext_Dur() { 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,"message":"hello world"} } func ExampleContext_Durs() { 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],"message":"hello world"} } func ExampleContext_IPAddr() { 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","message":"hello world"} } func ExampleContext_IPPrefix() { 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","message":"hello world"} } func ExampleContext_MacAddr() { mac := net.HardwareAddr{0x00, 0x14, 0x22, 0x01, 0x23, 0x45} log := zerolog.New(os.Stdout).With(). MACAddr("hostMAC", mac). Logger() log.Log().Msg("hello world") // Output: {"hostMAC":"00:14:22:01:23:45","message":"hello world"} } func ExampleContext_Fields_map() { fields := map[string]interface{}{ "bar": "baz", "n": 1, } log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Fields(fields). Logger() log.Log().Msg("hello world") // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } func ExampleContext_Fields_slice() { fields := []interface{}{ "bar", "baz", "n", 1, } log := zerolog.New(os.Stdout).With(). Str("foo", "bar"). Fields(fields). Logger() log.Log().Msg("hello world") // Output: {"foo":"bar","bar":"baz","n":1,"message":"hello world"} } zerolog-1.26.1/log_test.go000066400000000000000000000737271415647605600154670ustar00rootroot00000000000000package zerolog import ( "bytes" "errors" "fmt" "net" "reflect" "runtime" "strconv" "strings" "testing" "time" ) func TestLog(t *testing.T) { t.Run("empty", func(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), "{}\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("one-field", func(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Str("foo", "bar").Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"foo":"bar"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("two-field", func(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log(). Str("foo", "bar"). Int("n", 123). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"foo":"bar","n":123}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) } func TestInfo(t *testing.T) { t.Run("empty", func(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Info().Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"info"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("one-field", func(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Info().Str("foo", "bar").Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"info","foo":"bar"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("two-field", func(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Info(). Str("foo", "bar"). Int("n", 123). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"info","foo":"bar","n":123}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) } func TestEmptyLevelFieldName(t *testing.T) { fieldName := LevelFieldName LevelFieldName = "" t.Run("empty setting", func(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Info(). Str("foo", "bar"). Int("n", 123). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"foo":"bar","n":123}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) LevelFieldName = fieldName } func TestWith(t *testing.T) { out := &bytes.Buffer{} ctx := New(out).With(). Str("string", "foo"). Stringer("stringer", net.IP{127, 0, 0, 1}). Stringer("stringer_nil", nil). Bytes("bytes", []byte("bar")). Hex("hex", []byte{0x12, 0xef}). RawJSON("json", []byte(`{"some":"json"}`)). AnErr("some_err", nil). Err(errors.New("some error")). Bool("bool", true). Int("int", 1). Int8("int8", 2). Int16("int16", 3). Int32("int32", 4). Int64("int64", 5). Uint("uint", 6). Uint8("uint8", 7). Uint16("uint16", 8). Uint32("uint32", 9). Uint64("uint64", 10). Float32("float32", 11.101). Float64("float64", 12.30303). Time("time", time.Time{}) _, file, line, _ := runtime.Caller(0) caller := fmt.Sprintf("%s:%d", file, line+3) log := ctx.Caller().Logger() log.Log().Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"string":"foo","stringer":"127.0.0.1","stringer_nil":null,"bytes":"bar","hex":"12ef","json":{"some":"json"},"error":"some error","bool":true,"int":1,"int8":2,"int16":3,"int32":4,"int64":5,"uint":6,"uint8":7,"uint16":8,"uint32":9,"uint64":10,"float32":11.101,"float64":12.30303,"time":"0001-01-01T00:00:00Z","caller":"`+caller+`"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } // Validate CallerWithSkipFrameCount. out.Reset() _, file, line, _ = runtime.Caller(0) caller = fmt.Sprintf("%s:%d", file, line+5) log = ctx.CallerWithSkipFrameCount(3).Logger() func() { log.Log().Msg("") }() // The above line is a little contrived, but the line above should be the line due // to the extra frame skip. if got, want := decodeIfBinaryToString(out.Bytes()), `{"string":"foo","stringer":"127.0.0.1","stringer_nil":null,"bytes":"bar","hex":"12ef","json":{"some":"json"},"error":"some error","bool":true,"int":1,"int8":2,"int16":3,"int32":4,"int64":5,"uint":6,"uint8":7,"uint16":8,"uint32":9,"uint64":10,"float32":11.101,"float64":12.30303,"time":"0001-01-01T00:00:00Z","caller":"`+caller+`"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsMap(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Fields(map[string]interface{}{ "nil": nil, "string": "foo", "bytes": []byte("bar"), "error": errors.New("some error"), "bool": true, "int": int(1), "int8": int8(2), "int16": int16(3), "int32": int32(4), "int64": int64(5), "uint": uint(6), "uint8": uint8(7), "uint16": uint16(8), "uint32": uint32(9), "uint64": uint64(10), "float32": float32(11), "float64": float64(12), "ipv6": net.IP{0x20, 0x01, 0x0d, 0xb8, 0x85, 0xa3, 0x00, 0x00, 0x00, 0x00, 0x8a, 0x2e, 0x03, 0x70, 0x73, 0x34}, "dur": 1 * time.Second, "time": time.Time{}, "obj": obj{"a", "b", 1}, }).Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"bool":true,"bytes":"bar","dur":1000,"error":"some error","float32":11,"float64":12,"int":1,"int16":3,"int32":4,"int64":5,"int8":2,"ipv6":"2001:db8:85a3::8a2e:370:7334","nil":null,"obj":{"Pub":"a","Tag":"b","priv":1},"string":"foo","time":"0001-01-01T00:00:00Z","uint":6,"uint16":8,"uint32":9,"uint64":10,"uint8":7}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsMapPnt(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Fields(map[string]interface{}{ "string": new(string), "bool": new(bool), "int": new(int), "int8": new(int8), "int16": new(int16), "int32": new(int32), "int64": new(int64), "uint": new(uint), "uint8": new(uint8), "uint16": new(uint16), "uint32": new(uint32), "uint64": new(uint64), "float32": new(float32), "float64": new(float64), "dur": new(time.Duration), "time": new(time.Time), }).Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"bool":false,"dur":0,"float32":0,"float64":0,"int":0,"int16":0,"int32":0,"int64":0,"int8":0,"string":"","time":"0001-01-01T00:00:00Z","uint":0,"uint16":0,"uint32":0,"uint64":0,"uint8":0}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsMapNilPnt(t *testing.T) { var ( stringPnt *string boolPnt *bool intPnt *int int8Pnt *int8 int16Pnt *int16 int32Pnt *int32 int64Pnt *int64 uintPnt *uint uint8Pnt *uint8 uint16Pnt *uint16 uint32Pnt *uint32 uint64Pnt *uint64 float32Pnt *float32 float64Pnt *float64 durPnt *time.Duration timePnt *time.Time ) out := &bytes.Buffer{} log := New(out) fields := map[string]interface{}{ "string": stringPnt, "bool": boolPnt, "int": intPnt, "int8": int8Pnt, "int16": int16Pnt, "int32": int32Pnt, "int64": int64Pnt, "uint": uintPnt, "uint8": uint8Pnt, "uint16": uint16Pnt, "uint32": uint32Pnt, "uint64": uint64Pnt, "float32": float32Pnt, "float64": float64Pnt, "dur": durPnt, "time": timePnt, } log.Log().Fields(fields).Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"bool":null,"dur":null,"float32":null,"float64":null,"int":null,"int16":null,"int32":null,"int64":null,"int8":null,"string":null,"time":null,"uint":null,"uint16":null,"uint32":null,"uint64":null,"uint8":null}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsSlice(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Fields([]interface{}{ "nil", nil, "string", "foo", "bytes", []byte("bar"), "error", errors.New("some error"), "bool", true, "int", int(1), "int8", int8(2), "int16", int16(3), "int32", int32(4), "int64", int64(5), "uint", uint(6), "uint8", uint8(7), "uint16", uint16(8), "uint32", uint32(9), "uint64", uint64(10), "float32", float32(11), "float64", float64(12), "ipv6", net.IP{0x20, 0x01, 0x0d, 0xb8, 0x85, 0xa3, 0x00, 0x00, 0x00, 0x00, 0x8a, 0x2e, 0x03, 0x70, 0x73, 0x34}, "dur", 1 * time.Second, "time", time.Time{}, "obj", obj{"a", "b", 1}, }).Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"nil":null,"string":"foo","bytes":"bar","error":"some error","bool":true,"int":1,"int8":2,"int16":3,"int32":4,"int64":5,"uint":6,"uint8":7,"uint16":8,"uint32":9,"uint64":10,"float32":11,"float64":12,"ipv6":"2001:db8:85a3::8a2e:370:7334","dur":1000,"time":"0001-01-01T00:00:00Z","obj":{"Pub":"a","Tag":"b","priv":1}}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsSliceExtraneous(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Fields([]interface{}{ "string", "foo", "error", errors.New("some error"), 32, "valueForNonStringKey", "bool", true, "int", int(1), "keyWithoutValue", }).Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"string":"foo","error":"some error","bool":true,"int":1}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsNotMapSlice(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log(). Fields(obj{"a", "b", 1}). Fields("string"). Fields(1). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFields(t *testing.T) { out := &bytes.Buffer{} log := New(out) now := time.Now() _, file, line, _ := runtime.Caller(0) caller := fmt.Sprintf("%s:%d", file, line+3) log.Log(). Caller(). Str("string", "foo"). Stringer("stringer", net.IP{127, 0, 0, 1}). Stringer("stringer_nil", nil). Bytes("bytes", []byte("bar")). Hex("hex", []byte{0x12, 0xef}). RawJSON("json", []byte(`{"some":"json"}`)). Func(func(e *Event) { e.Str("func", "func_output") }). AnErr("some_err", nil). Err(errors.New("some error")). Bool("bool", true). Int("int", 1). Int8("int8", 2). Int16("int16", 3). Int32("int32", 4). Int64("int64", 5). Uint("uint", 6). Uint8("uint8", 7). Uint16("uint16", 8). Uint32("uint32", 9). Uint64("uint64", 10). IPAddr("IPv4", net.IP{192, 168, 0, 100}). IPAddr("IPv6", net.IP{0x20, 0x01, 0x0d, 0xb8, 0x85, 0xa3, 0x00, 0x00, 0x00, 0x00, 0x8a, 0x2e, 0x03, 0x70, 0x73, 0x34}). MACAddr("Mac", net.HardwareAddr{0x00, 0x14, 0x22, 0x01, 0x23, 0x45}). IPPrefix("Prefix", net.IPNet{IP: net.IP{192, 168, 0, 100}, Mask: net.CIDRMask(24, 32)}). Float32("float32", 11.1234). Float64("float64", 12.321321321). Dur("dur", 1*time.Second). Time("time", time.Time{}). TimeDiff("diff", now, now.Add(-10*time.Second)). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"caller":"`+caller+`","string":"foo","stringer":"127.0.0.1","stringer_nil":null,"bytes":"bar","hex":"12ef","json":{"some":"json"},"func":"func_output","error":"some error","bool":true,"int":1,"int8":2,"int16":3,"int32":4,"int64":5,"uint":6,"uint8":7,"uint16":8,"uint32":9,"uint64":10,"IPv4":"192.168.0.100","IPv6":"2001:db8:85a3::8a2e:370:7334","Mac":"00:14:22:01:23:45","Prefix":"192.168.0.100/24","float32":11.1234,"float64":12.321321321,"dur":1000,"time":"0001-01-01T00:00:00Z","diff":10000}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsArrayEmpty(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log(). Strs("string", []string{}). Stringers("stringer", []fmt.Stringer{}). Errs("err", []error{}). Bools("bool", []bool{}). Ints("int", []int{}). Ints8("int8", []int8{}). Ints16("int16", []int16{}). Ints32("int32", []int32{}). Ints64("int64", []int64{}). Uints("uint", []uint{}). Uints8("uint8", []uint8{}). Uints16("uint16", []uint16{}). Uints32("uint32", []uint32{}). Uints64("uint64", []uint64{}). Floats32("float32", []float32{}). Floats64("float64", []float64{}). Durs("dur", []time.Duration{}). Times("time", []time.Time{}). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"string":[],"stringer":[],"err":[],"bool":[],"int":[],"int8":[],"int16":[],"int32":[],"int64":[],"uint":[],"uint8":[],"uint16":[],"uint32":[],"uint64":[],"float32":[],"float64":[],"dur":[],"time":[]}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsArraySingleElement(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log(). Strs("string", []string{"foo"}). Stringers("stringer", []fmt.Stringer{net.IP{127, 0, 0, 1}}). Errs("err", []error{errors.New("some error")}). Bools("bool", []bool{true}). Ints("int", []int{1}). Ints8("int8", []int8{2}). Ints16("int16", []int16{3}). Ints32("int32", []int32{4}). Ints64("int64", []int64{5}). Uints("uint", []uint{6}). Uints8("uint8", []uint8{7}). Uints16("uint16", []uint16{8}). Uints32("uint32", []uint32{9}). Uints64("uint64", []uint64{10}). Floats32("float32", []float32{11}). Floats64("float64", []float64{12}). Durs("dur", []time.Duration{1 * time.Second}). Times("time", []time.Time{{}}). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"string":["foo"],"stringer":["127.0.0.1"],"err":["some error"],"bool":[true],"int":[1],"int8":[2],"int16":[3],"int32":[4],"int64":[5],"uint":[6],"uint8":[7],"uint16":[8],"uint32":[9],"uint64":[10],"float32":[11],"float64":[12],"dur":[1000],"time":["0001-01-01T00:00:00Z"]}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsArrayMultipleElement(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log(). Strs("string", []string{"foo", "bar"}). Stringers("stringer", []fmt.Stringer{nil, net.IP{127, 0, 0, 1}}). Errs("err", []error{errors.New("some error"), nil}). Bools("bool", []bool{true, false}). Ints("int", []int{1, 0}). Ints8("int8", []int8{2, 0}). Ints16("int16", []int16{3, 0}). Ints32("int32", []int32{4, 0}). Ints64("int64", []int64{5, 0}). Uints("uint", []uint{6, 0}). Uints8("uint8", []uint8{7, 0}). Uints16("uint16", []uint16{8, 0}). Uints32("uint32", []uint32{9, 0}). Uints64("uint64", []uint64{10, 0}). Floats32("float32", []float32{11, 0}). Floats64("float64", []float64{12, 0}). Durs("dur", []time.Duration{1 * time.Second, 0}). Times("time", []time.Time{{}, {}}). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"string":["foo","bar"],"stringer":[null,"127.0.0.1"],"err":["some error",null],"bool":[true,false],"int":[1,0],"int8":[2,0],"int16":[3,0],"int32":[4,0],"int64":[5,0],"uint":[6,0],"uint8":[7,0],"uint16":[8,0],"uint32":[9,0],"uint64":[10,0],"float32":[11,0],"float64":[12,0],"dur":[1000,0],"time":["0001-01-01T00:00:00Z","0001-01-01T00:00:00Z"]}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestFieldsDisabled(t *testing.T) { out := &bytes.Buffer{} log := New(out).Level(InfoLevel) now := time.Now() log.Debug(). Str("string", "foo"). Stringer("stringer", net.IP{127, 0, 0, 1}). Bytes("bytes", []byte("bar")). Hex("hex", []byte{0x12, 0xef}). AnErr("some_err", nil). Err(errors.New("some error")). Func(func(e *Event) { e.Str("func", "func_output") }). Bool("bool", true). Int("int", 1). Int8("int8", 2). Int16("int16", 3). Int32("int32", 4). Int64("int64", 5). Uint("uint", 6). Uint8("uint8", 7). Uint16("uint16", 8). Uint32("uint32", 9). Uint64("uint64", 10). Float32("float32", 11). Float64("float64", 12). Dur("dur", 1*time.Second). Time("time", time.Time{}). TimeDiff("diff", now, now.Add(-10*time.Second)). Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), ""; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestMsgf(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Msgf("one %s %.1f %d %v", "two", 3.4, 5, errors.New("six")) if got, want := decodeIfBinaryToString(out.Bytes()), `{"message":"one two 3.4 5 six"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestWithAndFieldsCombined(t *testing.T) { out := &bytes.Buffer{} log := New(out).With().Str("f1", "val").Str("f2", "val").Logger() log.Log().Str("f3", "val").Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), `{"f1":"val","f2":"val","f3":"val"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestLevel(t *testing.T) { t.Run("Disabled", func(t *testing.T) { out := &bytes.Buffer{} log := New(out).Level(Disabled) log.Info().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), ""; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("NoLevel/Disabled", func(t *testing.T) { out := &bytes.Buffer{} log := New(out).Level(Disabled) log.Log().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), ""; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("NoLevel/Info", func(t *testing.T) { out := &bytes.Buffer{} log := New(out).Level(InfoLevel) log.Log().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("NoLevel/Panic", func(t *testing.T) { out := &bytes.Buffer{} log := New(out).Level(PanicLevel) log.Log().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("NoLevel/WithLevel", func(t *testing.T) { out := &bytes.Buffer{} log := New(out).Level(InfoLevel) log.WithLevel(NoLevel).Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) t.Run("Info", func(t *testing.T) { out := &bytes.Buffer{} log := New(out).Level(InfoLevel) log.Info().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"info","message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } }) } func TestGetLevel(t *testing.T) { levels := []Level{ DebugLevel, InfoLevel, WarnLevel, ErrorLevel, FatalLevel, PanicLevel, NoLevel, Disabled, } for _, level := range levels { if got, want := New(nil).Level(level).GetLevel(), level; got != want { t.Errorf("GetLevel() = %v, want: %v", got, want) } } } func TestSampling(t *testing.T) { out := &bytes.Buffer{} log := New(out).Sample(&BasicSampler{N: 2}) log.Log().Int("i", 1).Msg("") log.Log().Int("i", 2).Msg("") log.Log().Int("i", 3).Msg("") log.Log().Int("i", 4).Msg("") if got, want := decodeIfBinaryToString(out.Bytes()), "{\"i\":1}\n{\"i\":3}\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestDiscard(t *testing.T) { out := &bytes.Buffer{} log := New(out) log.Log().Discard().Str("a", "b").Msgf("one %s %.1f %d %v", "two", 3.4, 5, errors.New("six")) if got, want := decodeIfBinaryToString(out.Bytes()), ""; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } // Double call log.Log().Discard().Discard().Str("a", "b").Msgf("one %s %.1f %d %v", "two", 3.4, 5, errors.New("six")) if got, want := decodeIfBinaryToString(out.Bytes()), ""; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } type levelWriter struct { ops []struct { l Level p string } } func (lw *levelWriter) Write(p []byte) (int, error) { return len(p), nil } func (lw *levelWriter) WriteLevel(lvl Level, p []byte) (int, error) { p = decodeIfBinaryToBytes(p) lw.ops = append(lw.ops, struct { l Level p string }{lvl, string(p)}) return len(p), nil } func TestLevelWriter(t *testing.T) { lw := &levelWriter{ ops: []struct { l Level p string }{}, } // Allow extra-verbose logs. SetGlobalLevel(TraceLevel - 1) log := New(lw).Level(TraceLevel - 1) log.Trace().Msg("0") log.Debug().Msg("1") log.Info().Msg("2") log.Warn().Msg("3") log.Error().Msg("4") log.Log().Msg("nolevel-1") log.WithLevel(TraceLevel).Msg("5") log.WithLevel(DebugLevel).Msg("6") log.WithLevel(InfoLevel).Msg("7") log.WithLevel(WarnLevel).Msg("8") log.WithLevel(ErrorLevel).Msg("9") log.WithLevel(NoLevel).Msg("nolevel-2") log.WithLevel(-1).Msg("-1") // Same as TraceLevel log.WithLevel(-2).Msg("-2") // Will log log.WithLevel(-3).Msg("-3") // Will not log want := []struct { l Level p string }{ {TraceLevel, `{"level":"trace","message":"0"}` + "\n"}, {DebugLevel, `{"level":"debug","message":"1"}` + "\n"}, {InfoLevel, `{"level":"info","message":"2"}` + "\n"}, {WarnLevel, `{"level":"warn","message":"3"}` + "\n"}, {ErrorLevel, `{"level":"error","message":"4"}` + "\n"}, {NoLevel, `{"message":"nolevel-1"}` + "\n"}, {TraceLevel, `{"level":"trace","message":"5"}` + "\n"}, {DebugLevel, `{"level":"debug","message":"6"}` + "\n"}, {InfoLevel, `{"level":"info","message":"7"}` + "\n"}, {WarnLevel, `{"level":"warn","message":"8"}` + "\n"}, {ErrorLevel, `{"level":"error","message":"9"}` + "\n"}, {NoLevel, `{"message":"nolevel-2"}` + "\n"}, {Level(-1), `{"level":"trace","message":"-1"}` + "\n"}, {Level(-2), `{"level":"-2","message":"-2"}` + "\n"}, } if got := lw.ops; !reflect.DeepEqual(got, want) { t.Errorf("invalid ops:\ngot:\n%v\nwant:\n%v", got, want) } } func TestContextTimestamp(t *testing.T) { TimestampFunc = func() time.Time { return time.Date(2001, time.February, 3, 4, 5, 6, 7, time.UTC) } defer func() { TimestampFunc = time.Now }() out := &bytes.Buffer{} log := New(out).With().Timestamp().Str("foo", "bar").Logger() log.Log().Msg("hello world") if got, want := decodeIfBinaryToString(out.Bytes()), `{"foo":"bar","time":"2001-02-03T04:05:06Z","message":"hello world"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestEventTimestamp(t *testing.T) { TimestampFunc = func() time.Time { return time.Date(2001, time.February, 3, 4, 5, 6, 7, time.UTC) } defer func() { TimestampFunc = time.Now }() out := &bytes.Buffer{} log := New(out).With().Str("foo", "bar").Logger() log.Log().Timestamp().Msg("hello world") if got, want := decodeIfBinaryToString(out.Bytes()), `{"foo":"bar","time":"2001-02-03T04:05:06Z","message":"hello world"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestOutputWithoutTimestamp(t *testing.T) { ignoredOut := &bytes.Buffer{} out := &bytes.Buffer{} log := New(ignoredOut).Output(out).With().Str("foo", "bar").Logger() log.Log().Msg("hello world") if got, want := decodeIfBinaryToString(out.Bytes()), `{"foo":"bar","message":"hello world"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestOutputWithTimestamp(t *testing.T) { TimestampFunc = func() time.Time { return time.Date(2001, time.February, 3, 4, 5, 6, 7, time.UTC) } defer func() { TimestampFunc = time.Now }() ignoredOut := &bytes.Buffer{} out := &bytes.Buffer{} log := New(ignoredOut).Output(out).With().Timestamp().Str("foo", "bar").Logger() log.Log().Msg("hello world") if got, want := decodeIfBinaryToString(out.Bytes()), `{"foo":"bar","time":"2001-02-03T04:05:06Z","message":"hello world"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } type loggableError struct { error } func (l loggableError) MarshalZerologObject(e *Event) { e.Str("message", l.error.Error()+": loggableError") } func TestErrorMarshalFunc(t *testing.T) { out := &bytes.Buffer{} log := New(out) // test default behaviour log.Log().Err(errors.New("err")).Msg("msg") if got, want := decodeIfBinaryToString(out.Bytes()), `{"error":"err","message":"msg"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() log.Log().Err(loggableError{errors.New("err")}).Msg("msg") if got, want := decodeIfBinaryToString(out.Bytes()), `{"error":{"message":"err: loggableError"},"message":"msg"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() // test overriding the ErrorMarshalFunc originalErrorMarshalFunc := ErrorMarshalFunc defer func() { ErrorMarshalFunc = originalErrorMarshalFunc }() ErrorMarshalFunc = func(err error) interface{} { return err.Error() + ": marshaled string" } log.Log().Err(errors.New("err")).Msg("msg") if got, want := decodeIfBinaryToString(out.Bytes()), `{"error":"err: marshaled string","message":"msg"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() ErrorMarshalFunc = func(err error) interface{} { return errors.New(err.Error() + ": new error") } log.Log().Err(errors.New("err")).Msg("msg") if got, want := decodeIfBinaryToString(out.Bytes()), `{"error":"err: new error","message":"msg"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() ErrorMarshalFunc = func(err error) interface{} { return loggableError{err} } log.Log().Err(errors.New("err")).Msg("msg") if got, want := decodeIfBinaryToString(out.Bytes()), `{"error":{"message":"err: loggableError"},"message":"msg"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestCallerMarshalFunc(t *testing.T) { out := &bytes.Buffer{} log := New(out) // test default behaviour this is really brittle due to the line numbers // actually mattering for validation _, file, line, _ := runtime.Caller(0) caller := fmt.Sprintf("%s:%d", file, line+2) log.Log().Caller().Msg("msg") if got, want := decodeIfBinaryToString(out.Bytes()), `{"caller":"`+caller+`","message":"msg"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() // test custom behavior. In this case we'll take just the last directory origCallerMarshalFunc := CallerMarshalFunc defer func() { CallerMarshalFunc = origCallerMarshalFunc }() CallerMarshalFunc = func(file string, line int) string { parts := strings.Split(file, "/") if len(parts) > 1 { return strings.Join(parts[len(parts)-2:], "/") + ":" + strconv.Itoa(line) } return file + ":" + strconv.Itoa(line) } _, file, line, _ = runtime.Caller(0) caller = CallerMarshalFunc(file, line+2) log.Log().Caller().Msg("msg") if got, want := decodeIfBinaryToString(out.Bytes()), `{"caller":"`+caller+`","message":"msg"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestLevelFieldMarshalFunc(t *testing.T) { origLevelFieldMarshalFunc := LevelFieldMarshalFunc LevelFieldMarshalFunc = func(l Level) string { return strings.ToUpper(l.String()) } defer func() { LevelFieldMarshalFunc = origLevelFieldMarshalFunc }() out := &bytes.Buffer{} log := New(out) log.Debug().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"DEBUG","message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() log.Info().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"INFO","message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() log.Warn().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"WARN","message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() log.Error().Msg("test") if got, want := decodeIfBinaryToString(out.Bytes()), `{"level":"ERROR","message":"test"}`+"\n"; got != want { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } out.Reset() } type errWriter struct { error } func (w errWriter) Write(p []byte) (n int, err error) { return 0, w.error } func TestErrorHandler(t *testing.T) { var got error want := errors.New("write error") ErrorHandler = func(err error) { got = err } log := New(errWriter{want}) log.Log().Msg("test") if got != want { t.Errorf("ErrorHandler err = %#v, want %#v", got, want) } } func TestUpdateEmptyContext(t *testing.T) { var buf bytes.Buffer log := New(&buf) log.UpdateContext(func(c Context) Context { return c.Str("foo", "bar") }) log.Info().Msg("no panic") want := `{"level":"info","foo":"bar","message":"no panic"}` + "\n" if got := decodeIfBinaryToString(buf.Bytes()); got != want { t.Errorf("invalid log output:\ngot: %q\nwant: %q", got, want) } } func TestLevel_String(t *testing.T) { tests := []struct { name string l Level want string }{ {"trace", TraceLevel, "trace"}, {"debug", DebugLevel, "debug"}, {"info", InfoLevel, "info"}, {"warn", WarnLevel, "warn"}, {"error", ErrorLevel, "error"}, {"fatal", FatalLevel, "fatal"}, {"panic", PanicLevel, "panic"}, {"disabled", Disabled, "disabled"}, {"nolevel", NoLevel, ""}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { if got := tt.l.String(); got != tt.want { t.Errorf("String() = %v, want %v", got, tt.want) } }) } } func TestParseLevel(t *testing.T) { type args struct { levelStr string } tests := []struct { name string args args want Level wantErr bool }{ {"trace", args{"trace"}, TraceLevel, false}, {"debug", args{"debug"}, DebugLevel, false}, {"info", args{"info"}, InfoLevel, false}, {"warn", args{"warn"}, WarnLevel, false}, {"error", args{"error"}, ErrorLevel, false}, {"fatal", args{"fatal"}, FatalLevel, false}, {"panic", args{"panic"}, PanicLevel, false}, {"disabled", args{"disabled"}, Disabled, false}, {"nolevel", args{""}, NoLevel, false}, {"-1", args{"-1"}, TraceLevel, false}, {"-2", args{"-2"}, Level(-2), false}, {"-3", args{"-3"}, Level(-3), false}, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { got, err := ParseLevel(tt.args.levelStr) if (err != nil) != tt.wantErr { t.Errorf("ParseLevel() error = %v, wantErr %v", err, tt.wantErr) return } if got != tt.want { t.Errorf("ParseLevel() got = %v, want %v", got, tt.want) } }) } } zerolog-1.26.1/not_go112.go000066400000000000000000000001121415647605600153320ustar00rootroot00000000000000// +build !go1.12 package zerolog const contextCallerSkipFrameCount = 3 zerolog-1.26.1/pkgerrors/000077500000000000000000000000001415647605600153165ustar00rootroot00000000000000zerolog-1.26.1/pkgerrors/stacktrace.go000066400000000000000000000025341415647605600177750ustar00rootroot00000000000000package pkgerrors import ( "github.com/pkg/errors" ) var ( StackSourceFileName = "source" StackSourceLineName = "line" StackSourceFunctionName = "func" ) type state struct { b []byte } // Write implement fmt.Formatter interface. func (s *state) Write(b []byte) (n int, err error) { s.b = b return len(b), nil } // Width implement fmt.Formatter interface. func (s *state) Width() (wid int, ok bool) { return 0, false } // Precision implement fmt.Formatter interface. func (s *state) Precision() (prec int, ok bool) { return 0, false } // Flag implement fmt.Formatter interface. func (s *state) Flag(c int) bool { return false } func frameField(f errors.Frame, s *state, c rune) string { f.Format(s, c) return string(s.b) } // MarshalStack implements pkg/errors stack trace marshaling. // // zerolog.ErrorStackMarshaler = MarshalStack func MarshalStack(err error) interface{} { type stackTracer interface { StackTrace() errors.StackTrace } sterr, ok := err.(stackTracer) if !ok { return nil } st := sterr.StackTrace() s := &state{} out := make([]map[string]string, 0, len(st)) for _, frame := range st { out = append(out, map[string]string{ StackSourceFileName: frameField(frame, s, 's'), StackSourceLineName: frameField(frame, s, 'd'), StackSourceFunctionName: frameField(frame, s, 'n'), }) } return out } zerolog-1.26.1/pkgerrors/stacktrace_test.go000066400000000000000000000030421415647605600210270ustar00rootroot00000000000000// +build !binary_log package pkgerrors import ( "bytes" "regexp" "testing" "github.com/pkg/errors" "github.com/rs/zerolog" ) func TestLogStack(t *testing.T) { zerolog.ErrorStackMarshaler = MarshalStack out := &bytes.Buffer{} log := zerolog.New(out) err := errors.Wrap(errors.New("error message"), "from error") log.Log().Stack().Err(err).Msg("") got := out.String() want := `\{"stack":\[\{"func":"TestLogStack","line":"20","source":"stacktrace_test.go"\},.*\],"error":"from error: error message"\}\n` if ok, _ := regexp.MatchString(want, got); !ok { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func TestLogStackFromContext(t *testing.T) { zerolog.ErrorStackMarshaler = MarshalStack out := &bytes.Buffer{} log := zerolog.New(out).With().Stack().Logger() // calling Stack() on log context instead of event err := errors.Wrap(errors.New("error message"), "from error") log.Log().Err(err).Msg("") // not explicitly calling Stack() got := out.String() want := `\{"stack":\[\{"func":"TestLogStackFromContext","line":"36","source":"stacktrace_test.go"\},.*\],"error":"from error: error message"\}\n` if ok, _ := regexp.MatchString(want, got); !ok { t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want) } } func BenchmarkLogStack(b *testing.B) { zerolog.ErrorStackMarshaler = MarshalStack out := &bytes.Buffer{} log := zerolog.New(out) err := errors.Wrap(errors.New("error message"), "from error") b.ReportAllocs() for i := 0; i < b.N; i++ { log.Log().Stack().Err(err).Msg("") out.Reset() } } zerolog-1.26.1/pretty.png000066400000000000000000002441401415647605600153420ustar00rootroot00000000000000PNG  IHDR iCCPiccHTSi{!z.@z l$@(1bWGp,`QEDE,X 2`M`3gwsn(\T /ƆғSR'cG0bE(wyz^H9"v˵-0vybYK(/P Nt'>6HK @Q3q(t9;9<y}Y,yR^\:/q23]TX/B qo˕0+%K+_u37Rir$W7,\e^.S0+>i xY'HiJb5gC=gŇ+{d}+JV(@/ȍQssÔvQArX}"A!+R Dv!5rt#^dy|F1(B QKeh$B3|-Bעh5zmDϢWۨ}c`1 L&1K0%rL5ӂH1/1x, Kc,]]6bcob{Co8*g1qɸL<\1׀ǽ:x+>/įo>0@#|AL(&l%$! >UDb(1' Oo#$uɋM֑ZHHيC'g+u *****Ux*T*T\RUDѤR(3)Z>J-JSSbZj 1*MAQ]ZڨzCIB-@mZZ1kj/IA,%U'{ԇ5hyk4h\xIд hiFLEFL84iiM͌(*&?tUӟ:.툣͉;>>0~]IB{ZĚIIeIdWSSx)ͩԽ3Bfl?mf;f͟uy٧a9KKJ;ͪf 3ӷ[/8MA;Q,'sc`_VyK^:;<{g}9ܤllGNÝ;?]Ֆ v?ݓ/5{O?vբ3^?|ξnWN}a8,9Hڑ;G#c;nq|[i\8Ԕ$mNi>qŻ}&UO;M>]tZvp̳}sK>w]"/\z\G@ǙK>Z/{]>qqNΆ_~mrjq)ݧo8{3[[WoO}'ݞ=һ{}ȃeqK?*l7SOy h93}%>9ȼ//_m|P' XB(+f5&!3QAfQc3hpXcQ?J2\]bQS$LU(lɾʿ0tɿfhpo\$V cHRMz&u0`:pQ<bKGD pHYs%%IR$ bzTXtRaw profile type iccXi#)),D-lL ɺ;>9p[jl:CwW]u7i$iR(ZB/j$ ϟqV=Wi}Y/?׿{<*\]By 3Av|:UṤ~0nc,gu yzUbi1Qf\=FL:Q* *DZ z F@P\ Ζ ::xJ118{sm56k3h)4R84J$ۈDZI8`m,@{ <ͷ3;iGt m*$6OD1P 1NIY1Ꮔ/ .H^)F8yxD- pOp@?Wn6rkszp=o%΍`5mQ'#,x()[ :NVpKeJ&\rD`+D (:Fj(콐+E+D2]&,DjޤWo+R9>r#% G85VnM݆PU\3v5GjP|*X_$6 ݂FglpjCh8&Yxzh;urNtR/ 4-؎<;ƩNTL=LRa&p$q'G.9-K"䁵td&zKöA9ְqޛlr#Y>rp7^JD@2a vFF /+FWwMq+kIJLU"S1MT'/Z'g@Bi)TIޣcYp)B^ b2VdWڎ̽k:cŦ[ߑ܊[Tp:(ڣv..xC[:SZ =qMo 8ڑԈbwyQ3,ǃ@@6?s8qUځ0D:.&-lI-:W~ãn(^"I:0#R^l;ޜ;1*)%gւtzXI3,=,NJGOuå`2i31ЮRkTb"%5{RRH;,II2&l%Є\0u")\AeAR"h8H!pfδj5-V^$k À(/'\YV)NA!BpQ|{ǶTsN6}ܿҍ=0Q$9Pj0l(N~ ~@*Cem(wP^j E`JTPǢ#ł,rលtV}}`BPe.,##"`} KR|[, ;PVA0 IPRu`Fx_E(#Q .pPk휀mȑQIxQ2P*:GD1ơV:zy) qrUՐ T8A=U|(<b6N1,d"*]I9178RFcqK*zmF ]{rլW(B#:Xyt17a|O;Bt}.YG`"o* f;R4R*ʼCKtCNҐecUWDt' -3{W:e6AO\ Ƣz[P] G\@3]` RF)()Xz&rz\mJE;v4Wu'"0+eǛ*6ǟvG5h[41kIm6pCQQ4L\Z0cEQn(1uNkOO ~./W/9((-9^R~NKouUKOb-݄2 y UxswWsu/MS>eYT*-|sW k gV}N12<<2|9cq1k#nE?+csb?$9M3L~ }-CIkxlǛatS~OjIqϢkC{7=qڅ M&z#*pV:y0;O_ֲ2rxoqITgjjkkkk gN  MAȯm EƲ 21[i4+Jwn] ˮ.K7z|6In#muc]Ez}I-fcg0<\S}jLqԇ;O?<ɱn~;/^{ BŚC?x^+c !pb/CR#=lWN7uGK2pTA@v0}#Z(X/2.WYQ{roeL#^ urZ!ӣ 8A_E/˹E,BD%)HC+G  yuݾMVE T]X^&\ىl]~F9ШRz4T?-Q⾢K >8/0_+PQh[r׹gnrml呛[?&J컜:Ns{5G'I'%<8jU{|X(oF۔sm\g Gj ^ŸEvYsN#hGyګ]{UCjP͚e,,G$]'v8#o>0lO:np*N`I&~{OMMMMM?<ؿg_VjWA#(2Nsʓ񩩩'jgT@hp8˓YVù?O~5w&ow4>茶E=xI[G'nȉO_NO62xc|gT`- X;I<}gqyp.|G'HeLV d2i!&Tf4LFoRחr6.>,?QoEQJ eO)%N3FѠWՕelGd2I%U:h2*YfPbl;PG0Nv1({Z{O`]s|^$+ٔ[ms:k3+4zh457ڂ H|ƞA_?< \?w,GŐpouHglVbuM['DJP 1n_UqgӮ]TZmo$Fc?E!jHmI +2&ۅ <~cRdq{줲 ciO׮5~_!k[/,7ni;L|~W|=3vs`GIq7p=gdQ A2OC'a}`O4>t(gφyӹ&ǟܾvܙ3Μ#Je"kYOJ9t ~:[Aʏ+ێ=}N| WK)kS=~[cBCl ;HqvT{`67dL.ŸvbfogN<{ҟcsl-=qRa}y3yCJ|^K^[:N-IH)lhP劊&͙Zu;u4zM:2جv;UCUSPT(;42;RWgDQ뫪zjko K].%DrW|w癟@vؼBܵcΌF$2<|sifEQԦV(uMԌEfSڢAP(*kT=덡P!謅WJՇ{z [M(qMZ龃={ݺgX.[{tKR{lw^[a$47t<#ˣL(֭nע "R UC…`s*j7mYp &56v_& "1u󔝾.2k'_}qu'ðY4iߑA|xEO?vbO?D APҨIYw|Nil]Ebn(YS$p#d~v!KW,;~/f>k1L x"o߰eajkE)јQkl?f&3~kN$iE!ݾR| U]mto]Pth čJ! &lnz[ϧޑ%[ĸ5b\( -o·sX!F6")˗/_|c2a.e9ϒ5+Qb{2 Zu-LDiaZHMub0}!z2\7*Bp(E~@)L v?&/{N~0FzJV1wd-ƢW|ߕ }4.E_Q qJz}䳇WΟ:ZE&^ {'ol soa+E%D͵Ue{v%IFfjzܬ fO^@8 B9I|ǽiooe~sbI/͟0/Q'%4aEq׬^%Ro)Y+;*2*s4v ( / H+$L7JcDi]\[4<x,S5ChT{>3Ғ gXtjǾc @ibmv6540jֵQENAՠVkJyf?᱊l՛ݴ°duՐl.gAN<W0Ww{ǧYf{/$d)῱=rڝܓ[y-2^Glk?qZRWשS gG4%29 V𷻴^kI]֯!CEB Պ%2zB~.- A f"EVoZ|l#3Ѡ [Y8/I BՐZ5T0h;}85 \#cR0d+Ÿi9^HжJ\v_sT1ԵQO%\%Q;d/rLvcmWn'0\:@#$:8J'ul܁c %TW׆\=hƀlGh$B S _]z]O O\?Dx[v|+-ɨ/n:&b2r@΀h4Zj$A[*Ր:oo_m/{*>k W9#0}װwY?RRኘ IO¶U*C!hU}5,G0*!yMyX3y<+VF1(^ͫĞ|K udsa xb|/&rY7MsثWSϸgs3J''04=Uydy-b* )znYܹv0M# D6<s#H_ｻM4 V,Jj޶*~&pFTť;X5߿CCr{*TC@G[]* %jx{O6t&ŸF2 IHEO<}́% B5ykĝ 8dN7_!*_@pZ 8c/!)9O-$tqjo$v;JVqu۟Kٱ͞~ DBK؞b9SX˳VVҭE#ߡ# 5 PqL H!27٥:ZQW>y7` i̎[>CCm1*USHԧQɚRÅ9Gq 4U M;zo[>R>?ud6~A°1fÊG:|dϒ{.$T6K?qy}x7DRVU  yR_Lj+^zd c.Nw9n N;*m^UBIUH o@gyQ酂ΰIۮsOܥ-f਒ބʖLs^ťzZ_)[/%ZjvH.i̔w)"\s5>G + rr@gC=/R%]/NkqsʶwAs-ei۱Y"$&&&&&D/$.11111A9Y M7ƮIT@H8Ufޱ1b JvEN*tEH5XUw#$ H3ağV$B"r nmqj9"]r!^ZIl1\ըꊨ:;a9c_׏*S7gHkV(-xs?uic3JVnȼ녣e_}B{%}DD#scOT"&e^UNm^/1bX5ƻw<\\srrſt;$`,0Q;0 NOOO;s~Uqr'BORhw{"ZHBh1̝ARt !+buNOOvRyI~3A1v:g6(OĹQC6+EyM[+@I'(mdبtYi4+[Ţ6.U.f2,b ;');aN?p'.[E??ŸH(d]xCY/Tl0'š:gǴ!=ٖ`LzNF.P+* 'ݢ<"jy}Z٠ٳUrytXVxuρ^wZ*Y -[ ql_ _(o8Nۦh;}K{?-DHr=1ΫLW}?gy7HS qtZt" W|92cw䫃GH ҿ#G{JdwX?A$]?.J :V_m yizfW:v O f>d3>Ii2yqF%y&kM6u1EU*ƗpfK-ovKV 㔈'"rEטzoq2ŽkGŰ_ɹD+mn8;-Yz_%zqPfrGio/' ŝߞrKjs _ d5c1^]8fkޓ&53&Qb=y2L.+$ɧpHS[o# A:n[Go___O!UyGq"29P&esWVc{p9Lڊ˂Uv+ԉ{UoRЛ1}2,"p (3=҆)R%nTV1p7Xڀ{[r?=m&f{Oi>< %a;˱gOQI?87mKp _CoX>Sp7JRU'6p _Ed\ZV3g~'1[SRRRR6 `p `p `p ``%VV,*Y nȒGYaLSeNu+cL&R ,/S4^NO?wI|js ܁p 2.N7 Zm]n'[%j MM+j ^['UhY]қFm׺a8 ZeY0P7,mqAhVb xONJFb6s~ت²Nm[j$J|jlX^&ܗ_/jB׭͗)<ޠ"~_ߦki~٦ <ܜco9NԽ!͹((X/_SP>8 <+(jnsUydc>,wI;/9kjx;9zzAqro}g--󩽛~~VU ?lz1zVfkC EQJWh. S;~fgp7N/ Nz:V m ; y5j%CpagZu&}]eg2I51شgDHe>ʘY1Stٴq^=쮾yk#?l5~{}jtJWѦYZRC.rPE̼Eݻw޽b?rد>~OZvs0 Ԡu4߿Ǹ}yua|}r3xw+%GusFcpM]ro8ML/(Nխq5{D`u"1w(i1j-fm}`jE%;ib2]ųlv_Nhh1h_eΥ3:PEv;h{vg-\uVO˕c-W3w΂ (ioZF~Zh{"wc{jVizB{# >}oxh{Ü{o1 {{ppvdzsյVQͳG5M3W'ͿXBDx;:4! .E*L˰lѨ(޹u2$.NW/$ir+W(vtfE'_7pK5]~k m:pN:4se"!?t޶dvpuaswo>0s0;`-܅Mwh 2_W0 y z x|ǵ-ÄLzJRV*2꘻}˛(f:w̔rUj=Jc΋ͯv vFnuGq΀dh'd>w>. pbĉi2{5GUqh;/Qty3VmXDx; 0ߦ̝[V9J2(j/A$?j4nߝFEюO%*sЅ?/EmsZ٪V# 6W?:krsZc#SSSSݼe{e0Zk~z~n<~Ѓ/_MM?~±_3*ybfeFo0ƶ][+c J hhժe9ְLVT dyz+PZPP(+ dL&_s1eM)Juh4 MjeΎx^?۹hdjی&h4MRYΦPQ43s*c(o~pcnBSz3DV;)lGzm+9UgmaQLD1wDeJ/C.Xa)ouHglVbuM['DJP 1n_UqgӮ]TZmo$F )mk7gE VJ[ f~2;ﲩzn0eFӑo\i?8G6VAZ :C'(=gJf)Z15<}JIo~:1V~ yR:˪rk LtdlEѿB-(cOqO;S֡M?U.!Oitvaj*-٘)9u%Y{F*!ߞ56 $GSE<|~ (J ⾢QU<hA=|wȡN#|pE ,Ÿ\"ٞW EyNav)\[ʊe&z-ïЦ ۭVET` kRKL}?UOȅ?~ ~j7 #tZժwZL=rl o<SMD5iZk~~sZ&% aovT_ɳ/9:6J\\+qdS{KRPT֨p-]oTAѠSTUTUTitT֔&Z^tf]N%f ^sf×LMu NI[ 1s!(lhP劊&/d2NPT)ʆ&3MvR26S?֟J_92W KGX#Q]On_|̙SgNzK:3ak/^O(7 U]_UUըSޘl.}A%* B_^& jQ~ T6 Ü?s6.rcC?0l[Po utXf/Dg:`ƳgCͨ7tASTy! 'gaӱO }ގ(j#QlZz#L@G'z`Zx%^T}<_'фפ;sѭ }NsI\ ֥W[NDvOYB/-07+]#t,hǮu+l/js$wxקLQ#e*׎m:lz,Ոw:O)죯zDJcԋگoC/='U3.?+0V" ӭ]GQbMCUA&3$퓄R20\/_o${F1ݼsD=~6vuE܉'#܃>bjZ˯ؽZU C+ՉV%~7ǨeY^ǸG1 Oxo^8G$joBDizׯSŋkE.[ ]>.':-3z}S ُ+ݖ;K1[(8C?"оUءan4?,!n9:1M>ПyҎƣn!Ÿ׭k4"3]╧Hd7dӔO&Ɣ}CԦ"5ęC*oVD+aKCظ04y-- 3}YJƌXKM;,%2>\]d&W}͉:ͣx"W*ـWu`  ϥ_^wQc{n5!3;2BIKە$U>Ól"Vy9_}𽄢Vb!$%&b{ͩMPG6E_nUM.SߵAD y 2ډbuԂ±7\3/_P[Z,BN_iY+k˟ t #%AN)xk$=3lLb%΢D dԫV/JEboo/8~큸TU_G [_ɅG뻦O9U: Uפ|uSoa#QEZOE`mjE1?NU+w{Kc. \L++7Єz7x7Xt5f3-`WS=JS[w8`=}fO ÷ ѡv<}!i\;n'}!> ]*L3TYn^>869xG"==!>>>1=r)ϭ؝. wpS.Qid"` ܊Bb5/DlѠ <4WJVioZkr;';D~ݯNkYcq7K_ӷ&Ab ϡ5]`Ր/EDA)x+7ƇN{g+$9Ěľ%HekVnصGZG'WVj&Y`?HYsO 2˅^܂겨ER1  L.uc_IhU -$ oD^E|n~q\wh /Th< ) ݢпDh2*["#Mg~ ݁#aȻ Z>\ⱁ\s8.6w sMnx9qAxկW]|˷$.C`j db?_@Fs})U)o؊RKSe@+&)C vVNd4nG??F?A$ΜYHĽ՗)W_挋cMuƄ͆"Zj#dyz H5VgQ\+k+o .kIUd0<}Wasy²񻢒Պڪ=$Kd2.YIsssV#?G K.K>*8cc#N#coyYQc* x.< E}ŸG|<7yqvv$'n?:[#g,BD63|dgoןkEn;}5*9MCq-\? GD?p_]bRiǔ_i[HAj@ cW7'''i!+}WURAd/#;,LN-|x+jnn~GVkwrO3*ߖ|]-v́ĝKUGwNݓ_]LnZͣa3hJdr uwiN, ]ܽHڊEU%x- Sy&JO?C|j^]E_,*?f&Aq~^v7*SܿysН᧸C×'\>%d-GG <֤uN{1r Wԋ+?;%V| q>9@_Y8/sul/W!6S)tޅ?Z|g85>*Ÿ!to݀/ "Zy|}jge5a(ŵpQXɯ50EG֧,jź*@G<m%|o~]پDOk|Y gU_גXulqcCǾe5v/c7x*ϫeQ ,J\ HU_*^.*ҢH;D . 'wkh}wq6u#[s?c2}$7d< @ĝǡXzŸI^7^b0r6΅Bedh4L-5yrĩpnd_O_)m=} 05Ÿ c![g-vӁ_wXOl'a|i3n>QUɀ.*kEQR UãGl ZK7HdiVTjr4j#"e/TbPj'BdUAOȯm h6TMJyu(|)gYcF]GCJq U(?&׊=bQb8b^_ɯE5k"GV;Q[]"?qwс(p裱W`o8xKmz9=Om:=*b7UY ]dxl+q +&yU`Gx5ϙvCȻOl|#7XM Zo ~#Q{ڊORvc-.Z*QyP>Z(qӗ`VԕO:?8S ;r},ےc $U *߳GJ>U]O.uB>:u9G,}+CcꋔHO屴OM. Gtδp=#;|H>g/k!sVd4%RZ2J9sJ 37"h깁ZkA͹uT+Qvd&{<zzS?jLZUku"WI ¾&-wXVLJ0쬋7e]WPM}OavqB)}@53%YYZ-JT *K :ʬDy6 ~fhʾ{lv(w Gf+|K>WX]7>ݥ R8K l$`w#ZOȂr)<_.2!(/.//p)\s5>GVaؼVIxSt!|ߦN^_Uucllttttt̶]ZUGg-2 A[J+ EZˠU* 5?:uk_☩kzq\s vsٌW}TCgLէ[j yҚBZ`_Ɯ8 [ɛG_+'>=As NV:A!8ﴗ/xIL] ;Z w8 m'.yÒHsOݶBWZcS Y9^TgPA%Bڭ E bNEQ sdjbblc)JbR5asds(}lEDqB)!RJDtߕ-[HѿCMR,ut10}% U7fxӉP'TYs)Mz+,#{r}Rȸx5Yx~1Cy~~UY)>>>>CZs4Y^?;yj r-zM-N]]ID Yh. wi Ή?h妧ǧ5݄Mʭϻ^8)o'dPT\ 'չ^A- Z!ԫJR=YJ=|`[]%t vzz7geįi+:QZYR &oMszzz9JnhJ ɼkvzzIkÖ<;Yfӯ_>8GfZ$*xAL&׷Ў&MG]dK {-&ՕV"=͉bEuEE; d2Yl _U\]vnL]&uRU;qɻ/fQȄ?V\&ƿh=#_m'FP Ϟ!C9gzWƋqB,!2Ө.K^-JD Y:lXvL>87mfQcCqK'n?:H=a+eMyBDi)gayli=ʭ="o+*o1L/o=rm*چ\]mA";/p @.t:Ӽ;V) AggO<:f<^r`\o aŸ%썃OͲ n[6\wv}gڳ45jk 2k̍Gs,7~!l+W:Ii2jYxE /td ̱Gsgz3~w_Z`[>63K_#"1y9 !<+o{> k~>d64ijk `[RO^7+z7){;(pF7g0wk H<{TS[[[[d@>55599S>Sڏzg#O8wFP>OLdEydk FѠly`4YL(^]Y FhЫ26$n_ Ɋ d2,?QoEQJ e2YLVPT ɤk4+cJud2!&W^3M&d2tJk7<1N7Fc[sc-ts%tVx-lDdSJn7&uu/x=|BVAAoЪUr6YN:No5 槑q EO-7|lDZF\B68\ӄo3@:"(e/Wkh&I;s/|E@*½kU1ejی&h4MRYΦ"/*r$~$k+`) 5D=ck:Qmo,@$R"5Zil'v݄?v2JoP 1s8D)'4 UClKbx ;1 0<ѻy \Sb\|bϩ9Ҵ@W R:/ g+ؒFQU7Ӌ4AQԨ V28#d`Ў ^i:6u2X\jmR!Cߝ \EZl`T˒ZGg;UVI g(MʪԱۺ.ZTCiDAD|T -ClOq~Cg+d\^Vv柮]kBCVT ~+TiyyC'W>s"&4*d]6udҟQbknER$zEtq^TDO |#H@H^ )%y2\^T=1N >I(Vi6iU߷k4/L/[_M_A,Z("ȋ+5,_ ?רԵWKVG-Bl #Ekhzr3.x2Vk:S^޾|7G(Րm 5~33N=ѱ9Z JEVJ鱽TOTUMBQlh2܏:Nӵ6:,vBc5ht8 -&EQ[Q.1֥/h:VCSBPTh U-AʩUAP(*kҮ7jO|j2z^fEQԦV(uM+ i7t*na)MY\ TQSf}@c:q~CgC^o:L֜ytщ)vGve Koz^-,$T>#CGg-^T>}HU/LފhBkJ9%4Q mّO v^ܬ)c:DJ fCKuB.WTT4 !z}&"Fp l}>JGI\ ֥W[NwϐB/-0j:H:2?]<:˄(ڱk v- ,ՐZ5J*Z-\ MqB2{\u!`w:O)죯XDJcԋ226D lਚqO^9ĵ-5JZ)b3TY%uo2YL=VWzSJ,*vsF=B(vZˏrb`oKB5W%j<[Vh9H;KZ0RRA[֩ ٴ' RÅRϫ`*d' 9("9;at+Z7Dz67r=nӛGU7|}DM0/_`>6|vG#R:<8sHMފh2?;}Ų7b6GM(jo,ˊrmjs7ˮn#_3)jb"EEP7޿Пunz%qah( [Z&f %3vc-5<Ycl2kDrMQ+l:i8YF&ޅsK'J=\z]~\xJx$[ YocVˤRr%T~Zd\^a'vߤ{(h(I&y\iĂ:wezO[يFr,ne]!+4櫈$y'/&{3{EKo$aY>`.H!*2z|JUW36d{eY ΢=eVd} 1 . (;<$2n$'NEfλ^_?e*֐/fern0l#@o_{?뜞v&զQon/*r@MI + ܄M*Q]U96vMtt؍;vѷrͶ:V-5*"-_sYV\b2IJ@:i!`(ʹTa%!ixژ <C!= IӬT]copeb"u%]/L[yH3ŵ/Q9fl =֢͑ߌ+(ڞ At&Ϫܗ܊&è$VZK{տA݁vȲɯm,°Y <))k([)Mc7Ph.jju2ju yVE  ўMVdz Ygv,&% ? y-c-8rwN0lN 7]zB{SFTAG&._^'ׯI |#p`'Bn~!1߶,_ b=mU㡹:wWE0V%>& o15ܮ$h1_R !_R&jE\eFdz&Cn*ѭh݄9߂_벨B{D4 InBrjebT2*W卡<{%m!ǟknqk摦EƳi> X{o[ 2乬HG"[2cW30[H2^T]\[UgWd]PwioCGo^ l+*G)GSoMIIٞ5U5Oү02#+ډ7QU}sOiDƷ #èfUZ _~KΣ{+8Q\nyǽL"E/' Q=JYo}cX\o-F i ; t8  ?=է !lء/d~+{Ԡ]wƞa!Gz D/ ōzRm,yƦ=lnbKC |C4ߒ蚼{%|lp; {֦F%6mI VkwrO3*ŸH)yP(\ hEaQ.qtQou:`tSleKFqҿ֤uNrL~I`bmNK<) ?d{{jHY x/*$ ':X5325um *(ŸO|,U벨-EZCsRR1f̈́"qlR726Q;تˬ cQ׈!oOӳ!׳C1rF(l9G#CWԣɒqvcmT7r(?wLٸǿ*W'm+Rラ^ɣF!1 [ &Q_.uLNed)h4L-5y dCmjH7[PFVT/o[}_<01Bh5:bAEP7_Udόr"W'ъ{H#sW!!=!u@r`1#";_o{1@M0lLx]Bq~n!P?ȍ"Bĵ D)% .#Y=&\Նmf{ߢ#7h$WW2.h{ڊOvc-mwQ*P EU`YaOÓOO}-j7l! JuƓ~jLM"9[QW>yO𧨑_F=Q#p/ qYDOYo~{%cVP{[2;CIf=^{FHԧɥ~ty08[izJZoq?*uƏu5IKDީ?{Y(M =(-)=#UV~^RVU2_ͻ2GqB'LZЀ͜ bT^LIQH̸ ˉ`ZUT+6v|U}Qmxmdc:ٜ[Gy<(8@8vTʳ:BRPŸ!ֳBڡ'+=o~mq(H _k|q. u\#0VGq!1 bGՉ\{ɑ1["{Q=e3@3?wW@x Z:.K{}Uif֍1vk VZDO비[J+ EZˠU* 5?"o9@N0\3kQg $\ d{K(Z49~|Kbzb"q(p73Pt {籘y~9~n[nzM>3Vh++rR'+jTf޴T] ۽cc,Ś@4DMI5nY A6ꊨOӋ4(I(&k&ُ؎7GZs.W$D.r!YZIjX)Pv wHDQݔX8cSz Qc.C7Dy6q_>>>>|xxlf D+wpS}3Ov/UUCԨJ voI^EEEo|߆~2wk|J[Ꮚह:9kI%N!b0*vzOkh1M-db 4 NLKQ !&o{sEd8&;TycYԽ늣 q>t-$z6qiLGǬHbcccc%+X[7PW;РZ[ Ez5n{t:ggG$YSPGͳ(&^FEQm,L sY'Sco? {{R{+ 9_޿yTڸs^04}=nvvd+~笕˗cdBQEUam$&\g~~V&@KhgT ǹ^?<F0)HW"T ?lz1zVDۂ\؂:3˰*;ەL6Ʀ="Ԣ+c~gLe-K4}[Z_cW}4EhpoVy?:˘9TTK tȥGNuYb!#K71^`?ѱ\vKפGh!W|dh-ah8v%n *c>^ե-]>_L^o}A䌼]S}N}~W}S9/jSuk\=7Lh0zJ+W"Gɽ]`p"sZ2h֧-t?*II㸖a*f :teECD*s.-HՁ(jQE?ӓŸǗPOO/)?ĥ%'d[n_Ec y UxswWsu|ӣI!b.G,y員߯Qx4fb QkQK5__P,_?uSIZ͗='NzH0y`νސ?pqaXB$u`Rfn=m2?:n-aES1+Wðkw]S[k{lxl7 |@v!uh B~m](6UxaJQW]QseH\vp^㣵IvhWD-x:P255(ֻ#Oj76;"yFm.)>MS 5&8Sm \aݛOg0 \z+C8 aRRߌ6ңibIDATN~6ZkGx@]_?V_jp 0׏?;sRD*2Y?SR~c;+6YUQk>3y@YY>Sxѥ+3OU;o3zZ B (EQ:::˧ei41QI 2J_Cf^soyE,UGW0&Fɭ0Wv"(B׫Q4f#f^֤ÊbPjG `@eDQˢ]C,y&Y$ hWyhr*)=ϩL~CL[W~v(PK?5v}pރ !6{X(O8)(ĵ=&dmsM{ѥ8 pu96v@`M); K/[H*zȄ?Wt ,Ҍ}wQE;?̋/^[Rj,c9 "TˆAJ=6082>>5555> _WU׫wOMMM?}v SGN =xrz';J('d AhUp]xuVo0,&uU~_/ήS h4UueYR/NdE2LWШ( @&+(*d5yI%U:h2+&d2 :B~YYFpAC(6vqПW'ӄ!"Ap IV")%^ۊT:kBBVAAЪUr6YNv: 槑q1 ŚOLMMM ^G}ۓ'FQt;Ǒx@ut;GwO8TjQ?vH+NZDoOcϠɌ;𗡿@7f34^TQK-ܻVWVAh2FAߤ/l]X/*"zJ(g)a%DɅYw%).t J^iDQAHj/*NvlڵːV+-m6ChZ0V -)~>G1 sM]oi:r=HO*2^5HKBg|WJ݁_^L~y[Ė|5^Ħl~FmMe1/WI y)1oCJY'U_խ&R;(u[-F,9[B/G7>'L}S}/&s[ePUB6J*uŶi1PG*Uͯ]瞰(.Gv?<}Q1y.Aub\G>_ڕ6PT=6S G^ኘLQJ4EbvבJJJ(MyQ=%|8?A6hryec{;d۩r*Bd&ءu:NkmuXZk5TO7[L(Vu}UUUVO]j{c׭K_PgJBlW3NdS%{KRPT]o\?l*g9QBuN S7(6M]Bk^rT]HѠSTUTUTit KDMia@({`8Cxs e=!P  RPwO___O!Uy0Dx+ ?I+wx[W D=7=gG>1z]sNg X)RñR]U5M:C'a^߻H/*r'd@ ?&]r6'X^Ao.:> <:H?]#t,hǮu+۵_$HTCjՐ*hp/4= rq0qY\~t>jDT+*Qz{L"Wkqp?ԉƲ(Yj6w*65v]Q[xqp/*rGgByT !l\}Ö}BƌXK An+䪯9\y3#vJ%}*N|Vuѽw\yR?n^C +DON50vioLU`Z sn.KqD |Kh=4}B4$؆fi.cvbQŻ|in-fl[#9a i7ql rȵUDTm)N4%u5l)\ HLj k}۩w]8v* ~O_f)~/q6^ ~2ۇ}(q2 m"6-eP?syg !6 ء/ކuK?<ǟWˢ6qDk +t9^w@f|gOEk*cZIJޑVCf]f];+%47^A :|.qK؋ڡ9#U{tHKWFƷ>!~6+߶"5>,R w@NdUC=kBqY1kEngV?LyJ"RE=l4XS",II1$'綗s?ZjTZ6.G)ACѶᡎa؜۔7u6U+pA:a|iAE(2BbӯoWBm^0Ko_p{m+Ԋm뀘s\J[Z#۽FG@7YJ8+p׹ @?ZqiaD[\cYJPs;?$B5Q,f_d|y7DB.Y݄ Z|Ә Zt5xC~` )%|z .Y=}&\Ն零mf&nߢ#Z6ǟO_k/_ 3Y@+9YSaB#h{ڊOvc-mwQ뽺*P U?"Sð:F>x\S0Za_`}[yр!S JoO߅ 0Z(tpӇ8}VԕO:#>8EMO XɢOqz:)8K lWoSbP 1;vnlY%sdVCU֍H}껞\K7./Q sE4U GBX8]瞑JaԐ"ZGRZ7풲2Dռ)C*t*I!Q2Ϥ~sBldy\>I J"vٚWz9Qۘ[RKZDᏒo0쵇AS=Ď^{V裸>?/䂃,ջF]J?G3؍ VĎc#D "z"R/q6/W [dfn,mjD,U)[7FGGGGlە5XjyT]RK=AGo) P(5j=~.VP(O,U_>@Ξ9Y{Wœrٮά=GY_.DCs. ܯ.4g'.s9i +=:ﴗ/xIL] ;Z "%λ^fʶwq1'Жq *tmvEN*tE̛vdwlX(2iS~FM1s$!Ȧb[]izQQsٿVݡX(N` s=w^c9|)*Xʅfi%2cFBڭ(*&ODQݔء8( 0 ws%cB0}% mc3QTYs)C@ZՕ$H$q umrǰ;hUnϐ;f8K.wyݚ-~s?uiä9av3T\+8wpS}3Ov/UUCXJ voI^EEEFd3@_3P#,e?*΂\S%8IWo{z^}oB =nl!cKipd!bfIYUu VLPM]NZEyvYk,uV!du_f2,]hՕV"=\ۗ|\PE-&d.Ҳ-QTRG)?I%sb?LarrEUSWT5d2Y^MG^{-<v(QCԙgP际'۪Laooi'AQsgj817aM[T? v̶E~Ы8˹F.P+*7IwnD1VnDaE6ܷЅ񫉩z}GSu"TXez%U |I9[FNffV$Glqk27jVg&Ylm.DZ ,|h /|fBfcM-?sc3z}7}Ĵ8ci5xJgɡLLcʑI]\+Ÿ9gLY;ZJny-Ze/xSTj7 .Zצ.km&Pۇ* U:#6 fMѵMv꽗lva?-DpnJ*n[d9-u妩`zAJr7câڡ9|*B _KOE;vghQ\yWRn3)cL>Ii2AXxtd]"k"3!}$+(2#9~ǙތW5p{>fb+}DNLd-@A^TDOYYDZ^IիB0i_(Qb=y2L.+$ɧpCR5ާ+^ iz{|#rYz]z!yqB:IbD&ݳk{b\X]؄BP(%2iDL^(][S[,s۾g%VR݂~p9hLgđ3X./d EB\.m̍Ѡ&K UoE T imV=CaBp.?uIllll5gVc{p9Lڊ˂v+ԉ{UoR+5:zzh<>ޱrym;wry {VP",EW@h`۽,<;S,S^."d 1yߩ}j!~&IH : =p ]vd&*N7p ]vd uiM%F 45Lp7׍(?C p P5%%%%eSrbIjZ|g C[K[K[K"WZeYYꦕ\ϾtNOx9=pج6h-H2+LbIjzT3> O;›e*h4v[&1=VdhԖ/OwnW,s\=eح^[`k`(I66 'v[{v\PjX,6{[]q)RYihX,ݦrN㲕6;2[][Mk6mr)ɬi/9g4͵\k k75g  Z]+sq`ӫ:ա;:@5?^:cs󢽩#7~ [?gy;sʼzyVEQ$[ ޜۈ([!zy5dvzoUG~}m;_^>n6.\W.; 1y_Ou=~<[څ(Z HN+Mιpa _kdҲ/!ⲫlW3\tlvxT&S3u@M\b?,GuV.GwLSzAi=kkҌo1\Vp_ݻw޽b?rq0 {WĖ9m(f![.+xDnLp~xr#-GU|dh-ah8v%n *ca /&{}r rF k>'>)E©5?fD"Lh0zJ+W"Gɽ]`{:h](vZ jZˠY[$y'MZBxv.\iu -̹`"UnGQmOcIkOO #n#8/u+Ȟ1[b*pW,OkWg^Sݿje?t5%u@-7OeeRVeɻ^7k`k g ī,y員߯Qx46#LwZK<,_*7_0{!C >&my ð'g'y~$!{݇̆&Mmm=w64y۽QɫF|)ކ(pF7gQ>B$u`Rfn=m2?:n-aES1+Wðkw]S[k{lxl7 |B6;Pm,0.!F4{ֵː:_tGk6"ѦZ;P255(ֻ#Oj76;Z4w#g |\nQ ]uQJ~iБ> som)N>bm8o羖;<~D97cdh ';ܜ{r]k꺎ɫnł\?6o϶ Ue~ wH WmLz⣣ 1ů>e:WV&^t"zLhFϽtU[w +=ƯRMsd2I]_*<^TD7EEPRJ+ (\A36+yEA"%Rsvb8Mi.C*Z U[[LX߻T?qh]s}]uj O-cӣSS˶I{,*(cϺG;vrm_}`C"{N*kX;K؍ Hdj l|>**I!dIY:Vb[Դvj(Mc(v hwX#n~:Gq S˳t!] *YoU.@X@E~pc3  Dc Y$fW_gؚ[9 ^DSB9K +^cW  rd{^L.mOxO;Uڥ ]*זbFe++Պ8*_kd_7sG"II/Cbg6}`T;k }?U9~3Q8k/! x"맣NLeq&s\Ͼ}Bo!y Éް +wGw1y_S񇿝9wKͱ_gt g>k>#WUdV)W:=R:HV*ݡR(* MfZ^tf]N%f ^1AyKń(jkUWUU5jԥ71ݺujhT( ~Ry5c HV9^4( Ee q[ň*6ҐaO^|L,A8r}"5I ' 4jRrz_ ϝ~p#4Hq$?$Nj]&'#܃bjZQnΨz#g@RE.[ }!]NmɞכZXJ5}hk-sSG؝%ZZZM]){xԼgnot9m̀ l1xQO`*dZ' 9(X";m>9Mzׯ 86,g\C7ؼ6+r\D ,5=^Zx0?;qʛf!B,ˎٰZf4u,+mZݼ2|UEuWԖ3^\zE ܋)ѿ|{% y;KDCظ04y-- 2BƌXK Al2+DreQ+l:2{() bN- M3M7C=ٔy"ID(F}& Q1B!4k}k|Tud?>]UuλۈsCd`MT1sy'.)ϔlR~UXS0d ؘK×yĊ5d|WۛIϮuԊT[^^ UhbldhhdDʐG}V@ /*OxQ,EByF%LɅbfobk,LY8&&fqʍY-` u}ET9TإBD-)Rr4eY H(WMT؟ðuÔ5TEyb alrWmc)tFïz=CE~M%AkGn]oKEr G(9;>UabHQdx==8rK$*1UY?A| DF8{,K/|\f_!!?${cq$VilG`BtW(8npR!WRg]PatCne_A\+F,VO~j=n8.[}v3o1aDԿ[:-KH!mI/G۳D "E(٤Ka;')mK%d0zC|ѥ/&?{Xy<8b+:,zbdMz_t[TꁳtKDIj\g%3Ӗ8o4zѰp6,OYfJ vQy]pe K6\A@a'@KUӚ{=2 YSNהq4}QcrhS6gVO9]ޖ2wB7ҢXu`Y@ Ꮰwr$0?J~} gH W%S[Y-AQYJK\Id3y7ϗ{^C˨xt9?3 芁*.jSNN/Z*IɻAp0tXǓ&r1D{R>w_;}b3ʌm\m9*"lѬQ AdҐϑoɒ3 'җ,X0DJ/gA߰Ekۋֶ& 4p/{h6j>;K Aw5hd󳄌Eo!QVOwd[ܹs[ް60 Mb9x}>xO?:5Ub h4Yx;y H@G%(kUJ>uZ(lNvZs,Ғ-7^ۡ,Βb a$srO){6R6zQ[ } kJi̐dVQmtgp?wẨ2getjn,ۖZQŸ,@Fe8U(W :KK:8ȼm?Vߔ ɉ!lOk: *Qws麣IưM]SN9& [SΎbҫt~ 1/cud&oB.<2!11_L=<)'gߊs"ݻG'${eߨ-6T!a ?3Np[/(O~ PHsKxYέFP[U*F=ߞt4LĹd Z"[cfť="3oregʴx6)R?%0w>siC ЎոtӊQ{1gr "b }ў+Rn.[6,CXd͋uSaY2t?z.2OYH:\ zPDNhf%UzZ/Z#ZHcޚ$5e7ðoSNו[ ZW#2Xr <"GEaK"NSQ>YsdOkH>]9uzBl j1B!M?+@__tK6|y::0˸:3?P Ꮸ]\Ro2TUWlynU_>J1eumyG:kY6;UC &\sCwE@c>S˳!+v'E J1Ꮡ^6Ki|j- y?fJD_D6Xt\mڳ1k:w\ϔD+vW+za.̮~4!CW7XT+"CmQ*uXU}SzVH#")+G=_$^ð6V`Y(}2 _\q6Oc&83^z,n89vDv|6~tb|2~=ld_ ke+Ht_zH5˃M/ oC:1Px<T|u'5}\w مTJ)d?6%e ҅9)G\&%;-3\A)[RϟFᏖo| 78@LUe*]¼DL[RX59uxi;nr십ĬAt~vާi㙢gza0K˩=RDۤ>Q..Dk+hq謱<Ŭ-)'tMfXcN>ѮY<=/Jny@<"!?lF+aXl |Fx }YiB,b~7rosZ.-----M]<<~ٚZ>vߘc麥 uoCi?r?}Sɫ{~)f5#[XuF~j #O߄jp#}IO`,ѫN'"o g19WKN:Mۄ~d'ѧ'GP'3EI&XC@Z0'TTKdߟݺWMi^ uGb o[=qoȭFtXeN>Zpx)ZӤE/<ڽ/TYu;4o^E ⒪|3dްEF4RDfq ?{_m9^ZrBc[RtS˺q3_ð,NBq XafWRJ\;aK.ɠ?y,y#@^7ntXpm2|>ߛpF7xI 5@)aÿ <V#şr f{;8ȘnZGhq3IRcآm۝NGl͢Em.BG|ۗ\RpǝvOٺ+QtR+kꨬl Wa/|@(ertvߞ<١aM'e-o^kv WQ@;hu *9ШN{y9 #p? 0c/zr;zuY&תc\Ugs((*~'xEg{CoLwv#2 5tV)9eV'?8ی5[-<~lajw\8O ߋֵϯL}nyX 7.*YIpy~n !jIz&֫WF'Y;-<u妽5r Jr7cŴa Ħ˟W|&F~n Ӣ)Jz6YY;d0!0㡌Á^n`ѭwNݐ2*ȌЕ{~>2dWUy1'3=twҗ兞?q];)""TzLu=èU9 fޮ=]z7VO;KUIsb&g[ֆU3%dkt:N+֨TdVd}{("'AIiŚL9%n(hZma~X MT _ķ?U=]vc_gSXͼإ*U\\\\JURFUVkpݽn,_97"k>P__Uyk"Ԋ];eY9/fMYV[ߺi@]٭WIDzmrݕuWkVG1ںuj..U X~]z5ܘaZ%;Ϸ####c7ˢ`9;Y]PrD,u8fFqo,HU>Ńwm]/ߎ`lt- aVqOK!6ӗoƼ/0Xq]f'/ǽ ==yg#Upb9^p/F끻vVQ/2(1|}ڭx2暿M|v d~;<>j-F۪3|t>ۚ NS)7K  ny7^o҇k.5ҟfrtb״&[広vqO!8#_T|7>~~ܥe~q޷>x~0ð}0,J|_VĂOyr{]óaٷNrc{#p_KcA嵗5{{rxHB~e~B=]3`]dNǼщvȢX$vǷx T9Xna#߈ZSS'=P!u'gEAZ@kn93<0Eg1?8i0n~I:Ki֗1?&*ȜP_ ?Ne8{,U11[Z| ':IGE?Jk̭c-kv8^_ETr[>!̕-R׫\]sQIU&6R/NEmiCa`#_oqi(ԀŸ樗{\7#j|BEB鈆׿=|g&bA99,r["qyJ Q|4A??k_ f3ýq)0bs?}˫.ǿnX 4C3.e&Ir_4u kh-UO'іCKnlD:n^a xQ|Caq-;i[-mfA߳5+y};| âTj_l/JƏbm.f[ܖJ 58fBğ.zyB&ę)?|>"I<'Ӽ?9ߍn^PVQgMQ߯'&EVo*,58{ګ"6-Y98ۚ4\kz I2Si:sWng5pkGI@:3Vu֤IZ#>*6HO X|UqI[*LnP>%dpӻ_8o"]]Zg9BTٲ`^)o3tf-V޳ICNU@}dߵ?:M.STN|Xe&']"qk9דcRz4r;UMv\֋0Lм(HQr1]9o{x8U6kZma~U"0hJIʵ̟]Kֈ? 1H[>w.qns9<d_߉3<x#P@t)W?;wǫin5zρ?8{鳿>x6?Dk.8J=sZm1hA)dCWWt5 ?; gfd2ZLNZL fCz`=V;㸻hOژ˾~Meitr_e0lK6tj[f\ xt-.VCń?~[qJU5ӷ\Wt]HbUWWL%$ez-J.谬lPyh~ͳa`?j ?~p2Mve! lsrz!-*$V>B}N:%io]{ey?&8dzLu%MVfíȧa6LX>HU]KkUNՕWV7,y z&^a(9PVX1ÑaXTvu0NL>3[5oΐdبY =d :2??/fq#k|]0U&u}R"Ÿ2= s!)-| LAydDjwDǗF ~,kN]u{?}]hfJRI+!VܖJ>Pio2Yl=^Wz[F.7Fۨ=b8w[ˏ ZriO^JTMMbE0Ǿ9&q u%A[֩d93# X2o v WRɶ Ԓ*Ee*qr6t,! D_ M|ޫxM$zɱ'UpZM&nm?ЕG솽n};{KDV9k>ZN0fՖ^Ab#EKG<9 }ހy.z;aPֶ'Ď[-xp[T֊-Ԛ0WZA5W2uҙ a?+/46 -U*+:T=RWmr]W$k}6MZm((LO6B\y\^!wߤ)hz *ܼl)4+`\tu!3@uQ<7MU[ΐj UDtv;/&O q- |1WQЧtuu"cH6qՠrv9ȺƃC]%]}Oa<==!>>>1='~'1VtӉ!7}m7> UG 1q@}Qcxƿs_Z1&v÷osΝ۷nQUA9Ȉ|rcpUe2Ъmo1b4,55[Eŷe]5"vIfcuQeV O$f-;R[Y-+I4;;?Y0۠WS?BǩQ Ob DmH[}SRR6$'LUFϓ+n"nU}oDŷ tpF3jD ~6|#o;y_@PS($C̅SȵV|ooZaOXK֠%bQ:v, lY j0^\#+7$z6:+kXa, x6)v )7B9~!l=԰ Xo!H<@x_#Pdފ"#/ּ+׍,;;?Yh$.}kpx?z$2OpB\ J\DNhf%U'-Z8k_o8a] ÇpN r(.ot .K\hӁׁƃ.JV\d4CF+N9c?6~sI"SsSnOTU# umٷF* =B)QF/,!ѳ  x6d;TLŢU~W7ӊ%TŸޢmyUuzž=@rUzg2/1o;yDԨxQ")05!բOKu4?l@I.viLG 9 bS\'n RUVqFJ#r:z "ҁX^EtTv̈́"lR6;pUYY)EƢ׈1}.Y7$z6 _d=J X4T?"mfdVsYI畭KH~kH^]>?`  F@b7ZvL;NSf[sA/a؊M;2TmG5׬~aNh qmM_8oXMI]j{Hg ɭ䜈c 2=S5dC4ᏪɷIz5BtnӏDž]c$9 pǬjycDDEĢ2nwK$&'gCC^F@^QoCǝU_G2t5]p|*^bXAs2F ǗAf(V@9W+1{FV%;ND4Cr7_<Q_O o{TQ/TӋ)h9Lm7^!ׅ !q\zJ6. * ĝN l'` װӽ5QdՕ8' 8nM?)Yce"K;UD ()Х }.{2cE&'gCC֘CI!%iG%_j3ymRH'S)'F0Rq!14?~$(/vu|m dwJf>Q*uXU}SKzY#%s aNwh3azJ&oz?:sOy B.%zlRcoXInajƠRj+3Z+儿Td=?4 6%e 9Gi&;-3\A(RiO]AӪ8Ue{;U@)yGvv =/'%ݤN`G'za ,JZ Tφ&)P0sQD"7RyQ(HPkc5[>IUa/VioCsBy?ԧޢDԓ5[zQH^aL|C [:/QjB+ڗa~8%*nݎw:%)VĮ3Z\"<:_/%% Oy1kKIt:]u8XOk{-ߺ;{mZxjΕfm߲h?#aXTɩi3l$Ng/T|#X^ӫ>u08~-Nz_`5GnobotsMxkRNcpce2?ONUi7阻NEy8r4mdMݘbgV°խTB:_% ~JTym鹞}߽&3?;ǡip7Tk wk-!~;M즴7E(`Qh!AK. R'%D׌r,o y64O!φl1J$0'TTKodߟݺWMi^ uGbh-}p u^z7ӇƺFg`0 pJԃR^UC[ݺwYK7dqIU2Yo؈#eyUUh__N_=agwVpA KKUNcl+3RJa*R@U=tR_7sGX1zbKchpsƧTZb&ቑ1/]&sR+_M&cCCC#6>q n6 -*[vt{YT,÷)|f-qiN:#E'.fc}z^Pó0zqM6r .ex7w71uo^kv $WP@M晧??dЄ?<; $KD5>z޼ɝN7}mc>[V$tda###L#~VFOT᩷q Of~'X/0Ru]HO]Z߳ /-ַ\)NsJ׮k-կ/q-iG&{zZ8Eř[{=\m;|wD2>bdjv[x~Bx=k"9RrʬN._qk[&<.[n2 ں67 ďkƅzYsuE:#/NO/O%$p= x6vf^LR*....N%R)*5vk7f] }];D}u f=v8ߧ޼7ekZm&uu9d^%9Rf|T Qލ;g h@µ{o i^ ]8vEêNߔ9KV;)֫mv` ,YXoz^YCH5i` |* j6%Co` dt>RRRRRV̓}́.}́.}́._n `f׃CC19Ndjh->\ߟ037I`{}nXQo'l~aaN"'+ô'ad$nT]HY~rCһ,~ou& tӋiqƂd|yrv]C5 r]8㸣!hvu8.u3fTf?~ۡ'?o9p26:St=DÉx?=O+16⼯Y%ݝ;χ[Y$BnvVzLhscyۚSӟ:M,18/tIǑchӊKCk%V7>&^9`!}ryDN|Af.Vرcǎk6dUKSNה݈*96޻(rF@z U8㞖 .(-g5ó)7 wʀ.$VZT^{_w{esB~NKSSE>UB 0I 1-x#^0jhZ-vO9rqǃ8nM0ȼҬ)Or_sݎ_z8v?l">KxGn/G5q(VЛo&}>ߤw/^xj'/{"aK|c@;wnߺu֥8m k6{ɺ/!'}h WUT}Qּ|!tlb^4r!}M $E |ݵai66[SW!/u6J=z[?~=A4E-X11{?-Ϫ aѪՓ_jkkkk-^|3-_!_q[щxci]-&nLU%[7h.jkx^2裏V76G}AvmeJx=OܔKdx_}XZ+4Qn?pzctxXxO_ 8I-w LZo/IDATSSѪ^^̰N.#Vߍ7s%d/-͓ RS%e8Tl -15D'HCG  uݾe. ;: Ô}OS[zo*Tג?G/9W>Hd@"Ib5_d1! YwY(oE#'m8w:Ea0[h zn9]JP^x V& (QlN/#NIܴNQ]&N}G_5{J61)9MdqHPwXsǍZ!$a,z`-ׂij՛<Xm9rD~ݽ{ߞG}>ߤo>ݽ(bEO~>8888p]ͅBFxbwǯ^ <H.C݅_ xoeIs26ܼK'=?<x944444rcc[fLDrwwwꐸ]y[dlmbF^zceQU[-nX i䲌JyiGl6Na>C3.eYEe2A\ɋEq6cR;bn_}Qr6~4+os1TbXa {]~ oQZHXžTΣA^˼r=vy}rz~QDⱘbk;e7~d%In_OgtT(gGdPj<5Rj>Ɲ^6J%|zmIvבƆJb VTqez^y/B_Rdҵf۔{P\ENHgޭZ$K5 9[\gh>.c),o-pqv`(cfo,X2?/a:_~oaKWhXTX`Y;7=k/VTqez^ h6vʲJ9zJZ!.KCn Q< }DgȰb3x|:()ZmM5ߤW3Ms~v!^^[-$f_OOrOG@8c[yȵZ+TسبNRamQ/GR~]y%6XIbukGg3MӪTr5Z0?wC*XP]\]6PS5/H ϝKL*\87%EevKxsN8vԍ/iy1P|<"w0x:kG}bcc3׋gxsY%X~JDs'=yX}2&^|L_߉ަըgN[u*F?}ęsWS2}tw ]___߉O{Υ>o^ӧO_?KWVR0ސ`Dgf1+K+ &+,5*qFd2LSC\fSlH{+\MH-uU:ΰW""ihai*ifeP+ u;Օ:]yMC w_?>2翞=EUcӞ~Lˆ?⶷#GIk<|> r=BPen1{pҢi2lja4[7ۜAdb峆}dནNA Gn۵w^}Y8O|+?.N+ٹg.S]Dkte!4٪(d 4兿y16*v3? ΟŎ8ޑt>]r?Ͳ ZED[$gNgNZx@xBSgX[|>ߋ %{eca}JMOs;t/ROwlY;/ye?B_2/,9 pk CE[o&>:%i>tla6}I1[~+eS/`onZ52zw9\Y`<-4!ד o΍N}awN9]Sys\~q,o|g'RzqzS,b+E}+C[ Y%50*lCHs|5.qNr<#R`39^N+*aCW6>, !ըVw0'[-}#,%>\T͖DTډV +:=GGfpIxy3>}Q&UD?ư DszA'},[?}8+-GÛGٟaOp%ߔ]8ϐJ{~e<%WV}X/5 1y%?B_6|dQ{ƍ:7A,Y+KVjiG:S*+] _ / X4vcԲQ tWԼ7bh?yZhP- 78Χ)"r/=/'z|!ޯ[ؕm$eYK JOl6{%wixS!#g\ _)Fl%]+鹊T\jD¨Dr;66666rc]Db==weZLH嵯R'FFٓ~:`PR[ؚ*K2S-YrcV[JCY:fs$K+PuQl#ReUb2EJ:$4U״8#$ =7nC~W{L˘Z oq^">jLz).1߱h>9v$1]=Euc|eTQR ;% ]t@ԡ0ὃIYvFB zC))J hׅ4"mx::b!:hAz `ZvHHXUfvtZl"SwJZ#W|ni6pJ B(½/"?%{^OB69){s@lIF][V0r]%9;S˃fbװ%rIH Eh=? OEXA,ͬ\yz?td[UVHO⚎X h\H*(=|D:&*\=xf~Hv^mek iXi$^肦gAӿO]cAUybŬ6>dgCk%Qtp N!'J4\`vR^<EtHh!mgۍ 鹭/ib4z+8ȐJWꁳt:at_猴GA:tD?Zr?QP{~#'7GwOu;pϽigJx__kմ rN|o hKq )FPo,wXE+ \?.Nh%H?_dzJ6Ea>>mTK .3V b"Ÿ=x]HKI/ᾅ T ٜYͳw̿lf7+mz.~ B;CeEp 7J ΄/Z-VJ ,ŸD^5+(,4i3\,Pr9 gx'L8tPq٤ar[\-[MK-GSEjfŸc\R̰-Me %lv:|TVBaWc- ⃲lӱ]H% $Dk%Q㳨fBvd/[ EeT"sΝ;wڭctDqII3OHvk<׊[L',ѠR@57QM (.yvrב_#b9>6@oG7G{2~ U?:'TQ7a=VHNI \ת7ޗO?} JM ߾̝;wnߺEU`[Cdߕ>)N6?ѭ7y%?B_J 0F {z gia„VT`oO}+ ㊖E B [![Ro(*)rl^X:QxT۵9V o3C?{Ǝ#ogHqh=?-OE?2DUsݗUlqy.=V.%qH0Ĭ鱚[j+Ke%r,TNLKKKhΡ^ E0Y2N@d xakz}("$% Ԋ$Jq\6>IMPԟX,soE^-g+*ۂB/4+.z7xzeGb9Hu䭾)))E{z<@#`f[{n2UV4WW'/<WC8hZ|]ن/rdmGy2V"f+.|Q **܇H1 Ÿ2=u!/%L!؁k`1„VJp: Hi'Wo(&![RoLHaWl^L{au9nس6Vc02TIA.pj" 頌'e- i0%Z N؇|]+Rn.[6VK`9sIّi0 V>7\)9\yTʎ]qőiW I[!O+=}0Gga1DOXu]ډ E۝}CSX͔KINN gwTXy X [EDkہ@+]ByuY+ZcO?c~ܥTm/tu`ʃqv- BQ~W>wYW9x"^VRCCޘŸ =?#B_ DLפ*+*|4?32ZʱlU {z1wuW~ _@o()YRoLOWR0 ð薌3O[̌@ה#X3H!_v,M ys =?-O,#ٞ h/0JEf}{v*LGu-bVNG\Ro2TXQp{3g˹;,,J` ^6Ĭ ފ"\gn*ӊNI)0;?QZ ɢPAWb?d_oᏮm4$ x.brDdNE<íwv2\Sh¿~B:^d ԑz94Au zz?%{^:t\^~ɲUCj!zaK᪾[Bd #µ(SxXLkd9]%jڱNF}R |J"r[}z~Z @o8),Ztta-rxŸ3X FV_)nVlZzlHH*yuHJWH"7V?ɲmTJC彷!?j7gin[o}aqk5[ᆂVn3yIN?fչ +a^:|NeVZbшT N2Ǣ:_ӏGY;e.K1f ;-'.=tq?N ar!!RoY/Yy y,NzRh %Ɨİ /)kܨU R*4h=? OEH#Kr*+`V7;;/"xZ*x,ZkXN&R/ u׏<a+]ajjݢ+:,U}RXRUpG5ZIx̃VD_ޚhU]9MqmŢZjp/҅?Fq&P-!E!9Vߒ-J~/7]+yܷRS -Hr)*~;!UaFp]l8|=ܲ"s4|WM_p&AKAzzy5GJno&Ɨ,K$_1)a";WVz%Vku=s͍N%t))dihQhy †o Ny?I+c!pe50ZrQqgv qsf;G>L~je!Z+tPvbOpM{c6ֶ;qwr[TMjj?%kHב ߛNnm`y8:@Rl\[,]w#)m#{ab=tU̝h$ 8nMcy<V+K. iTFCܸͻǿQ ..V݌w#mCq:϶QZpO{2Uf%3lS~(:˩:!R՗CðVZ+I+v7c #5QKK{0$c1+?JNZ.Ui)_ul¹%IRDJ5e,t _{8RcoxN:li~WRCC@`2' =B>S  u/Y؉ݲt?fI # _&\2_O vlܳ4(齡lQHvbp +Z,ްFxw9|Y#t{IoMZB,F˕<'[XCti{^2Ы6b# \ӑj8nIaѭJPⱘ3Ls&⣶t9kQbR'CyX+Tda_?16%e *ؘW0K3.܏IjJUe칝*m*_^N=*(O|o2 E~L}+GX͖:vRUDXVi)SC?;ꎱpխN$3eʸYyFKGg,K b֖t&3q,FQh, tpgC0F Ck%I8}ۯF&h';tCF^`#{^|>7DNZ%'&Ac|yƀp:2_'1S7|/ ~ּu>˭܇h`o\D/-----QoFV{juiiiiiiү y|q–'L7*Op>>>C]џ}["Y{bNrݢ>ZF"V+In+=H=x!\%}C [^ZrBv^.Z  NfF/__#T)_VV?'e~#3 xV߹ :ux(Ǣ}JSg;:4442wie{o&FGy7rǯ¬^?644422et\aW71244488FJ*/C|F7Y͕7~1ނ*2Jo`µ70d_Q1n1jtNa T5ה5j gm6%߱edn8v˨Xזư{Ca٢zo\XBo ]P0SEWXC_0TGpeb#hrXڭRRw [Fmc]y "%yvh}γ[yET#vзf5zc}v'%Ix75Bm\[T,3r,zT^nvSUWh׵ipv#u:yE%z+TsqI]QIFFkwlrX$ M6Rvvny7ތQ%ҨD@{B@= _P6='Rqmc>[V a.*ԃH m#bضNly1+K4b 5A6fmZWsJ =Zǔzx$<,Wؑ b716Ǻwm[-A#jUե};to_ LG:mĂS??zr)p,ڭ_T\7̶F~gүKO !O'Ұ؋ vI[e:UӞroXWO'<3=/97Wˢ_Ho%z#le\go]BՁ.uI_x70۹v־h@Vn9PQ,ܬD!maޯ]Eլ& [QmC]/Vn=$MC. T?o΂y W罰:g赶nR=$u=0c-ܸpaBv5ݼu`ޚq9ai%FR Bb +V;r,z[^0Amq\]ӢɈYV#\עܲzօPI*+Y\fٲnL0[cL#)᏿01͞x~vJ\ZoUZ֭ZIL+N&cȟZl W8x J:pൗ[Rt{tI~Yrvwʽq#9pcg:Zq{1:xO=G,1y\Fju:]a~vC g]{3XFޮvYЎ*LR/>gڽg߁ޞ;\.i ]gqZɮ}}}}}}={f4 YZV9}/zIzzZ)==]Vϗ񺤌/%ٴ|kK΁Mo^ެ cjF%vfԪf)n]ޜCU7P-*ސyK6-_)6vS ֿ{E/K!TozGZrW3vܐ(\fҔ<3D~K|rzFjr։F,qCFj s7湓Zj5"k^r5ZXuӺDOm6iMζ fy$;ʌX롵(qvIiŚL YsDk{# ;s [!Y&RE-@(6,"/ ;s ;@imб@Awć.@Z/dT9^DX]Dk# TD-ݦd _y&ϋt%u7_[=8h4FCmY 2H3FvSt[.%%%%eu< }́.}́.}́.}́.}*t8t%tEXtdate:create2021-01-11T09:14:05+00:00PM%tEXtdate:modify2021-01-11T09:14:05+00:00 :(tEXticc:copyrightCopyright Apple Inc., 2018/LAtEXticc:descriptionDisplayIENDB`zerolog-1.26.1/sampler.go000066400000000000000000000061031415647605600152720ustar00rootroot00000000000000package zerolog import ( "math/rand" "sync/atomic" "time" ) 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) ) // 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 } // RandomSampler use a PRNG to randomly sample an event out of N events, // regardless of their level. type RandomSampler uint32 // Sample implements the Sampler interface. func (s RandomSampler) Sample(lvl Level) bool { if s <= 0 { return false } if rand.Intn(int(s)) != 0 { return false } return true } // BasicSampler is a sampler that will send every Nth events, regardless of // their level. type BasicSampler struct { N uint32 counter uint32 } // Sample implements the Sampler interface. func (s *BasicSampler) Sample(lvl Level) bool { n := s.N if n == 1 { return true } c := atomic.AddUint32(&s.counter, 1) return c%n == 1 } // 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 counter uint32 resetAt int64 } // Sample implements the Sampler interface. func (s *BurstSampler) Sample(lvl Level) bool { if s.Burst > 0 && s.Period > 0 { if s.inc() <= s.Burst { return true } } if s.NextSampler == nil { return false } return s.NextSampler.Sample(lvl) } func (s *BurstSampler) inc() uint32 { now := time.Now().UnixNano() resetAt := atomic.LoadInt64(&s.resetAt) var c uint32 if now > resetAt { c = 1 atomic.StoreUint32(&s.counter, c) newResetAt := now + s.Period.Nanoseconds() reset := atomic.CompareAndSwapInt64(&s.resetAt, resetAt, newResetAt) if !reset { // Lost the race with another goroutine trying to reset. c = atomic.AddUint32(&s.counter, 1) } } else { c = atomic.AddUint32(&s.counter, 1) } return c } // LevelSampler applies a different sampler for each level. type LevelSampler struct { TraceSampler, DebugSampler, InfoSampler, WarnSampler, ErrorSampler Sampler } func (s LevelSampler) Sample(lvl Level) bool { switch lvl { case TraceLevel: if s.TraceSampler != nil { return s.TraceSampler.Sample(lvl) } case DebugLevel: if s.DebugSampler != nil { return s.DebugSampler.Sample(lvl) } case InfoLevel: if s.InfoSampler != nil { return s.InfoSampler.Sample(lvl) } case WarnLevel: if s.WarnSampler != nil { return s.WarnSampler.Sample(lvl) } case ErrorLevel: if s.ErrorSampler != nil { return s.ErrorSampler.Sample(lvl) } } return true } zerolog-1.26.1/sampler_test.go000066400000000000000000000025711415647605600163360ustar00rootroot00000000000000// +build !binary_log package zerolog import ( "testing" "time" ) var samplers = []struct { name string sampler func() Sampler total int wantMin int wantMax int }{ { "BasicSampler_1", func() Sampler { return &BasicSampler{N: 1} }, 100, 100, 100, }, { "BasicSampler_5", func() Sampler { return &BasicSampler{N: 5} }, 100, 20, 20, }, { "RandomSampler", func() Sampler { return RandomSampler(5) }, 100, 10, 30, }, { "BurstSampler", func() Sampler { return &BurstSampler{Burst: 20, Period: time.Second} }, 100, 20, 20, }, { "BurstSamplerNext", func() Sampler { return &BurstSampler{Burst: 20, Period: time.Second, NextSampler: &BasicSampler{N: 5}} }, 120, 40, 40, }, } func TestSamplers(t *testing.T) { for i := range samplers { s := samplers[i] t.Run(s.name, func(t *testing.T) { sampler := s.sampler() got := 0 for t := s.total; t > 0; t-- { if sampler.Sample(0) { got++ } } if got < s.wantMin || got > s.wantMax { t.Errorf("%s.Sample(0) == true %d on %d, want [%d, %d]", s.name, got, s.total, s.wantMin, s.wantMax) } }) } } func BenchmarkSamplers(b *testing.B) { for i := range samplers { s := samplers[i] b.Run(s.name, func(b *testing.B) { sampler := s.sampler() b.RunParallel(func(pb *testing.PB) { for pb.Next() { sampler.Sample(0) } }) }) } } zerolog-1.26.1/syslog.go000066400000000000000000000037031415647605600151520ustar00rootroot00000000000000// +build !windows // +build !binary_log package zerolog import ( "io" ) // See http://cee.mitre.org/language/1.0-beta1/clt.html#syslog // or https://www.rsyslog.com/json-elasticsearch/ const ceePrefix = "@cee:" // 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 } type syslogWriter struct { w SyslogWriter prefix string } // SyslogLevelWriter wraps a SyslogWriter and call the right syslog level // method matching the zerolog level. func SyslogLevelWriter(w SyslogWriter) LevelWriter { return syslogWriter{w, ""} } // 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 SyslogCEEWriter(w SyslogWriter) LevelWriter { return syslogWriter{w, ceePrefix} } func (sw syslogWriter) Write(p []byte) (n int, err error) { var pn int if sw.prefix != "" { pn, err = sw.w.Write([]byte(sw.prefix)) if err != nil { return pn, err } } n, err = sw.w.Write(p) return pn + n, err } // WriteLevel implements LevelWriter interface. func (sw syslogWriter) WriteLevel(level Level, p []byte) (n int, err error) { switch level { case TraceLevel: case DebugLevel: err = sw.w.Debug(sw.prefix + string(p)) case InfoLevel: err = sw.w.Info(sw.prefix + string(p)) case WarnLevel: err = sw.w.Warning(sw.prefix + string(p)) case ErrorLevel: err = sw.w.Err(sw.prefix + string(p)) case FatalLevel: err = sw.w.Emerg(sw.prefix + string(p)) case PanicLevel: err = sw.w.Crit(sw.prefix + string(p)) case NoLevel: err = sw.w.Info(sw.prefix + string(p)) default: panic("invalid level") } // Any CEE prefix is not part of the message, so we don't include its length n = len(p) return } zerolog-1.26.1/syslog_test.go000066400000000000000000000052701415647605600162120ustar00rootroot00000000000000// +build !binary_log // +build !windows package zerolog import ( "bytes" "reflect" "strings" "testing" ) type syslogEvent struct { level string msg string } type syslogTestWriter struct { events []syslogEvent } func (w *syslogTestWriter) Write(p []byte) (int, error) { return 0, nil } func (w *syslogTestWriter) Trace(m string) error { w.events = append(w.events, syslogEvent{"Trace", m}) return nil } func (w *syslogTestWriter) Debug(m string) error { w.events = append(w.events, syslogEvent{"Debug", m}) return nil } func (w *syslogTestWriter) Info(m string) error { w.events = append(w.events, syslogEvent{"Info", m}) return nil } func (w *syslogTestWriter) Warning(m string) error { w.events = append(w.events, syslogEvent{"Warning", m}) return nil } func (w *syslogTestWriter) Err(m string) error { w.events = append(w.events, syslogEvent{"Err", m}) return nil } func (w *syslogTestWriter) Emerg(m string) error { w.events = append(w.events, syslogEvent{"Emerg", m}) return nil } func (w *syslogTestWriter) Crit(m string) error { w.events = append(w.events, syslogEvent{"Crit", m}) return nil } func TestSyslogWriter(t *testing.T) { sw := &syslogTestWriter{} log := New(SyslogLevelWriter(sw)) log.Trace().Msg("trace") log.Debug().Msg("debug") log.Info().Msg("info") log.Warn().Msg("warn") log.Error().Msg("error") log.Log().Msg("nolevel") want := []syslogEvent{ {"Debug", `{"level":"debug","message":"debug"}` + "\n"}, {"Info", `{"level":"info","message":"info"}` + "\n"}, {"Warning", `{"level":"warn","message":"warn"}` + "\n"}, {"Err", `{"level":"error","message":"error"}` + "\n"}, {"Info", `{"message":"nolevel"}` + "\n"}, } if got := sw.events; !reflect.DeepEqual(got, want) { t.Errorf("Invalid syslog message routing: want %v, got %v", want, got) } } type testCEEwriter struct { buf *bytes.Buffer } // Only implement one method as we're just testing the prefixing func (c testCEEwriter) Debug(m string) error { return nil } func (c testCEEwriter) Info(m string) error { _, err := c.buf.Write([]byte(m)) return err } func (c testCEEwriter) Warning(m string) error { return nil } func (c testCEEwriter) Err(m string) error { return nil } func (c testCEEwriter) Emerg(m string) error { return nil } func (c testCEEwriter) Crit(m string) error { return nil } func (c testCEEwriter) Write(b []byte) (int, error) { return c.buf.Write(b) } func TestSyslogWriter_WithCEE(t *testing.T) { var buf bytes.Buffer sw := testCEEwriter{&buf} log := New(SyslogCEEWriter(sw)) log.Info().Str("key", "value").Msg("message string") got := string(buf.Bytes()) want := "@cee:{" if !strings.HasPrefix(got, want) { t.Errorf("Bad CEE message start: want %v, got %v", want, got) } } zerolog-1.26.1/writer.go000066400000000000000000000073731415647605600151550ustar00rootroot00000000000000package zerolog import ( "bytes" "io" "path" "runtime" "strconv" "strings" "sync" ) // 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) } type levelWriterAdapter struct { io.Writer } func (lw levelWriterAdapter) WriteLevel(l Level, p []byte) (n int, err error) { return lw.Write(p) } type syncWriter struct { mu sync.Mutex lw LevelWriter } // 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. func SyncWriter(w io.Writer) io.Writer { if lw, ok := w.(LevelWriter); ok { return &syncWriter{lw: lw} } return &syncWriter{lw: levelWriterAdapter{w}} } // Write implements the io.Writer interface. func (s *syncWriter) Write(p []byte) (n int, err error) { s.mu.Lock() defer s.mu.Unlock() return s.lw.Write(p) } // WriteLevel implements the LevelWriter interface. func (s *syncWriter) WriteLevel(l Level, p []byte) (n int, err error) { s.mu.Lock() defer s.mu.Unlock() return s.lw.WriteLevel(l, p) } type multiLevelWriter struct { writers []LevelWriter } func (t multiLevelWriter) Write(p []byte) (n int, err error) { for _, w := range t.writers { if _n, _err := w.Write(p); err == nil { n = _n if _err != nil { err = _err } else if _n != len(p) { err = io.ErrShortWrite } } } return n, err } func (t multiLevelWriter) WriteLevel(l Level, p []byte) (n int, err error) { for _, w := range t.writers { if _n, _err := w.WriteLevel(l, p); err == nil { n = _n if _err != nil { err = _err } else if _n != len(p) { err = io.ErrShortWrite } } } return n, err } // 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 MultiLevelWriter(writers ...io.Writer) LevelWriter { lwriters := make([]LevelWriter, 0, len(writers)) for _, w := range writers { if lw, ok := w.(LevelWriter); ok { lwriters = append(lwriters, lw) } else { lwriters = append(lwriters, levelWriterAdapter{w}) } } return multiLevelWriter{lwriters} } // TestingLog is the logging interface of testing.TB. type TestingLog interface { Log(args ...interface{}) Logf(format string, args ...interface{}) Helper() } // 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 } // NewTestWriter creates a writer that logs to the testing.TB. func NewTestWriter(t TestingLog) TestWriter { return TestWriter{T: t} } // Write to testing.TB. func (t TestWriter) Write(p []byte) (n int, err error) { t.T.Helper() n = len(p) // Strip trailing newline because t.Log always adds one. p = bytes.TrimRight(p, "\n") // Try to correct the log file and line number to the caller. if t.Frame > 0 { _, origFile, origLine, _ := runtime.Caller(1) _, frameFile, frameLine, ok := runtime.Caller(1 + t.Frame) if ok { erase := strings.Repeat("\b", len(path.Base(origFile))+len(strconv.Itoa(origLine))+3) t.T.Logf("%s%s:%d: %s", erase, path.Base(frameFile), frameLine, p) return n, err } } t.T.Log(string(p)) return n, err } // ConsoleTestWriter creates an option that correctly sets the file frame depth for testing.TB log. func ConsoleTestWriter(t TestingLog) func(w *ConsoleWriter) { return func(w *ConsoleWriter) { w.Out = TestWriter{T: t, Frame: 6} } } zerolog-1.26.1/writer_test.go000066400000000000000000000067031415647605600162100ustar00rootroot00000000000000//go:build !binary_log && !windows // +build !binary_log,!windows package zerolog import ( "bytes" "errors" "fmt" "io" "reflect" "testing" ) func TestMultiSyslogWriter(t *testing.T) { sw := &syslogTestWriter{} log := New(MultiLevelWriter(SyslogLevelWriter(sw))) log.Debug().Msg("debug") log.Info().Msg("info") log.Warn().Msg("warn") log.Error().Msg("error") log.Log().Msg("nolevel") want := []syslogEvent{ {"Debug", `{"level":"debug","message":"debug"}` + "\n"}, {"Info", `{"level":"info","message":"info"}` + "\n"}, {"Warning", `{"level":"warn","message":"warn"}` + "\n"}, {"Err", `{"level":"error","message":"error"}` + "\n"}, {"Info", `{"message":"nolevel"}` + "\n"}, } if got := sw.events; !reflect.DeepEqual(got, want) { t.Errorf("Invalid syslog message routing: want %v, got %v", want, got) } } var writeCalls int type mockedWriter struct { wantErr bool } func (c mockedWriter) Write(p []byte) (int, error) { writeCalls++ if c.wantErr { return -1, errors.New("Expected error") } return len(p), nil } // Tests that a new writer is only used if it actually works. func TestResilientMultiWriter(t *testing.T) { tests := []struct { name string writers []io.Writer }{ { name: "All valid writers", writers: []io.Writer{ mockedWriter{ wantErr: false, }, mockedWriter{ wantErr: false, }, }, }, { name: "All invalid writers", writers: []io.Writer{ mockedWriter{ wantErr: true, }, mockedWriter{ wantErr: true, }, }, }, { name: "First invalid writer", writers: []io.Writer{ mockedWriter{ wantErr: true, }, mockedWriter{ wantErr: false, }, }, }, { name: "First valid writer", writers: []io.Writer{ mockedWriter{ wantErr: false, }, mockedWriter{ wantErr: true, }, }, }, } for _, tt := range tests { writers := tt.writers multiWriter := MultiLevelWriter(writers...) logger := New(multiWriter).With().Timestamp().Logger().Level(InfoLevel) logger.Info().Msg("Test msg") if len(writers) != writeCalls { t.Errorf("Expected %d writers to have been called but only %d were.", len(writers), writeCalls) } writeCalls = 0 } } type testingLog struct { testing.TB buf bytes.Buffer } func (t *testingLog) Log(args ...interface{}) { if _, err := t.buf.WriteString(fmt.Sprint(args...)); err != nil { t.Error(err) } } func (t *testingLog) Logf(format string, args ...interface{}) { if _, err := t.buf.WriteString(fmt.Sprintf(format, args...)); err != nil { t.Error(err) } } func TestTestWriter(t *testing.T) { tests := []struct { name string write []byte want []byte }{{ name: "newline", write: []byte("newline\n"), want: []byte("newline"), }, { name: "oneline", write: []byte("oneline"), want: []byte("oneline"), }, { name: "twoline", write: []byte("twoline\n\n"), want: []byte("twoline"), }} for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { tb := &testingLog{TB: t} // Capture TB log buffer. w := TestWriter{T: tb} n, err := w.Write(tt.write) if err != nil { t.Error(err) } if n != len(tt.write) { t.Errorf("Expected %d write length but got %d", len(tt.write), n) } p := tb.buf.Bytes() if !bytes.Equal(tt.want, p) { t.Errorf("Expected %q, got %q.", tt.want, p) } log := New(NewConsoleWriter(ConsoleTestWriter(t))) log.Info().Str("name", tt.name).Msg("Success!") tb.buf.Reset() }) } }