With this documentation, we intend to document our general principles, and specific implementations of what we generally call "exporters". By this, we mean libraries or tools that extract data from existing telemetry systems, convert the data into a New Relic-friendly format, and send them to New Relic. In general, the implementations of these exporters will rely on our open-source SDKs to do the work of sending the data to New Relic.
This documentation is divided into two sections, with two different intents. Documentation at the top level of this project is generally intended to be prescriptive. If you are designing an exporter, we strongly recommend following the Guidelines.md, as it will support interoperability between the metrics exported from various metric libraries. The documentation in the subdirectories, of the specific exporters, however, are intended to be purely descriptive. They should reflect exactly what the current version of the exporter actually does, even if it doesn't exactly follow the guidelines.
We have repositories for several New Relic exporters already. The full table can be found in our Telemetry SDK section on docs.newrelic.com. It includes at least one language versions for all of the exporters listed in the Organization section below.
See Guidelines.md for general principles on how to build exporters and provide adequate information so that they will be able to be queried by NRQL and visualizations can be created.
Each subdirectory contains a specification for how the relevant exporter functions.
Cross-language specifications for how we extract data from OpenTelemetry can be found in the opentelemetry directory.
Cross-language specifications for how we extract data from OpenCensus can be found in the opencensus directory.
The detailed description of how the New Relic DropWizard Reporter converts DropWizard metrics into New Relic dimensional metrics can be found in the dropwizard directory.
The detailed description of how the New Relic Micrometer registry converts Micrometer metrics into New Relic dimensional metrics can be found in the micrometer directory.
For support on this project, visit New Relic's Explorers Hub.
Full details are available in CONTRIBUTING.md.
A note about vulnerabilities
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.
License details are in LICENSE.md.