README.md

zerologlint

zerologlint is a linter for zerolog that can be run with go vet or through golangci-lint since v1.53.0. It detects the wrong usage of zerolog that a user forgets to dispatch zerolog.Event with Send or Msg like functions, in which case nothing will be logged. For more detailed explanations of the cases it detects, see Examples.

Install

go install github.com/ykadowak/zerologlint/cmd/zerologlint@latest

Usage

go vet -vettool=`which zerologlint` ./...

or you can also use it with golangci-lint since v1.53.0.

Examples

package main

import (
    "github.com/rs/zerolog"
    "github.com/rs/zerolog/log"
)

func main() {
    // 1. Basic case
    log.Info() // "must be dispatched by Msg or Send method"

    // 2. Nested case
    log.Info(). // "must be dispatched by Msg or Send method"
        Str("foo", "bar").
        Dict("dict", zerolog.Dict().
            Str("bar", "baz").
            Int("n", 1),
        )

    // 3. Reassignment case
    logger := log.Info() // "must be dispatched by Msg or Send method"
    if err != nil {
        logger = log.Error() // "must be dispatched by Msg or Send method"
    }
    logger.Str("foo", "bar")

    // 4. Deferred case
    defer log.Info() // "must be dispatched by Msg or Send method"

    // 5. zerolog.Logger case
    logger2 := zerolog.New(os.Stdout)
    logger2.Info().Send()

    // 6. Dispatch in other function case
    event := log.Info()
    dispatcher(event)
}

func dispatcher(e *zerolog.Event) {
    e.Send()
}