Fixed Enabled() for lazy evaluation and supporting >2 V-level (#25)

Add SetMaxV to reduce level-mapping confusion

Author: hn8

.github/workflows/lint.yaml

@@ -7,7 +7,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: "^1.17"
+          go-version: "^1.19"
       - uses: golangci/golangci-lint-action@v2
         with:
           version: latest

.github/workflows/test.yaml

@@ -7,5 +7,5 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: "^1.17"
+          go-version: "^1.19"
       - run: go test ./...

README.md

@@ -19,8 +19,10 @@ import (
 
 func main() {
     zerolog.TimeFieldFormat = zerolog.TimeFormatUnixMs
+
     zerologr.NameFieldName = "logger"
     zerologr.NameSeparator = "/"
+    zerologr.SetMaxV(1)
 
     zl := zerolog.New(os.Stderr)
     zl = zl.With().Caller().Timestamp().Logger()
@@ -34,8 +36,4 @@ func main() {
 
 For the most part, concepts in Zerolog correspond directly with those in logr.
 
-Levels in logr correspond to custom debug levels in Zerolog. Any given level
-in logr is represents by `zerologLevel = 1 - logrLevel`.
-
-For example `V(2)` is equivalent to Zerolog's `TraceLevel`, while `V(1)` is
-equivalent to Zerolog's `DebugLevel`.
+V-levels in logr correspond to levels in Zerolog as `zerologLevel = 1 - logrV`. `logr.V(0)` is equivalent to `zerolog.InfoLevel` or 1; `logr.V(1)` is equivalent to `zerolog.DebugLevel` or 0 (default global level in Zerolog); `logr.V(2)` is equivalent to `zerolog.TraceLevel` or -1. Higher than 2 V-level is possible but misses some features in Zerolog, e.g. Hooks and Sampling. V-level value is a number and is only logged on Info(), not Error().

example/example_test.go

@@ -44,7 +44,7 @@ func helper2(log logr.Logger, msg string) {
 }
 
 func ExampleNew() {
-	zerolog.SetGlobalLevel(zerolog.DebugLevel)
+	zerologr.SetMaxV(1)
 	zl := zerolog.New(os.Stdout)
 	log := zerologr.New(&zl)
 	log = log.WithName("MyName")

go.mod

@@ -3,6 +3,12 @@ module github.com/go-logr/zerologr
 go 1.17
 
 require (
-	github.com/go-logr/logr v1.2.2
-	github.com/rs/zerolog v1.26.1
+	github.com/go-logr/logr v1.2.3
+	github.com/rs/zerolog v1.29.0
+)
+
+require (
+	github.com/mattn/go-colorable v0.1.12 // indirect
+	github.com/mattn/go-isatty v0.0.14 // indirect
+	golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 // indirect
 )

go.sum

@@ -1,34 +1,15 @@
-github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
-github.com/go-logr/logr v1.2.2 h1:ahHml/yUpnlb96Rp8HCvtYVPY8ZYpxq3g7UYchIYwbs=
-github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
+github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
+github.com/go-logr/logr v1.2.3 h1:2DntVwHkVopvECVRSlL5PSo9eG+cAkDCuckLubN+rq0=
+github.com/go-logr/logr v1.2.3/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
+github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
+github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
+github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
+github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
-github.com/rs/xid v1.3.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.26.1 h1:/ihwxqH+4z8UxyI70wM1z9yCvkWcfz/a3mj48k/Zngc=
-github.com/rs/zerolog v1.26.1/go.mod h1:/wSSJWX7lVrsOwlbyTRSOJvqRlc+WjWlfes+CiJ+tmc=
-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/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/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/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/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
+github.com/rs/zerolog v1.29.0 h1:Zes4hju04hjbvkVkOhdl2HpZa+0PmVwigmo8XoORE5w=
+github.com/rs/zerolog v1.29.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0=
+golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 h1:foEbQz/B0Oz6YIqu/69kfXPYeFQAuuMYFkjaqXzl5Wo=
+golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

zerologr.go

@@ -1,22 +1,23 @@
 // Package zerologr defines an implementation of the github.com/go-logr/logr
 // interfaces built on top of Zerolog (https://github.com/rs/zerolog).
 //
-// Usage
+// # Usage
 //
 // A new logr.Logger can be constructed from an existing zerolog.Logger using
 // the New function:
 //
-//  log := zerologr.New(someZeroLogger)
+//	log := zerologr.New(someZeroLogger)
 //
-// Implementation Details
+// # Implementation Details
 //
 // For the most part, concepts in Zerolog correspond directly with those in
 // logr.
 //
-// Levels in logr correspond to custom debug levels in Zerolog.  Any given level
-// in logr is represents by `zerologLevel = 1 - logrLevel`.
-// For example V(2) is equivalent to Zerolog's TraceLevel, while V(1) is
-// equivalent to Zerolog's DebugLevel.  Verbosity value is a number and is only
+// V-levels in logr correspond to levels in Zerolog as `zerologLevel = 1 - logrV`.
+// `logr.V(0)` is equivalent to `zerolog.InfoLevel` or 1; `logr.V(1)` is equivalent to
+// `zerolog.DebugLevel` or 0 (default global level in Zerolog); `logr.V(2)` is equivalent
+// to `zerolog.TraceLevel` or -1. Higher than 2 V-level is possible but misses some
+// features in Zerolog, e.g. Hooks and Sampling. V-level value is a number and is only
 // logged on Info(), not Error().
 package zerologr
 
@@ -37,12 +38,17 @@ var (
 	VerbosityFieldName = "v"
 
 	// RenderArgsHook mutates the list of key-value pairs passed directly to
-	// logr.Info and logr.Error.
+	// logr.Info and logr.Error. If set to nil, it is disabled.
 	RenderArgsHook = DefaultRender
 	// RenderValuesHook mutates the list of key-value pairs saved via logr.WithValues.
+	// If set to nil, it is disabled.
 	RenderValuesHook = DefaultRender
 )
 
+const (
+	minZerologLevel = -128 // zerolog.Level is int8
+)
+
 // Logger is type alias of logr.Logger.
 type Logger = logr.Logger
 
@@ -66,8 +72,14 @@ var (
 	_ logr.CallDepthLogSink = &LogSink{}
 )
 
-// New returns a logr.Logger with logr.LogSink implemented by Zerolog.
+// New returns a logr.Logger with logr.LogSink implemented by Zerolog. Local level
+// is mutated to allow max V-level if not set explicitly, so SetMaxV alone can control
+// Zerolog's level. Use NewLogSink directly if local level mutation is undesirable.
 func New(l *zerolog.Logger) Logger {
+	if l.GetLevel() == zerolog.TraceLevel {
+		ll := l.Level(minZerologLevel)
+		l = &ll
+	}
 	ls := NewLogSink(l)
 	return logr.New(ls)
 }
@@ -77,16 +89,29 @@ func NewLogSink(l *zerolog.Logger) *LogSink {
 	return &LogSink{l: l}
 }
 
+// SetMaxV updates Zerolog's global level. Default max V-level is 1 (DebugLevel).
+// The range of max V-level is 0 through 129 inclusive, but higher than 2 V-level
+// misses some features in Zerolog, e.g. Hooks and Sampling.
+func SetMaxV(level int) {
+	if level < 0 {
+		level = 0
+	}
+	zlvl := 1 - level
+	if zlvl < minZerologLevel {
+		zlvl = minZerologLevel
+	}
+	zerolog.SetGlobalLevel(zerolog.Level(zlvl))
+}
+
 // Init receives runtime info about the logr library.
 func (ls *LogSink) Init(ri logr.RuntimeInfo) {
 	ls.depth = ri.CallDepth + 2
 }
 
 // Enabled tests whether this LogSink is enabled at the specified V-level.
 func (ls *LogSink) Enabled(level int) bool {
-	// Optimization: Info() will check level internally.
-	const traceLevel = 1 - int(zerolog.TraceLevel)
-	return level <= traceLevel
+	zlvl := zerolog.Level(1 - level)
+	return zlvl >= ls.l.GetLevel() && zlvl >= zerolog.GlobalLevel()
 }
 
 // Info logs a non-error message at specified V-level with the given key/value pairs as context.