diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7c47c6 --- /dev/null +++ b/README.md @@ -0,0 +1,115 @@ +# Zerologr + +The fastest [logr](https://github.com/go-logr/logr) implementation using +[Zerolog](https://github.com/rs/zerolog). + +## Usage + +```go +import ( + "os" + + "github.com/go-logr/logr" + "github.com/hn8/zerologr" + "github.com/rs/zerolog" +) + +func main() { + zerologr.NameFieldName = "logger" + zerologr.NameSeparator = "/" + + zl := zerolog.New(os.Stderr) + 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. + +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`. + +## Benchmark + +``` +go version go1.16.6 linux/amd64 +cpu: Intel(R) Core(TM) i7-4870HQ CPU @ 2.50GHz + +BenchmarkDiscardInfoOneArg-8 1247884 953.4 ns/op 176 B/op 4 allocs/op +BenchmarkDiscardInfoSeveralArgs-8 721035 1484 ns/op 336 B/op 6 allocs/op +BenchmarkDiscardV0Info-8 770527 1486 ns/op 336 B/op 6 allocs/op +BenchmarkDiscardV9Info-8 9779283 137.8 ns/op 176 B/op 2 allocs/op +BenchmarkDiscardError-8 677576 1542 ns/op 336 B/op 6 allocs/op +BenchmarkDiscardWithValues-8 5563468 225.2 ns/op 192 B/op 3 allocs/op +BenchmarkDiscardWithName-8 20706103 58.52 ns/op 64 B/op 1 allocs/op +BenchmarkFuncrInfoOneArg-8 1255844 948.2 ns/op 176 B/op 4 allocs/op +BenchmarkFuncrInfoSeveralArgs-8 802514 1491 ns/op 336 B/op 6 allocs/op +BenchmarkFuncrV0Info-8 795092 1480 ns/op 336 B/op 6 allocs/op +BenchmarkFuncrV9Info-8 9467601 140.3 ns/op 176 B/op 2 allocs/op +BenchmarkFuncrError-8 791719 1528 ns/op 336 B/op 6 allocs/op +BenchmarkFuncrWithValues-8 5428614 222.8 ns/op 192 B/op 3 allocs/op +BenchmarkFuncrWithName-8 18420804 62.07 ns/op 64 B/op 1 allocs/op +``` + +stdr: https://github.com/go-logr/stdr/pull/14 + +``` +BenchmarkDiscardInfoOneArg-8 1319188 892.8 ns/op 232 B/op 8 allocs/op +BenchmarkDiscardInfoSeveralArgs-8 742125 1580 ns/op 552 B/op 14 allocs/op +BenchmarkDiscardV0Info-8 755325 1621 ns/op 552 B/op 14 allocs/op +BenchmarkDiscardV9Info-8 8628398 133.5 ns/op 176 B/op 2 allocs/op +BenchmarkDiscardError-8 693415 1715 ns/op 600 B/op 16 allocs/op +BenchmarkDiscardWithValues-8 n 4856173 242.6 ns/op 208 B/op 3 allocs/op +BenchmarkDiscardWithName-8 12319874 85.29 ns/op 80 B/op 1 allocs/op +BenchmarkFuncrInfoOneArg-8 1332094 904.2 ns/op 232 B/op 8 allocs/op +BenchmarkFuncrInfoSeveralArgs-8 689158 1561 ns/op 552 B/op 14 allocs/op +BenchmarkFuncrV0Info-8 769890 1629 ns/op 552 B/op 14 allocs/op +BenchmarkFuncrV9Info-8 8916390 138.0 ns/op 176 B/op 2 allocs/op +BenchmarkFuncrError-8 693705 1723 ns/op 600 B/op 16 allocs/op +BenchmarkFuncrWithValues-8 4718301 251.3 ns/op 208 B/op 3 allocs/op +BenchmarkFuncrWithName-8 12068954 91.43 ns/op 80 B/op 1 allocs/op +``` + +glogr: https://github.com/go-logr/glogr/pull/16 + +``` +BenchmarkDiscardInfoOneArg-8 464660 2199 ns/op 400 B/op 9 allocs/op +BenchmarkDiscardInfoSeveralArgs-8 411957 2908 ns/op 664 B/op 15 allocs/op +BenchmarkDiscardV0Info-8 382228 2879 ns/op 664 B/op 15 allocs/op +BenchmarkDiscardV9Info-8 9592717 138.8 ns/op 176 B/op 2 allocs/op +BenchmarkDiscardError-8 327556 3160 ns/op 696 B/op 17 allocs/op +BenchmarkDiscardWithValues-8 5553832 223.2 ns/op 192 B/op 3 allocs/op +BenchmarkDiscardWithName-8 17091950 71.42 ns/op 64 B/op 1 allocs/op +BenchmarkFuncrInfoOneArg-8 546212 2196 ns/op 400 B/op 9 allocs/op +BenchmarkFuncrInfoSeveralArgs-8 396565 2890 ns/op 664 B/op 15 allocs/op +BenchmarkFuncrV0Info-8 421482 2872 ns/op 664 B/op 15 allocs/op +BenchmarkFuncrV9Info-8 8809033 138.8 ns/op 176 B/op 2 allocs/op +BenchmarkFuncrError-8 383487 3121 ns/op 696 B/op 17 allocs/op +BenchmarkFuncrWithValues-8 5243806 221.5 ns/op 192 B/op 3 allocs/op +BenchmarkFuncrWithName-8 15284324 70.80 ns/op 64 B/op 1 allocs/op +``` + +zapr: https://github.com/go-logr/zapr/pull/33 + +``` +BenchmarkDiscardInfoOneArg-8 273366 4181 ns/op 713 B/op 15 allocs/op +BenchmarkDiscardInfoSeveralArgs-8 227490 5202 ns/op 1130 B/op 17 allocs/op +BenchmarkDiscardV0Info-8 238732 5162 ns/op 1129 B/op 17 allocs/op +BenchmarkDiscardV9Info-8 9315973 141.0 ns/op 176 B/op 2 allocs/op +BenchmarkDiscardError-8 192272 5543 ns/op 1258 B/op 18 allocs/op +BenchmarkDiscardWithValues-8 831561 1432 ns/op 1544 B/op 10 allocs/op +BenchmarkDiscardWithName-8 5448158 201.5 ns/op 216 B/op 4 allocs/op +BenchmarkFuncrInfoOneArg-8 261658 4174 ns/op 713 B/op 15 allocs/op +BenchmarkFuncrInfoSeveralArgs-8 227588 5172 ns/op 1130 B/op 17 allocs/op +BenchmarkFuncrV0Info-8 227376 5158 ns/op 1130 B/op 17 allocs/op +BenchmarkFuncrV9Info-8 8277498 147.4 ns/op 176 B/op 2 allocs/op +BenchmarkFuncrError-8 205752 5576 ns/op 1258 B/op 18 allocs/op +BenchmarkFuncrWithValues-8 939271 1392 ns/op 1544 B/op 10 allocs/op +BenchmarkFuncrWithName-8 5572585 208.5 ns/op 216 B/op 4 allocs/op +``` diff --git a/benchmark/benchmark_test.go b/benchmark/benchmark_test.go new file mode 100644 index 0000000..af55fb0 --- /dev/null +++ b/benchmark/benchmark_test.go @@ -0,0 +1,174 @@ +/* +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 ( + "fmt" + "os" + "testing" + + "github.com/go-logr/logr" + "github.com/hn8/zerologr" + "github.com/rs/zerolog" +) + +func init() { + zerolog.SetGlobalLevel(zerolog.DebugLevel) + os.Stderr, _ = os.Open("/dev/null") +} + +//go:noinline +func doInfoOneArg(b *testing.B, log logr.Logger) { + b.ReportAllocs() + for i := 0; i < b.N; i++ { + log.Info("this is", "a", "string") + } +} + +//go:noinline +func doInfoSeveralArgs(b *testing.B, log logr.Logger) { + b.ReportAllocs() + for i := 0; i < b.N; i++ { + log.Info("multi", + "bool", true, "string", "str", "int", 42, + "float", 3.14, "struct", struct{ X, Y int }{93, 76}) + } +} + +//go:noinline +func doV0Info(b *testing.B, log logr.Logger) { + b.ReportAllocs() + for i := 0; i < b.N; i++ { + log.V(0).Info("multi", + "bool", true, "string", "str", "int", 42, + "float", 3.14, "struct", struct{ X, Y int }{93, 76}) + } +} + +//go:noinline +func doV9Info(b *testing.B, log logr.Logger) { + b.ReportAllocs() + for i := 0; i < b.N; i++ { + log.V(9).Info("multi", + "bool", true, "string", "str", "int", 42, + "float", 3.14, "struct", struct{ X, Y int }{93, 76}) + } +} + +//go:noinline +func doError(b *testing.B, log logr.Logger) { + b.ReportAllocs() + err := fmt.Errorf("error message") + for i := 0; i < b.N; i++ { + log.Error(err, "multi", + "bool", true, "string", "str", "int", 42, + "float", 3.14, "struct", struct{ X, Y int }{93, 76}) + } +} + +//go:noinline +func doWithValues(b *testing.B, log logr.Logger) { + b.ReportAllocs() + for i := 0; i < b.N; i++ { + l := log.WithValues("k1", "v1", "k2", "v2") + _ = l + } +} + +//go:noinline +func doWithName(b *testing.B, log logr.Logger) { + b.ReportAllocs() + for i := 0; i < b.N; i++ { + l := log.WithName("name") + _ = l + } +} + +func logger() logr.Logger { + zl := zerolog.New(os.Stderr) + return zerologr.New(&zl) +} + +func BenchmarkDiscardInfoOneArg(b *testing.B) { + var log logr.Logger = logger() + doInfoOneArg(b, log) +} + +func BenchmarkDiscardInfoSeveralArgs(b *testing.B) { + var log logr.Logger = logger() + doInfoSeveralArgs(b, log) +} + +func BenchmarkDiscardV0Info(b *testing.B) { + var log logr.Logger = logger() + doV0Info(b, log) +} + +func BenchmarkDiscardV9Info(b *testing.B) { + var log logr.Logger = logger() + doV9Info(b, log) +} + +func BenchmarkDiscardError(b *testing.B) { + var log logr.Logger = logger() + doError(b, log) +} + +func BenchmarkDiscardWithValues(b *testing.B) { + var log logr.Logger = logger() + doWithValues(b, log) +} + +func BenchmarkDiscardWithName(b *testing.B) { + var log logr.Logger = logger() + doWithName(b, log) +} + +func BenchmarkFuncrInfoOneArg(b *testing.B) { + var log logr.Logger = logger() + doInfoOneArg(b, log) +} + +func BenchmarkFuncrInfoSeveralArgs(b *testing.B) { + var log logr.Logger = logger() + doInfoSeveralArgs(b, log) +} + +func BenchmarkFuncrV0Info(b *testing.B) { + var log logr.Logger = logger() + doV0Info(b, log) +} + +func BenchmarkFuncrV9Info(b *testing.B) { + var log logr.Logger = logger() + doV9Info(b, log) +} + +func BenchmarkFuncrError(b *testing.B) { + var log logr.Logger = logger() + doError(b, log) +} + +func BenchmarkFuncrWithValues(b *testing.B) { + var log logr.Logger = logger() + doWithValues(b, log) +} + +func BenchmarkFuncrWithName(b *testing.B) { + var log logr.Logger = logger() + doWithName(b, log) +} diff --git a/example/example_test.go b/example/example_test.go new file mode 100644 index 0000000..c0eeb77 --- /dev/null +++ b/example/example_test.go @@ -0,0 +1,64 @@ +// +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/hn8/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() { + zerolog.SetGlobalLevel(zerolog.DebugLevel) + 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") // TODO: fix https://github.com/go-logr/logr/pull/58 + + // Output: + // {"level":"info","module":"example","val1":1,"val2":{"k":1},"logger":"MyName","message":"hello"} + // {"level":"debug","module":"example","logger":"MyName","message":"you should see this"} + // {"level":"error","module":"example","trouble":true,"reasons":[0.1,0.11,3.14],"logger":"MyName","message":"uh oh"} + // {"level":"error","error":"an error occurred","module":"example","code":-1,"logger":"MyName","message":"goodbye"} + // {"level":"info","message":"thru a helper"} +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..2cd0223 --- /dev/null +++ b/go.mod @@ -0,0 +1,8 @@ +module github.com/hn8/zerologr + +go 1.16 + +require ( + github.com/go-logr/logr v1.0.0 + github.com/rs/zerolog v1.23.0 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..fe52446 --- /dev/null +++ b/go.sum @@ -0,0 +1,30 @@ +github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= +github.com/go-logr/logr v1.0.0 h1:kH951GinvFVaQgy/ki/B3YYmQtRpExGigSJg6O8z5jo= +github.com/go-logr/logr v1.0.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= +github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/rs/xid v1.2.1/go.mod h1:+uKXf+4Djp6Md1KODXJxgGQPKngRmWyn10oCKFzNHOQ= +github.com/rs/zerolog v1.23.0 h1:UskrK+saS9P9Y789yNNulYKdARjPZuS35B8gJF2x60g= +github.com/rs/zerolog v1.23.0/go.mod h1:6c7hFfxPOy7TacJc4Fcdi24/J0NKYGzjG8FWRI916Qo= +github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +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-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/mod v0.3.0/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-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/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-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +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/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.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= +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= diff --git a/zerologr.go b/zerologr.go new file mode 100644 index 0000000..cb101d8 --- /dev/null +++ b/zerologr.go @@ -0,0 +1,225 @@ +// 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. +// +// 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. +package zerologr + +import ( + "encoding/json" + "net" + "time" + + "github.com/go-logr/logr" + "github.com/rs/zerolog" +) + +var ( + NameFieldName = "logger" + NameSeparator = "/" +) + +const ( + infoLevel = 1 - int(zerolog.InfoLevel) + debugLevel = 1 - int(zerolog.DebugLevel) + traceLevel = 1 - int(zerolog.TraceLevel) +) + +type logSink struct { + l *zerolog.Logger + prefix string + values []interface{} + depth int64 + _ int64 // CPU cache line padding +} + +var ( + _ logr.LogSink = &logSink{} + _ logr.CallDepthLogSink = &logSink{} +) + +// New returns a logr.Logger with logr.LogSink implemented by zerolog. +func New(l *zerolog.Logger) logr.Logger { + ls := &logSink{l: l} + return logr.New(ls) +} + +func (ls *logSink) Init(ri logr.RuntimeInfo) { + ls.depth += int64(ri.CallDepth) + 2 +} + +func (*logSink) Enabled(level int) bool { + // Info() checks zerolog.GlobalLevel() internally + return level <= traceLevel +} + +func (ls *logSink) Info(level int, msg string, kvList ...interface{}) { + var e *zerolog.Event + // small switch: linear search + switch level { + case infoLevel: + e = ls.l.Info() + case debugLevel: + e = ls.l.Debug() + case traceLevel: + e = ls.l.Trace() + } + ls.msg(e, msg, kvList) +} + +func (ls *logSink) Error(err error, msg string, kvList ...interface{}) { + e := ls.l.Error().Err(err) + ls.msg(e, msg, kvList) +} + +func (ls *logSink) msg(e *zerolog.Event, msg string, kvList []interface{}) { + if e == nil { + return + } + if len(ls.values) > 0 { + e = handleFields(e, ls.values) + } + e = handleFields(e, kvList) + if len(ls.prefix) > 0 { + e.Str(NameFieldName, ls.prefix) + } + e.CallerSkipFrame(int(ls.depth)) + e.Msg(msg) +} + +func (ls logSink) WithValues(kvList ...interface{}) logr.LogSink { + n := len(ls.values) + ls.values = append(ls.values[:n:n], kvList...) + return &ls +} + +// WithName returns a new logr.Logger with the specified NameFieldName. zerologr +// uses NameSeparator characters to separate name elements. Callers should not pass +// NameSeparator in the provided name string, but this library does not actually enforce that. +func (ls logSink) WithName(name string) logr.LogSink { + if len(ls.prefix) > 0 { + ls.prefix += NameSeparator + name + } else { + ls.prefix = name + } + return &ls +} + +func (ls logSink) WithCallDepth(depth int) logr.LogSink { + ls.depth += int64(depth) + return &ls +} + +func handleFields(e *zerolog.Event, kvList []interface{}) *zerolog.Event { + kvLen := len(kvList) + if kvLen&0x1 == 1 { // odd number + kvList = append(kvList, "") + } + for i := 0; i < kvLen; i += 2 { + key, val := kvList[i], kvList[i+1] + k, ok := key.(string) + if !ok { + k = "" + } + // concrete type switch: binary search of sorted type hash + switch v := val.(type) { + case string: + e.Str(k, v) + case []byte: + e.Bytes(k, v) + case bool: + e.Bool(k, v) + case int: + e.Int(k, v) + case int8: + e.Int8(k, v) + case int16: + e.Int16(k, v) + case int32: + e.Int32(k, v) + case int64: + e.Int64(k, v) + case uint: + e.Uint(k, v) + case uint8: + e.Uint8(k, v) + case uint16: + e.Uint16(k, v) + case uint32: + e.Uint32(k, v) + case uint64: + e.Uint64(k, v) + case float32: + e.Float32(k, v) + case float64: + e.Float64(k, v) + case time.Time: + e.Time(k, v) + case time.Duration: + e.Dur(k, v) + case []string: + e.Strs(k, v) + case []bool: + e.Bools(k, v) + case []int: + e.Ints(k, v) + case []int8: + e.Ints8(k, v) + case []int16: + e.Ints16(k, v) + case []int32: + e.Ints32(k, v) + case []int64: + e.Ints64(k, v) + case []uint: + e.Uints(k, v) + case []uint16: + e.Uints16(k, v) + case []uint32: + e.Uints32(k, v) + case []uint64: + e.Uints64(k, v) + case []float32: + e.Floats32(k, v) + case []float64: + e.Floats64(k, v) + case []time.Time: + e.Times(k, v) + case []time.Duration: + e.Durs(k, v) + case net.IP: + e.IPAddr(k, v) + case net.IPNet: + e.IPPrefix(k, v) + case net.HardwareAddr: + e.MACAddr(k, v) + case json.RawMessage: + e.RawJSON(k, v) + default: + // interface type switch + switch v := val.(type) { + case error: + e.AnErr(k, v) + case []error: + e.Errs(k, v) + default: + e.Interface(k, val) + } + } + } + return e +}