Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/newrelic/newrelic-telemetry-sdk-java
Java library for sending telemetry data to New Relic
https://github.com/newrelic/newrelic-telemetry-sdk-java
java monitoring newrelic open-source open-telemetry open-telemetry-java telemetry telemetry-java
Last synced: 1 day ago
JSON representation
Java library for sending telemetry data to New Relic
- Host: GitHub
- URL: https://github.com/newrelic/newrelic-telemetry-sdk-java
- Owner: newrelic
- License: apache-2.0
- Created: 2019-08-08T17:00:57.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T22:26:04.000Z (about 1 month ago)
- Last Synced: 2024-09-21T11:31:02.942Z (6 days ago)
- Topics: java, monitoring, newrelic, open-source, open-telemetry, open-telemetry-java, telemetry, telemetry-java
- Language: Java
- Homepage:
- Size: 1.21 MB
- Stars: 41
- Watchers: 28
- Forks: 37
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# New Relic Java Telemetry SDK
The New Relic Java Telemetry SDK is an easy way to send data to New Relic.
The SDK currently supports sending the MELT telemetry data types
(Metrics, Events, Logs, and Traces)
via the following APIs:
* [Metric API](https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/metric-api/report-metrics-metric-api) - for dimensional metrics
* [Trace API](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/introduction-trace-api) - for building up traces with spans
* [Events API](https://docs.newrelic.com/docs/insights/insights-data-sources/custom-data/introduction-event-api) - for custom events
* [Log API](https://docs.newrelic.com/docs/logs/new-relic-logs/log-api/introduction-log-api) - for log data
Why is this cool?
Send data to New Relic! No agent required.
Our [Telemetry SDK](https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/new-relic-sdks/telemetry-sdks-send-custom-telemetry-data-new-relic) tries to be helpful, so your job of sending telemetry data to New Relic can be done in the right way, easily. We've covered all of the basics for you so you can focus on writing feature code directly related to your business need or interest.
Why would you want to use the telemetry SDK?
We imagine you (or your customers) are interested in the telemetry data, generated by your tool, framework, or code, in New Relic. You can write an exporter to do so! Check out the [telemetry_examples](telemetry_examples) module to get started.
For the most recently published version, see [Releases](https://github.com/newrelic/newrelic-telemetry-sdk-java/releases)
## Installation
In order to send metrics or spans to New Relic, you will need a New Relic [license key](https://docs.newrelic.com/docs/apis/getting-started/intro-apis/understand-new-relic-api-keys#ingest-license-key) for the account to which you want to send data.
Maven dependencies:
```
com.newrelic.telemetry
telemetry-core
0.16.0
com.newrelic.telemetry
telemetry-http-okhttp
0.16.0
```
Gradle dependencies:
```
implementation("com.newrelic.telemetry:telemetry-core:0.16.0")
implementation("com.newrelic.telemetry:telemetry-http-okhttp:0.16.0")
```
Take a look at the example code in the [telemetry_examples](telemetry_examples) module.
We recommend looking at the [TelemetryClientExample](telemetry_examples/src/main/java/com/newrelic/telemetry/examples/TelemetryClientExample.java)
first.
Note: If you do not want to include `okhttp` as a transitive dependency, you will need to provide a custom implementation of the
`com.newrelic.telemetry.http.HttpPoster` interface, rather than using the `com.newrelic.telemetry:telemetry-http-okhttp` library.
## Usage
### Logging
The Telemetry SDK uses slf4j for all logging. Having a slf4j implementation in your application is required in order to see log information.
See [the slf4j documentation](http://www.slf4j.org/manual.html#swapping) for details.
#### Enabling audit logging
The various builders for the Telemetry SDK components include an option to `enableAuditLogging`. Enabling this option will cause the
SDK to product additional logging at `DEBUG` level. This logging includes the details of every payload sent to the New Relic APIs, and the responses from those APIs.
*WARNING*: If you enable audit logging, all the data in your spans and metrics will be sent to your logging system. It is recommended that you only enable
audit logging when absolutely necessary.
#### Use license key
The various builders for the Telemetry SDK components include an option to `useLicenseKey`. Enabling this option will cause the SDK to inform the API endpoints the key you provided is a New Relic [license key](https://docs.newrelic.com/docs/apis/getting-started/intro-apis/understand-new-relic-api-keys#ingest-license-key).
### For developers:
#### Requirements
* Java 11 or greater
* For IDEA:
* Docker & docker-compose must be installed for integration testing
### Find and use your data
Tips on how to find and query your data in New Relic:
- [Find metric data](https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/metric-api/introduction-metric-api#find-data)
- [Find trace/span data](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/introduction-trace-api#view-data)
For general querying information, see:
- [Query New Relic data](https://docs.newrelic.com/docs/using-new-relic/data/understand-data/query-new-relic-data)
- [Intro to NRQL](https://docs.newrelic.com/docs/query-data/nrql-new-relic-query-language/getting-started/introduction-nrql)
## Building
CI builds are run on Github Actions:
The project uses Java 11 and gradle 6 for building, and the gradle wrapper is provided.
To compile, run the tests and build the jars:
`$ ./gradlew build`
## Testing
End-to-end integration tests are included.
They are implemented with the testcontainers library; [mock-server](https://github.com/jamesdbloom/mockserver) provides the backend.
There are two modes to run the integration tests.
* Run with gradle: `$ ./gradlew integration_test:test`
* Run the integration test classes in IDEA directly. It should "just work".
## Code style
This project uses the [google-java-format](https://github.com/google/google-java-format) code style, and it is
easily applied via an included [gradle plugin](https://github.com/sherter/google-java-format-gradle-plugin):
`$ ./gradlew googleJavaFormat verifyGoogleJavaFormat`
Please be sure to run the formatter before committing any changes. There is a `pre-commit-hook.sh` which can
be applied automatically before commits by moving it into `.git/hooks/pre-commit`.
### Module structure:
#### `telemetry_core`
This is the core module for sending dimensional metrics and spans to New Relic. It contains low level APIs as well as
higher level "best practice" implementations that compose interactions with the lower level modules. The library is
published under maven coordinates:
`com.newrelic.telemetry:telemetry-core`
In order to send metrics and spans to New Relic, you will also need a New Relic [license key](https://docs.newrelic.com/docs/apis/getting-started/intro-apis/understand-new-relic-api-keys#ingest-license-key) for the account to which you want to send data.
#### `telemetry-http-java11`
This is an implementation of the required http client interface using Java 11 JDK classes as the underlying library.
The `telemetry-http-java11` library is published under the maven coordinates:
`com.newrelic.telemetry:telemetry-http-java11`
#### `telemetry-http-okhttp`
This is an implementation of the required http client interface using okhttp as the underlying library.
The `telemetry-http-okhttp` library is published under the maven coordinates:
`com.newrelic.telemetry:telemetry-http-okhttp`
#### `telemetry_examples`
Example code for using the metrics and telemetry APIs.
#### `integration_test`
Integration test module. Uses docker-compose based tests to test the SDK end-to-end.
### Retries
As [described here](https://github.com/newrelic/newrelic-telemetry-sdk-specs/blob/master/communication.md#graceful-degradation),
the `TelemetryClient` makes use of a default backoff strategy when it encounters data ingest errors.
Specifically, this strategy tries again after 1 second, then doubles the wait after each attempt
until a max wait of 15 seconds is reached. After 10 failed attempts, data is dropped and a message
is logged.
The backoff strategy is not currently pluggable. Please file an issue or submit a pull request
if you need greater control over this behavior.
## Support
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub: [Java Agent Forum Topics](https://forum.newrelic.com/s/hubtopic/Topic__c/Default?c__categories=%5B%7B%22icon%22%3A%22standard%3Adefault%22%2C%22id%22%3A%22a6c8W000000EesiQAC%22%2C%22sObjectType%22%3A%22Category__c%22%2C%22title%22%3A%22Java%20Agent%22%2C%22titleFormatted%22%3A%22Java%20Agent%22%7D%5D).
## Contribute
We encourage your contributions to improve New Relic Java Telemetry SDK! 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].
**A note about vulnerabilities**
As noted in our [security policy](../../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](https://hackerone.com/newrelic).
If you would like to contribute to this project, review [these guidelines](./CONTRIBUTING.md).
To [all contributors](https://github.com/newrelic/newrelic-telemetry-sdk-java/graphs/contributors), we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to [New Relic Telemetry SDK (Java)](https://opensource.newrelic.com/projects/newrelic/newrelic-telemetry-sdk-java).
[javadoc-image]: https://www.javadoc.io/badge/com.newrelic.telemetry/telemetry.svg
[javadoc-url]: https://www.javadoc.io/doc/com.newrelic.telemetry/telemetry
### Limitations
The New Relic Telemetry APIs are rate limited. Please reference the documentation for [New Relic Metric API](https://docs.newrelic.com/docs/introduction-new-relic-metric-api) and [New Relic Trace API requirements and limits](https://docs.newrelic.com/docs/apm/distributed-tracing/trace-api/trace-api-general-requirements-limits) on the specifics of the rate limits.
## License
The New Relic Java Telemetry SDK is licensed under the Apache 2.0 License.
The New Relic Java Telemetry SDK also uses source code from third party libraries.
Full details on which libraries are used and the terms under which they are licensed can be found in the
third party notices document.