├── .github └── workflows │ ├── lint.yaml │ └── test.yaml ├── LICENSE ├── README.md ├── example └── example_test.go ├── go.mod ├── go.sum └── zerologr.go /.github/workflows/lint.yaml: -------------------------------------------------------------------------------- 1 | name: lint 2 | on: [ push, pull_request ] 3 | jobs: 4 | lint: 5 | runs-on: ubuntu-latest 6 | steps: 7 | - uses: actions/checkout@v2 8 | - uses: actions/setup-go@v2 9 | with: 10 | go-version: "^1.19" 11 | - uses: golangci/golangci-lint-action@v2 12 | with: 13 | version: latest 14 | skip-go-installation: true 15 | args: 16 | -v 17 | --max-same-issues 10 18 | --disable-all 19 | --exclude-use-default=false 20 | -E asciicheck 21 | -E deadcode 22 | -E errcheck 23 | -E forcetypeassert 24 | -E gocritic 25 | -E gofmt 26 | -E goimports 27 | -E gosimple 28 | -E govet 29 | -E ineffassign 30 | -E misspell 31 | -E revive 32 | -E staticcheck 33 | -E structcheck 34 | -E typecheck 35 | -E unused 36 | -E varcheck 37 | -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: test 2 | on: [ push, pull_request ] 3 | jobs: 4 | test: 5 | runs-on: ubuntu-latest 6 | steps: 7 | - uses: actions/checkout@v2 8 | - uses: actions/setup-go@v2 9 | with: 10 | go-version: "^1.19" 11 | - run: go test ./... 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Zerologr 2 | 3 | [![Go Reference](https://pkg.go.dev/badge/github.com/go-logr/zerologr.svg)](https://pkg.go.dev/github.com/go-logr/zerologr) 4 | ![test](https://github.com/go-logr/zerologr/workflows/test/badge.svg) 5 | [![Go Report Card](https://goreportcard.com/badge/github.com/go-logr/zerologr)](https://goreportcard.com/report/github.com/go-logr/zerologr) 6 | 7 | A [logr](https://github.com/go-logr/logr) LogSink implementation using [Zerolog](https://github.com/rs/zerolog). 8 | 9 | ## Usage 10 | 11 | ```go 12 | import ( 13 | "os" 14 | 15 | "github.com/go-logr/logr" 16 | "github.com/go-logr/zerologr" 17 | "github.com/rs/zerolog" 18 | ) 19 | 20 | func main() { 21 | zerolog.TimeFieldFormat = zerolog.TimeFormatUnixMs 22 | 23 | zerologr.NameFieldName = "logger" 24 | zerologr.NameSeparator = "/" 25 | zerologr.SetMaxV(1) 26 | 27 | zl := zerolog.New(os.Stderr) 28 | zl = zl.With().Caller().Timestamp().Logger() 29 | var log logr.Logger = zerologr.New(&zl) 30 | 31 | log.Info("Logr in action!", "the answer", 42) 32 | } 33 | ``` 34 | 35 | ## Implementation Details 36 | 37 | For the most part, concepts in Zerolog correspond directly with those in logr. 38 | 39 | 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(). 40 | -------------------------------------------------------------------------------- /example/example_test.go: -------------------------------------------------------------------------------- 1 | //go:build !binary_log 2 | // +build !binary_log 3 | 4 | /* 5 | Copyright 2021 The logr Authors. 6 | 7 | Licensed under the Apache License, Version 2.0 (the "License"); 8 | you may not use this file except in compliance with the License. 9 | You may obtain a copy of the License at 10 | 11 | http://www.apache.org/licenses/LICENSE-2.0 12 | 13 | Unless required by applicable law or agreed to in writing, software 14 | distributed under the License is distributed on an "AS IS" BASIS, 15 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | See the License for the specific language governing permissions and 17 | limitations under the License. 18 | */ 19 | 20 | package zerologr_test 21 | 22 | import ( 23 | "os" 24 | 25 | "github.com/go-logr/logr" 26 | "github.com/go-logr/zerologr" 27 | "github.com/rs/zerolog" 28 | ) 29 | 30 | type E struct { 31 | str string 32 | } 33 | 34 | func (e E) Error() string { 35 | return e.str 36 | } 37 | 38 | func Helper(log logr.Logger, msg string) { 39 | helper2(log, msg) 40 | } 41 | 42 | func helper2(log logr.Logger, msg string) { 43 | log.WithCallDepth(2).Info(msg) 44 | } 45 | 46 | func ExampleNew() { 47 | zerologr.SetMaxV(1) 48 | zl := zerolog.New(os.Stdout) 49 | log := zerologr.New(&zl) 50 | log = log.WithName("MyName") 51 | log = log.WithValues("module", "example") 52 | 53 | log.Info("hello", "val1", 1, "val2", map[string]int{"k": 1}) 54 | log.V(1).Info("you should see this") 55 | log.V(1).V(1).Info("you should NOT see this") 56 | log.Error(nil, "uh oh", "trouble", true, "reasons", []float64{0.1, 0.11, 3.14}) 57 | log.Error(E{"an error occurred"}, "goodbye", "code", -1) 58 | Helper(log, "thru a helper") 59 | 60 | // Output: 61 | // {"level":"info","module":"example","v":0,"logger":"MyName","val1":1,"val2":{"k":1},"message":"hello"} 62 | // {"level":"debug","module":"example","v":1,"logger":"MyName","message":"you should see this"} 63 | // {"level":"error","module":"example","logger":"MyName","trouble":true,"reasons":[0.1,0.11,3.14],"message":"uh oh"} 64 | // {"level":"error","module":"example","error":"an error occurred","logger":"MyName","code":-1,"message":"goodbye"} 65 | // {"level":"info","module":"example","v":0,"logger":"MyName","message":"thru a helper"} 66 | } 67 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/go-logr/zerologr 2 | 3 | go 1.17 4 | 5 | require ( 6 | github.com/go-logr/logr v1.2.3 7 | github.com/rs/zerolog v1.29.0 8 | ) 9 | 10 | require ( 11 | github.com/mattn/go-colorable v0.1.12 // indirect 12 | github.com/mattn/go-isatty v0.0.14 // indirect 13 | golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 // indirect 14 | ) 15 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= 2 | github.com/go-logr/logr v1.2.3 h1:2DntVwHkVopvECVRSlL5PSo9eG+cAkDCuckLubN+rq0= 3 | github.com/go-logr/logr v1.2.3/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= 4 | github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= 5 | github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40= 6 | github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= 7 | github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y= 8 | github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= 9 | github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= 10 | github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= 11 | github.com/rs/zerolog v1.29.0 h1:Zes4hju04hjbvkVkOhdl2HpZa+0PmVwigmo8XoORE5w= 12 | github.com/rs/zerolog v1.29.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0= 13 | golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 14 | golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6 h1:foEbQz/B0Oz6YIqu/69kfXPYeFQAuuMYFkjaqXzl5Wo= 15 | golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= 16 | -------------------------------------------------------------------------------- /zerologr.go: -------------------------------------------------------------------------------- 1 | // Package zerologr defines an implementation of the github.com/go-logr/logr 2 | // interfaces built on top of Zerolog (https://github.com/rs/zerolog). 3 | // 4 | // # Usage 5 | // 6 | // A new logr.Logger can be constructed from an existing zerolog.Logger using 7 | // the New function: 8 | // 9 | // log := zerologr.New(someZeroLogger) 10 | // 11 | // # Implementation Details 12 | // 13 | // For the most part, concepts in Zerolog correspond directly with those in 14 | // logr. 15 | // 16 | // V-levels in logr correspond to levels in Zerolog as `zerologLevel = 1 - logrV`. 17 | // `logr.V(0)` is equivalent to `zerolog.InfoLevel` or 1; `logr.V(1)` is equivalent to 18 | // `zerolog.DebugLevel` or 0 (default global level in Zerolog); `logr.V(2)` is equivalent 19 | // to `zerolog.TraceLevel` or -1. Higher than 2 V-level is possible but misses some 20 | // features in Zerolog, e.g. Hooks and Sampling. V-level value is a number and is only 21 | // logged on Info(), not Error(). 22 | package zerologr 23 | 24 | import ( 25 | "fmt" 26 | 27 | "github.com/go-logr/logr" 28 | "github.com/rs/zerolog" 29 | ) 30 | 31 | var ( 32 | // NameFieldName is the field key for logr.WithName. 33 | NameFieldName = "logger" 34 | // NameSeparator separates names for logr.WithName. 35 | NameSeparator = "/" 36 | // VerbosityFieldName is the field key for logr.Info verbosity. If set to "", 37 | // its value is not emitted. 38 | VerbosityFieldName = "v" 39 | 40 | // RenderArgsHook mutates the list of key-value pairs passed directly to 41 | // logr.Info and logr.Error. If set to nil, it is disabled. 42 | RenderArgsHook = DefaultRender 43 | // RenderValuesHook mutates the list of key-value pairs saved via logr.WithValues. 44 | // If set to nil, it is disabled. 45 | RenderValuesHook = DefaultRender 46 | ) 47 | 48 | const ( 49 | minZerologLevel = -128 // zerolog.Level is int8 50 | ) 51 | 52 | // Logger is type alias of logr.Logger. 53 | type Logger = logr.Logger 54 | 55 | // LogSink implements logr.LogSink and logr.CallDepthLogSink. 56 | type LogSink struct { 57 | l *zerolog.Logger 58 | name string 59 | depth int 60 | } 61 | 62 | // Underlier exposes access to the underlying logging implementation. Since 63 | // callers only have a logr.Logger, they have to know which implementation is 64 | // in use, so this interface is less of an abstraction and more of way to test 65 | // type conversion. 66 | type Underlier interface { 67 | GetUnderlying() *zerolog.Logger 68 | } 69 | 70 | var ( 71 | _ logr.LogSink = &LogSink{} 72 | _ logr.CallDepthLogSink = &LogSink{} 73 | ) 74 | 75 | // New returns a logr.Logger with logr.LogSink implemented by Zerolog. Local level 76 | // is mutated to allow max V-level if not set explicitly, so SetMaxV alone can control 77 | // Zerolog's level. Use NewLogSink directly if local level mutation is undesirable. 78 | func New(l *zerolog.Logger) Logger { 79 | if l.GetLevel() == zerolog.TraceLevel { 80 | ll := l.Level(minZerologLevel) 81 | l = &ll 82 | } 83 | ls := NewLogSink(l) 84 | return logr.New(ls) 85 | } 86 | 87 | // NewLogSink returns a logr.LogSink implemented by Zerolog. 88 | func NewLogSink(l *zerolog.Logger) *LogSink { 89 | return &LogSink{l: l} 90 | } 91 | 92 | // SetMaxV updates Zerolog's global level. Default max V-level is 1 (DebugLevel). 93 | // The range of max V-level is 0 through 129 inclusive, but higher than 2 V-level 94 | // misses some features in Zerolog, e.g. Hooks and Sampling. 95 | func SetMaxV(level int) { 96 | if level < 0 { 97 | level = 0 98 | } 99 | zlvl := 1 - level 100 | if zlvl < minZerologLevel { 101 | zlvl = minZerologLevel 102 | } 103 | zerolog.SetGlobalLevel(zerolog.Level(zlvl)) 104 | } 105 | 106 | // Init receives runtime info about the logr library. 107 | func (ls *LogSink) Init(ri logr.RuntimeInfo) { 108 | ls.depth = ri.CallDepth + 2 109 | } 110 | 111 | // Enabled tests whether this LogSink is enabled at the specified V-level. 112 | func (ls *LogSink) Enabled(level int) bool { 113 | zlvl := zerolog.Level(1 - level) 114 | return zlvl >= ls.l.GetLevel() && zlvl >= zerolog.GlobalLevel() 115 | } 116 | 117 | // Info logs a non-error message at specified V-level with the given key/value pairs as context. 118 | func (ls *LogSink) Info(level int, msg string, keysAndValues ...interface{}) { 119 | e := ls.l.WithLevel(zerolog.Level(1 - level)) 120 | if VerbosityFieldName != "" { 121 | e.Int(VerbosityFieldName, level) 122 | } 123 | ls.msg(e, msg, keysAndValues) 124 | } 125 | 126 | // Error logs an error, with the given message and key/value pairs as context. 127 | func (ls *LogSink) Error(err error, msg string, keysAndValues ...interface{}) { 128 | e := ls.l.Error().Err(err) 129 | ls.msg(e, msg, keysAndValues) 130 | } 131 | 132 | func (ls *LogSink) msg(e *zerolog.Event, msg string, keysAndValues []interface{}) { 133 | if e == nil { 134 | return 135 | } 136 | if ls.name != "" { 137 | e.Str(NameFieldName, ls.name) 138 | } 139 | if RenderArgsHook != nil { 140 | keysAndValues = RenderArgsHook(keysAndValues) 141 | } 142 | e = e.Fields(keysAndValues) 143 | e.CallerSkipFrame(ls.depth) 144 | e.Msg(msg) 145 | } 146 | 147 | // WithValues returns a new LogSink with additional key/value pairs. 148 | func (ls LogSink) WithValues(keysAndValues ...interface{}) logr.LogSink { 149 | if RenderValuesHook != nil { 150 | keysAndValues = RenderValuesHook(keysAndValues) 151 | } 152 | l := ls.l.With().Fields(keysAndValues).Logger() 153 | ls.l = &l 154 | return &ls 155 | } 156 | 157 | // WithName returns a new LogSink with the specified name appended in NameFieldName. 158 | // Name elements are separated by NameSeparator. 159 | func (ls LogSink) WithName(name string) logr.LogSink { 160 | if ls.name != "" { 161 | ls.name += NameSeparator + name 162 | } else { 163 | ls.name = name 164 | } 165 | return &ls 166 | } 167 | 168 | // WithCallDepth returns a new LogSink that offsets the call stack by adding specified depths. 169 | func (ls LogSink) WithCallDepth(depth int) logr.LogSink { 170 | ls.depth += depth 171 | return &ls 172 | } 173 | 174 | // GetUnderlying returns the zerolog.Logger underneath this logSink. 175 | func (ls *LogSink) GetUnderlying() *zerolog.Logger { 176 | return ls.l 177 | } 178 | 179 | // DefaultRender supports logr.Marshaler and fmt.Stringer. 180 | func DefaultRender(keysAndValues []interface{}) []interface{} { 181 | for i, n := 1, len(keysAndValues); i < n; i += 2 { 182 | value := keysAndValues[i] 183 | switch v := value.(type) { 184 | case logr.Marshaler: 185 | keysAndValues[i] = v.MarshalLog() 186 | case fmt.Stringer: 187 | keysAndValues[i] = v.String() 188 | } 189 | } 190 | return keysAndValues 191 | } 192 | --------------------------------------------------------------------------------