pax_global_header00006660000000000000000000000064143663360630014524gustar00rootroot0000000000000052 comment=c21892b22caf0bc8ae29c0eca8c923ee62c2cfd4 zerologr-1.2.3/000077500000000000000000000000001436633606300133725ustar00rootroot00000000000000zerologr-1.2.3/.github/000077500000000000000000000000001436633606300147325ustar00rootroot00000000000000zerologr-1.2.3/.github/workflows/000077500000000000000000000000001436633606300167675ustar00rootroot00000000000000zerologr-1.2.3/.github/workflows/lint.yaml000066400000000000000000000015521436633606300206240ustar00rootroot00000000000000name: lint on: [ push, pull_request ] jobs: lint: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-go@v2 with: go-version: "^1.19" - uses: golangci/golangci-lint-action@v2 with: version: latest skip-go-installation: true args: -v --max-same-issues 10 --disable-all --exclude-use-default=false -E asciicheck -E deadcode -E errcheck -E forcetypeassert -E gocritic -E gofmt -E goimports -E gosimple -E govet -E ineffassign -E misspell -E revive -E staticcheck -E structcheck -E typecheck -E unused -E varcheck zerologr-1.2.3/.github/workflows/test.yaml000066400000000000000000000003451436633606300206340ustar00rootroot00000000000000name: test on: [ push, pull_request ] jobs: test: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-go@v2 with: go-version: "^1.19" - run: go test ./... zerologr-1.2.3/LICENSE000066400000000000000000000261351436633606300144060ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. zerologr-1.2.3/README.md000066400000000000000000000027301436633606300146530ustar00rootroot00000000000000# Zerologr [![Go Reference](https://pkg.go.dev/badge/github.com/go-logr/zerologr.svg)](https://pkg.go.dev/github.com/go-logr/zerologr) ![test](https://github.com/go-logr/zerologr/workflows/test/badge.svg) [![Go Report Card](https://goreportcard.com/badge/github.com/go-logr/zerologr)](https://goreportcard.com/report/github.com/go-logr/zerologr) A [logr](https://github.com/go-logr/logr) LogSink implementation using [Zerolog](https://github.com/rs/zerolog). ## Usage ```go import ( "os" "github.com/go-logr/logr" "github.com/go-logr/zerologr" "github.com/rs/zerolog" ) 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() var log logr.Logger = zerologr.New(&zl) log.Info("Logr in action!", "the answer", 42) } ``` ## Implementation Details For the most part, concepts in Zerolog correspond directly with those in logr. 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(). zerologr-1.2.3/example/000077500000000000000000000000001436633606300150255ustar00rootroot00000000000000zerologr-1.2.3/example/example_test.go000066400000000000000000000037021436633606300200500ustar00rootroot00000000000000//go:build !binary_log // +build !binary_log /* Copyright 2021 The logr Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package zerologr_test import ( "os" "github.com/go-logr/logr" "github.com/go-logr/zerologr" "github.com/rs/zerolog" ) type E struct { str string } func (e E) Error() string { return e.str } func Helper(log logr.Logger, msg string) { helper2(log, msg) } func helper2(log logr.Logger, msg string) { log.WithCallDepth(2).Info(msg) } func ExampleNew() { zerologr.SetMaxV(1) zl := zerolog.New(os.Stdout) log := zerologr.New(&zl) log = log.WithName("MyName") log = log.WithValues("module", "example") log.Info("hello", "val1", 1, "val2", map[string]int{"k": 1}) log.V(1).Info("you should see this") log.V(1).V(1).Info("you should NOT see this") log.Error(nil, "uh oh", "trouble", true, "reasons", []float64{0.1, 0.11, 3.14}) log.Error(E{"an error occurred"}, "goodbye", "code", -1) Helper(log, "thru a helper") // Output: // {"level":"info","module":"example","v":0,"logger":"MyName","val1":1,"val2":{"k":1},"message":"hello"} // {"level":"debug","module":"example","v":1,"logger":"MyName","message":"you should see this"} // {"level":"error","module":"example","logger":"MyName","trouble":true,"reasons":[0.1,0.11,3.14],"message":"uh oh"} // {"level":"error","module":"example","error":"an error occurred","logger":"MyName","code":-1,"message":"goodbye"} // {"level":"info","module":"example","v":0,"logger":"MyName","message":"thru a helper"} } zerologr-1.2.3/go.mod000066400000000000000000000004511436633606300145000ustar00rootroot00000000000000module github.com/go-logr/zerologr go 1.17 require ( 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 ) zerologr-1.2.3/go.sum000066400000000000000000000025341436633606300145310ustar00rootroot00000000000000github.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.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-1.2.3/zerologr.go000066400000000000000000000131531436633606300155670ustar00rootroot00000000000000// Package zerologr defines an implementation of the github.com/go-logr/logr // interfaces built on top of Zerolog (https://github.com/rs/zerolog). // // # Usage // // A new logr.Logger can be constructed from an existing zerolog.Logger using // the New function: // // log := zerologr.New(someZeroLogger) // // # Implementation Details // // For the most part, concepts in Zerolog correspond directly with those in // logr. // // 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 import ( "fmt" "github.com/go-logr/logr" "github.com/rs/zerolog" ) var ( // NameFieldName is the field key for logr.WithName. NameFieldName = "logger" // NameSeparator separates names for logr.WithName. NameSeparator = "/" // VerbosityFieldName is the field key for logr.Info verbosity. If set to "", // its value is not emitted. VerbosityFieldName = "v" // RenderArgsHook mutates the list of key-value pairs passed directly to // 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 // LogSink implements logr.LogSink and logr.CallDepthLogSink. type LogSink struct { l *zerolog.Logger name string depth int } // Underlier exposes access to the underlying logging implementation. Since // callers only have a logr.Logger, they have to know which implementation is // in use, so this interface is less of an abstraction and more of way to test // type conversion. type Underlier interface { GetUnderlying() *zerolog.Logger } var ( _ logr.LogSink = &LogSink{} _ logr.CallDepthLogSink = &LogSink{} ) // 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) } // NewLogSink returns a logr.LogSink implemented by Zerolog. 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 { 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. func (ls *LogSink) Info(level int, msg string, keysAndValues ...interface{}) { e := ls.l.WithLevel(zerolog.Level(1 - level)) if VerbosityFieldName != "" { e.Int(VerbosityFieldName, level) } ls.msg(e, msg, keysAndValues) } // Error logs an error, with the given message and key/value pairs as context. func (ls *LogSink) Error(err error, msg string, keysAndValues ...interface{}) { e := ls.l.Error().Err(err) ls.msg(e, msg, keysAndValues) } func (ls *LogSink) msg(e *zerolog.Event, msg string, keysAndValues []interface{}) { if e == nil { return } if ls.name != "" { e.Str(NameFieldName, ls.name) } if RenderArgsHook != nil { keysAndValues = RenderArgsHook(keysAndValues) } e = e.Fields(keysAndValues) e.CallerSkipFrame(ls.depth) e.Msg(msg) } // WithValues returns a new LogSink with additional key/value pairs. func (ls LogSink) WithValues(keysAndValues ...interface{}) logr.LogSink { if RenderValuesHook != nil { keysAndValues = RenderValuesHook(keysAndValues) } l := ls.l.With().Fields(keysAndValues).Logger() ls.l = &l return &ls } // WithName returns a new LogSink with the specified name appended in NameFieldName. // Name elements are separated by NameSeparator. func (ls LogSink) WithName(name string) logr.LogSink { if ls.name != "" { ls.name += NameSeparator + name } else { ls.name = name } return &ls } // WithCallDepth returns a new LogSink that offsets the call stack by adding specified depths. func (ls LogSink) WithCallDepth(depth int) logr.LogSink { ls.depth += depth return &ls } // GetUnderlying returns the zerolog.Logger underneath this logSink. func (ls *LogSink) GetUnderlying() *zerolog.Logger { return ls.l } // DefaultRender supports logr.Marshaler and fmt.Stringer. func DefaultRender(keysAndValues []interface{}) []interface{} { for i, n := 1, len(keysAndValues); i < n; i += 2 { value := keysAndValues[i] switch v := value.(type) { case logr.Marshaler: keysAndValues[i] = v.MarshalLog() case fmt.Stringer: keysAndValues[i] = v.String() } } return keysAndValues }