Skip to content

Commit 542baa0

Browse files
authored
Update README.md
1 parent e86375d commit 542baa0

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The rxjava1-finder extension will find methods which return an RxJava1 object (C
3838
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.
3939
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.
4040
#### RxJava2 Segments
41-
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. It is reported as RxJava2/*rxType*/TotalTime/*rx Class simple name* This feature is turned on by default. Additional you can choose not to track certain RxJava Object by configuring a comma separated list of the simple class names that you wish to ignore.
41+
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. It is reported as RxJava2/*rxType*/TotalTime/*rx Class simple name* This feature is turned on by default. Additional you can choose not to track certain RxJava Object by configuring a comma separated list of the simple class names that you wish to ignore. Due to the logic used with the From methods (e.g. fromCallable) it is not possible to use segments to track from and hence they are not tracked via segments.
4242

4343
To turn this feature off:
4444
1. Edit newrelic.yml
@@ -55,7 +55,11 @@ To ignore certain Rx objects add the rxType and simple class name to the above c
5555
      ignores: FlowableFlatMap
5656

5757
### RxJava3
58-
Support for RxJava3 is the same as the RxJava2. Requires different extension jars due to changes to package names
58+
Support for RxJava3 is the same as the RxJava2. Requires different extension jars due to changes to package names
59+
60+
### Finder Extensions
61+
There are three finder extensions included with this instrumentation, one for each RxJava version. The purpose of these extensions to to track methods outside of those in RxJava that return one of the RxJava objects. This allows you to track your methods that return an RxJava object.
62+
5963
## Building
6064
Building the extension requires that Gradle is installed.
6165
To build the extension jars from source, follow these steps:

0 commit comments

Comments
 (0)