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 OpenTelemetry APM monitoring, OpenTelemetry infrastructure monitoring and OpenTelemetry other examples for an index of available examples.
The getting started guides demonstrate APM monitoring 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.
See OpenTelemetry APM monitoring for more information.
These examples demonstrate how to monitor various infrastructure components with OpenTelemetry and New Relic.
- Monitor Confluent Cloud Kafka with Collector
- Monitor Docker with Collector
- Monitor HCP Consul with Collector
- Monitor HiveMQ with Collector
- Monitor Hosts with Collector
- Monitor Prometheus target with Collector
- Monitor Redis with Collector
- Monitor Singlestore with Collector
- Monitor Squid cache manager with Collector
- Monitor StatsD with Collector
OpenTelemetry is a big ecosystem and everything doesn't fit into the goals of the OpenTelemetry APM monitoring or OpenTelemetry infrastructure monitoring. 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!
For example additions, create an issue in this repo and describe the proposed example. Follow the issue workflow and make sure the issue is accepted before creating a PR. If an issue has not been accepted then do create a PR since it will be rejected.
Trivial changes, wording changes, spelling/grammar corrections, etc. can be made directly via pull requests and do not require an associated issue.
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. 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 [email protected].
This repository has a few areas of emphasis, each with their own criteria for additions:
- OpenTelemetry APM monitoring criteria
- OpenTelemetry infrastructure monitoring criteria
- OpenTelemetry other examples criteria
We do not accept examples demonstrating workflows which are not related to New Relic. These should be contributed upstream to the appropriate OpenTelemetry project.
Examples demonstrating APM monitoring based on OpenTelemetry instrumentation based in getting started guides, and supporting this documentation.
We are open to extending the guides to other languages in the OpenTelemetry ecosystem as long as they follow the uniform application structure defined in the demo app specification.
Examples demonstrating infrastructure monitoring with the OpenTelemetry collector based in other-examples/collector, and supporting this documentation.
While there are many different infrastructure components which can be monitored with the collector, we only accept examples which meet the following criteria:
- Examples must follow a common format.
See host monitoring for an
example.
- Demonstrate configuration in kubernetes.
- Include a
README.mdexplaining what the example does, how to run, and how to view data in New Relic. - Generate load, for example by running an instance of whatever infrastructure component is being monitored.
- Examples produce data with a corresponding workflow in New Relic. This might be a dashboard the user installs or a curated experience and participation in entity synthesis.
- Contributors must work with the maintainers to ensure the example can be maintained going forward. This may include some automated verification, volunteering to maintain it going forward as a codeowner, or some other arrangement. If the example integrates with a vendor, credentials must be supplied so the workflow can be verified on an ongoing basis.
These are examples that demonstrate important integrations which do not fall into the core areas of emphasis, e.g. for historical reasons.
If you wish to contribute an example like this, please reach out to us or open an issue. To avoid unnecessary work, please make sure the issue is accepted before opening a PR.
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.