Instrumentation for the RxJava Framework (https://github.com/ReactiveX/RxJava). There are two sets of instrumentation, one for RxJava1 and the other for RxJava2.
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 start to track RxJava objects.
Tracks Observable, Completable and Single. For an Observable, it will link the onNext back to the original transaction and complete and link on either the onError or onCompleted and expire the token. For a Completable or Single, it will link back to the original transaction on the onError or onCompleted and expired the token. The rxjava1-finder extension will find methods which return an RxJava1 object (Completable, Observable, Single) and include them in the transaction trace. Methods in the rx package (and subpackages) are ignored.
Tracks Completable, Flowable, Maybe, Observable and Single. For objects with onNext, the method call will be linked back to the original transaction. For all objects the link is expired and linked with the object completes or an error is recorded. The rxjava2-finder extension will find methods which return an RxJava1 object (Completable, Flowable, Maybe, Observable, Single) and include them in the transaction trace. Methods in the io.reactivex package (and subpackages) are ignored.
The RxJava2 instrumentation uses a New Relic Java Agent segment (https://docs.newrelic.com/docs/agents/java-agent/async-instrumentation/java-agent-api-asynchronous-applications/#segments) to track the time from when the object is subscribed to until the object is completed or throws an error. This feature is turned on by default. To turn this feature off:
- Edit newrelic.yml
- Insert the following text into the file. It can be placed anywhere in the file but the preferred place is right before the labels: stanza. Please note that spaces matter so first two lines has two space at the beginning and the third has four spaces.
# Used to toggle the use of segments in RxJava2 objects
RxJava2:
useSegments: false
Support for RxJava3 is the same as the RxJava2. Requires different extension jars due to changes to package names
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
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.
[Project Name] 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.]