Skip to content

Commit e86375d

Browse files
authored
Update README.md
1 parent 1055d50 commit e86375d

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
# New Relic Java Instrumentation for RxJava
1919

20-
Instrumentation for the RxJava Framework (https://github.com/ReactiveX/RxJava). There are two sets of instrumentation, one for RxJava1 and the other for RxJava2.
20+
Instrumentation for the RxJava Framework (https://github.com/ReactiveX/RxJava). There are three sets of instrumentation, one for RxJava1 one for RxJava2 and one for RxJava3.
2121

2222
## Installation
2323

@@ -38,13 +38,22 @@ 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. This feature is turned on by default. To turn this feature off:
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.
42+
43+
To turn this feature off:
4244
1. Edit newrelic.yml
4345
2. 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.
4446

4547
  \# Used to toggle the use of segments in RxJava2 objects
4648
  RxJava2:
4749
    useSegments: false
50+
51+
To ignore certain Rx objects add the rxType and simple class name to the above configuration. For example to stop using segments to track with the name RxJava2/Flowable/TotalTime/FlowableFlatMap, use the following configuration:
52+
  RxJava2:
53+
    useSegments: true
54+
    Flowable:
55+
      ignores: FlowableFlatMap
56+
4857
### RxJava3
4958
Support for RxJava3 is the same as the RxJava2. Requires different extension jars due to changes to package names
5059
## Building

0 commit comments

Comments
 (0)