From aac5acdd3d94f8c7b5c172fd949913fc1f3410b5 Mon Sep 17 00:00:00 2001 From: James Goodhouse Date: Fri, 16 Dec 2022 15:08:26 -0800 Subject: [PATCH] add support for zerolog for agent logs --- GUIDE.md | 3 +- README.md | 1 + v3/integrations/nrzerolog/LICENSE.md | 206 ++++++++++++++++++++++ v3/integrations/nrzerolog/README.md | 10 ++ v3/integrations/nrzerolog/example_test.go | 23 +++ v3/integrations/nrzerolog/go.mod | 8 + v3/integrations/nrzerolog/nrzerolog.go | 42 +++++ v3/newrelic/log.go | 3 +- 8 files changed, 294 insertions(+), 2 deletions(-) create mode 100644 v3/integrations/nrzerolog/LICENSE.md create mode 100644 v3/integrations/nrzerolog/README.md create mode 100644 v3/integrations/nrzerolog/example_test.go create mode 100644 v3/integrations/nrzerolog/go.mod create mode 100644 v3/integrations/nrzerolog/nrzerolog.go diff --git a/GUIDE.md b/GUIDE.md index e20d4777d..ce300b5f0 100644 --- a/GUIDE.md +++ b/GUIDE.md @@ -137,12 +137,13 @@ if nil == err { } ``` -Popular logging libraries `logrus`, `logxi` and `zap` are supported by +Popular logging libraries `logrus`, `logxi`, `zap` and `zerolog` are supported by integration packages: * [v3/integrations/nrlogrus](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogrus/) * [v3/integrations/nrlogxi](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogxi/) * [v3/integrations/nrzap](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap/) +* [v3/integrations/nrzerolog](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog/) ## Transactions diff --git a/README.md b/README.md index 08ef49578..97c559116 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,7 @@ package primitives can be found [here](GUIDE.md#datastore-segments). | [sirupsen/logrus](https://github.com/sirupsen/logrus) | [v3/integrations/nrlogrus](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogrus) | Send agent log messages to Logrus | | [mgutz/logxi](https://github.com/mgutz/logxi) | [v3/integrations/nrlogxi](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogxi) | Send agent log messages to Logxi | | [uber-go/zap](https://github.com/uber-go/zap) | [v3/integrations/nrzap](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap) | Send agent log messages to Zap | +| [rs/zerolog](https://github.com/rs/zerolog) | [v3/integrations/nrzerolog](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog) | Send agent log messages to Zerolog | #### Logs in Context diff --git a/v3/integrations/nrzerolog/LICENSE.md b/v3/integrations/nrzerolog/LICENSE.md new file mode 100644 index 000000000..cee548c2d --- /dev/null +++ b/v3/integrations/nrzerolog/LICENSE.md @@ -0,0 +1,206 @@ + 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. + + +Versions 3.8.0 and above for this project are licensed under Apache 2.0. For +prior versions of this project, please see the LICENCE.txt file in the root +directory of that version for more information. diff --git a/v3/integrations/nrzerolog/README.md b/v3/integrations/nrzerolog/README.md new file mode 100644 index 000000000..e4c426502 --- /dev/null +++ b/v3/integrations/nrzerolog/README.md @@ -0,0 +1,10 @@ +# v3/integrations/nrzerolog [![GoDoc](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog?status.svg)](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog) + +Package `nrzerolog` supports https://github.com/rs/zerolog + +```go +import "github.com/newrelic/go-agent/v3/integrations/nrzerolog" +``` + +For more information, see +[godocs](https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog). diff --git a/v3/integrations/nrzerolog/example_test.go b/v3/integrations/nrzerolog/example_test.go new file mode 100644 index 000000000..22e9e7b42 --- /dev/null +++ b/v3/integrations/nrzerolog/example_test.go @@ -0,0 +1,23 @@ +// Copyright 2020 New Relic Corporation. All rights reserved. +// SPDX-License-Identifier: Apache-2.0 + +package nrzerolog_test + +import ( + "os" + + newrelic "github.com/newrelic/go-agent" + "github.com/rs/zerolog" +) + +func Example() { + // Create a new zerolog logger: + zl := zerolog.New(os.Stderr) + + newrelic.NewApplication( + newrelic.ConfigAppName("Example App"), + newrelic.ConfigLicense("__YOUR_NEWRELIC_LICENSE_KEY__"), + // Use nrzerolog to register the logger with the agent: + nrzerolog.ConfigLogger(&zl), + ) +} diff --git a/v3/integrations/nrzerolog/go.mod b/v3/integrations/nrzerolog/go.mod new file mode 100644 index 000000000..e2eb6cf41 --- /dev/null +++ b/v3/integrations/nrzerolog/go.mod @@ -0,0 +1,8 @@ +module github.com/newrelic/go-agent/v3/integrations/nrzerolog + +go 1.19 + +require ( + github.com/newrelic/go-agent/v3 v3.20.2 + github.com/rs/zerolog v1.28.0 +) diff --git a/v3/integrations/nrzerolog/nrzerolog.go b/v3/integrations/nrzerolog/nrzerolog.go new file mode 100644 index 000000000..d66303868 --- /dev/null +++ b/v3/integrations/nrzerolog/nrzerolog.go @@ -0,0 +1,42 @@ +// Copyright 2021 New Relic Corporation. All rights reserved. +// SPDX-License-Identifier: Apache-2.0 + +// Package nrzerolog supports https://github.com/rs/zerolog +// +// Wrap your zerolog Logger using nrzerolog.Transform to send agent log messages to zerolog. +package nrzerolog + +import ( + "github.com/newrelic/go-agent/v3/internal" + "github.com/newrelic/go-agent/v3/newrelic" + "github.com/rs/zerolog" +) + +func init() { internal.TrackUsage("integration", "logging", "zerolog") } + +type shim struct{ logger *zerolog.Logger } + +func (s *shim) Error(msg string, c map[string]interface{}) { + s.logger.Error().Fields(c).Msg(msg) +} +func (s *shim) Warn(msg string, c map[string]interface{}) { + s.logger.Warn().Fields(c).Msg(msg) +} +func (s *shim) Info(msg string, c map[string]interface{}) { + s.logger.Info().Fields(c).Msg(msg) +} +func (s *shim) Debug(msg string, c map[string]interface{}) { + s.logger.Debug().Fields(c).Msg(msg) +} +func (s *shim) DebugEnabled() bool { + return s.logger.GetLevel() == zerolog.DebugLevel +} + +// Transform turns a *zerolog.Logger into a newrelic.Logger. +func Transform(l *zerolog.Logger) newrelic.Logger { return &shim{logger: l} } + +// ConfigLogger configures the newrelic.Application to send log messsages to the +// provided zerolog logger. +func ConfigLogger(l *zerolog.Logger) newrelic.ConfigOption { + return newrelic.ConfigLogger(Transform(l)) +} diff --git a/v3/newrelic/log.go b/v3/newrelic/log.go index 6eaba3541..7c939b958 100644 --- a/v3/newrelic/log.go +++ b/v3/newrelic/log.go @@ -16,7 +16,8 @@ import ( // level. logrus, logxi, and zap are supported by the integration packages // https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogrus, // https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrlogxi, -// and https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap +// https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzap, +// and https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrzerolog // respectively. type Logger interface { Error(msg string, context map[string]interface{})