This project contains examples illustrating usage of OpenTelemetry with New Relic. The examples aim to demonstrate the most common configurations we expect users to encounter, but isn't an exhaustive set of the ways you can use OpenTelemetry with New Relic. See getting started guides and other examples for an index of available examples.
The Getting Started Guides demonstrate how to get started with OpenTelemetry and New Relic. Each of the languages listed illustrates how to add OpenTelemetry instrumentation to a simple web application, and configure OpenTelemetry to export data to New Relic.
- .NET
- Go
- Java (uninstrumented / instrumented)
- JavaScript (Node.js)
- Python (uninstrumented / instrumented)
- Ruby
OpenTelemetry is a big ecosystem and everything doesn't fit into the goals of the getting started guides. These "other examples" demonstrate how other areas of OpenTelemetry fit in with New Relic.
- Collector
- Java
- .NET
- Serverless
- Clone this repo.
- Follow the directions in the README of the example that you are interested in.
We encourage your contributions to improve newrelic-opentelemetry-examples! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
Generally, we want to focus on the getting started guides. We're open to additional examples being added which are aligned with the demo app specification and which have a volunteer codeowner.
We're more selective about additions to other examples. We use the following criteria to evaluate additions:
- Does the example demonstrate a very popular use case or recurring pain point?
- Has someone has volunteered to be a codeowner?
- Is there documentation - either in the readme or docs.newrelic.com - which describes how to use the data produced by the example in New Relic?
- Is there continuous integration (i.e. github action) ensuring that the example code functions?
If the answer is yes to all those questions, we'll likely accept the contribution.
If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.
Codeowners for each example are defined in codeowner. Each codeowner is responsible for:
- Keeping dependencies (relatively) up to date.
- Responding to issues related to the example.
Codeowners are added as collaborators individually and given "write" permissions to the repository.
Examples without a codeowner may be deleted.
As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.
If you would like to contribute to this project, review these guidelines.
To all contributors, we thank you! Without your contribution, this project would not be what it is today.
newrelic-opentelemetry-examples is licensed under the Apache 2.0 License.
newrelic-opentelemetry-examples also uses source code from third-party libraries. You can find full details on which libraries are used and the terms under which they are licensed in the third-party notices document.