New Relic Java Agent instrumentation for the Reactor Framework (https://projectreactor.io/)
This instrumentation provides two different ways to view transaction in an application using Reactor. Releaase V2.0 provides a Distributed Tracing view where a request will generate multiple transactions that are tied together in the Distributed Tracing View of the New Relic Java Agent UI. Release V1.1 uses the New Relic Java Agent Async token to tie things together into a single transaction showing actions across all threads.
The pro of using V1.1 is that it results in a single transaction in both the Transaction Trace view and the Distributed Tracing view. The con is that in a high throughput environment where Reactor actions happen across multiple threads it can lead to high memory usage for the async token cache.
The pro of using v2.0.0 (& onwards) is that it has a much lower memory usage. The con is that to view what happens with the request you can only use the Distributed Tracing view.
To install:
- Download the latest release jar files.
- In the New Relic Java directory (the one containing newrelic.jar), create a directory named extensions if it does not already exist.
- Copy the downloaded jars into the extensions directory.
- Restart the application.
Once installed the instrumentation will track when a Mono or Flux object is placed on a scheduler for either the subscribe or the observe (or both). The reactor finder extension instruments methods which return a Mono or a Flux object except these classes in the Reactor framework.
Building the extension requires that Gradle is installed. To build the extension jars from source, follow these steps:
To build a single extension with name extension, do the following:
- Set an environment variable NEW_RELIC_EXTENSIONS_DIR and set its value to the directory where you want the jar file built.
- Run the command: gradlew extension:clean extension:install
To build all extensions, do the following:
- Set an environment variable NEW_RELIC_EXTENSIONS_DIR and set its value to the directory where you want the jar file built.
- Run the command: gradlew clean install
[Optional - Include instructions on how to run tests if we include tests with the codebase. Remove this section if it's not needed.]
New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.
We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.
We encourage your contributions to improve [Project Name]! Keep in mind 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, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.
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.
New Relic Java Agent Instrumentation for Java Reactor is licensed under the Apache 2.0 License.
[If applicable: [Project Name] 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.]