Merge pull request #14 from newrelic-experimental/fix_zip_problem

Fix zip problem

Author: dhilpipre

.github/workflows/CHANGELOG.tpl.md

@@ -0,0 +1,3 @@
+
+{{.SECTION}}### $title{{.SECTION}}
+{{.COMMITS}}- $commit{{.COMMITS}}

README.md

@@ -17,7 +17,7 @@
 
 # New Relic Java Instrumentation for RxJava 
 
-Instrumentation for the RxJava Framework (https://github.com/ReactiveX/RxJava).  There are two sets of instrumentation, one for RxJava1 and the other for RxJava2.
+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.
 
 ## Installation
 
@@ -38,15 +38,28 @@ The rxjava1-finder extension will find methods which return an RxJava1 object (C
 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.   
 #### RxJava2 Segments
-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:
+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.      
+    
+To turn this feature off:
 1. Edit newrelic.yml
 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.    
 
   \# Used to toggle the use of segments in RxJava2 objects  
   RxJava2:   
     useSegments: false  
+
+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:   
+  RxJava2:   
+    useSegments: true  
+    Flowable:     
+      ignores: FlowableFlatMap   
+   
 ### RxJava3
-Support for RxJava3 is the same as the RxJava2.  Requires different extension jars due to changes to package names
+Support for RxJava3 is the same as the RxJava2.  Requires different extension jars due to changes to package names    
+
+### Finder Extensions   
+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.   
+   
 ## Building
 Building the extension requires that Gradle is installed.
 To build the extension jars from source, follow these steps: