Release v1.6.0, re #491

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changes by Version
 
+## v1.6.0 (2020-03-14)
+* [Rewritable Tracer](https://github.com/opentracing-contrib/java-specialagent#37-rewritable-tracer) (#407 #415 #437 #479 #486)
+* Support "optional deferrable" rule attibute (#445)
+* Static Deferred Attach: Fix spring-kafka (#461)
+* Static Deferred Attach: Fix spring-messaging (#460 #470)
+* Static Deferred Attach: Fix spring-websocket (#474 #478)
+* Static Deferred Attach: Fix spring-messaging and spring-kafka (#481)
+* Auto-Compatibility Test: Auto-assert compatibility of instrumentation plugins (#462)
+* Auto-Compatibility Test: Support multiple pass/fail compatibility specs (#469)
+* Auto-Compatibility Test: Support complex pass/fail compatibility specs (#472)
+* Fix generated classes in Thrift rule (#489)
+* [Implement Apache CXF Instrumentation Plugin](https://github.com/opentracing-contrib/java-specialagent/tree/master/rule/cxf) (#476)
+
 ## v1.5.9 (2020-02-28)
 * Enable Static Deferred Attach for `spring-kafka` integration test (#425)
 * Fix failing Pulsar Functions integration test (#418)

README.md

@@ -71,7 +71,7 @@ The [<ins>SpecialAgent</ins>](#41-specialagent) is stable -- any exception that
 
 ### 2.1 Installation
 
-The Maven build of the [<ins>SpecialAgent</ins>](#41-specialagent) project generates 2 artifacts: **main** and **test**. These artifacts can be obtained by cloning this repository and following the [Development Instructions](#212-for-development), or downloading directly from [Maven's Central Repository](https://repo1.maven.org/maven2/io/opentracing/contrib/specialagent/opentracing-specialagent/1.5.9/).
+The Maven build of the [<ins>SpecialAgent</ins>](#41-specialagent) project generates 2 artifacts: **main** and **test**. These artifacts can be obtained by cloning this repository and following the [Development Instructions](#212-for-development), or downloading directly from [Maven's Central Repository](https://repo1.maven.org/maven2/io/opentracing/contrib/specialagent/opentracing-specialagent/1.6.0/).
 
 #### 2.1.1 In Application
 
@@ -83,31 +83,31 @@ The artifact JAR can be provided to an application with the `-javaagent:${SPECIA
 
 ##### 2.1.1.1 Stable
 
-The latest stable release is: [1.5.9][main-release]
+The latest stable release is: [1.6.0][main-release]
 
 ```bash
-wget -O opentracing-specialagent-1.5.9.jar "https://repo1.maven.org/maven2/io/opentracing/contrib/specialagent/opentracing-specialagent/1.5.9/opentracing-specialagent-1.5.9.jar"
+wget -O opentracing-specialagent-1.6.0.jar "https://repo1.maven.org/maven2/io/opentracing/contrib/specialagent/opentracing-specialagent/1.6.0/opentracing-specialagent-1.6.0.jar"
 ```
 
 ##### 2.1.1.2 Development
 
-The latest development release is: [1.6.0-SNAPSHOT][main-snapshot]
+The latest development release is: [1.6.1-SNAPSHOT][main-snapshot]
 
 ```bash
-wget -O opentracing-specialagent-1.6.0-SNAPSHOT.jar "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.opentracing.contrib.specialagent&a=opentracing-specialagent&v=LATEST"
+wget -O opentracing-specialagent-1.6.1-SNAPSHOT.jar "https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=io.opentracing.contrib.specialagent&a=opentracing-specialagent&v=LATEST"
 ```
 
 **Note**: Sometimes the web service call (in the line above) to retrieve the latest SNAPSHOT build fails to deliver the correct download. In order to work around this issue, please consider using the following command (for Linux and Mac OS):
 
 ```bash
-wget -O opentracing-specialagent-1.6.0-SNAPSHOT.jar $(curl -s https://oss.sonatype.org/content/repositories/snapshots/io/opentracing/contrib/specialagent/opentracing-specialagent/1.6.0-SNAPSHOT/ | grep '".*\d\.jar"' | tail -1 | awk -F\" '{print $2}')
+wget -O opentracing-specialagent-1.6.1-SNAPSHOT.jar $(curl -s https://oss.sonatype.org/content/repositories/snapshots/io/opentracing/contrib/specialagent/opentracing-specialagent/1.6.1-SNAPSHOT/ | grep '".*\d\.jar"' | tail -1 | awk -F\" '{print $2}')
 ```
 
 #### 2.1.2 For Development
 
 The [<ins>SpecialAgent</ins>](#41-specialagent) is built in 2 passes that rely on different profiles:
 
-1. The `default` profile is used for development of [<ins>Instrumentation Rules</ins>](#45-instrumentation-rule). It builds and runs tests for each rule, but _does not bundle the rules_ into [`opentracing-specialagent-1.5.9.jar`][main-release]
+1. The `default` profile is used for development of [<ins>Instrumentation Rules</ins>](#45-instrumentation-rule). It builds and runs tests for each rule, but _does not bundle the rules_ into [`opentracing-specialagent-1.6.0.jar`][main-release]
 
     To run this profile:
     ```bash
@@ -116,9 +116,9 @@ The [<ins>SpecialAgent</ins>](#41-specialagent) is built in 2 passes that rely o
 
     _**Note**: If you skip tests, the `assemble` profile will display an error stating that tests have not been run. See [Convenient One-Liners](#convenient-one-liners) for quick ways to build and package [<ins>SpecialAgent</ins>](#41-specialagent)_.
 
-1. The `assemble` profile is used to bundle the [<ins>Instrumentation Rules</ins>](#45-instrumentation-rule) into [`opentracing-specialagent-1.5.9.jar`][main-release]. It builds each rule, but _does not run tests._ Once the build with the `assemble` profile is finished, the [`opentracing-specialagent-1.5.9.jar`][main-release] will contain the built rules inside it.
+1. The `assemble` profile is used to bundle the [<ins>Instrumentation Rules</ins>](#45-instrumentation-rule) into [`opentracing-specialagent-1.6.0.jar`][main-release]. It builds each rule, but _does not run tests._ Once the build with the `assemble` profile is finished, the [`opentracing-specialagent-1.6.0.jar`][main-release] will contain the built rules inside it.
 
-    _**Note**: If you do not run this step, the [`opentracing-specialagent-1.5.9.jar`][main-release] from the previous step will not contain any [<ins>Instrumentation Plugins</ins>](#44-instrumentation-plugin)!_
+    _**Note**: If you do not run this step, the [`opentracing-specialagent-1.6.0.jar`][main-release] from the previous step will not contain any [<ins>Instrumentation Plugins</ins>](#44-instrumentation-plugin)!_
 
     _**Note**: It is important to **not** run Maven's `clean` lifecycle when executing the `assemble` profile._
 
@@ -161,13 +161,13 @@ For development of [<ins>Instrumentation Plugins</ins>](#44-instrumentation-plug
 <dependency>
   <groupId>io.opentracing.contrib.specialagent</groupId>
   <artifactId>opentracing-specialagent-api</artifactId>
-  <version>1.5.9</version> <!--version>1.6.0-SNAPSHOT<version-->
+  <version>1.6.0</version> <!--version>1.6.1-SNAPSHOT<version-->
   <scope>provided</scope>
 </dependency>
 <dependency>
   <groupId>io.opentracing.contrib.specialagent</groupId>
   <artifactId>opentracing-specialagent</artifactId>
-  <version>1.5.9</version> <!--version>1.6.0-SNAPSHOT<version-->
+  <version>1.6.0</version> <!--version>1.6.1-SNAPSHOT<version-->
   <type>test-jar</type>
   <scope>test</scope>
 </dependency>
@@ -223,7 +223,7 @@ With [<ins>Static Attach</ins>](#221-static-attach), the application is executed
 Statically attaching to a Java application involves the use of the `-javaagent` vm argument at the time of startup of the target Java application. The following command can be used as an example:
 
 ```bash
-java -javaagent:opentracing-specialagent-1.5.9.jar -jar MyApp.jar
+java -javaagent:opentracing-specialagent-1.6.0.jar -jar MyApp.jar
 ```
 
 This command statically attaches [<ins>SpecialAgent</ins>](#41-specialagent) into the application in `MyApp.jar`.
@@ -242,12 +242,12 @@ Dynamically attaching to a Java application involves the use of a running applic
 1. To attach to the target `PID`:
    * For jdk1.8
      ```bash
-     java -Xbootclasspath/a:$JAVA_HOME/lib/tools.jar -jar opentracing-specialagent-1.5.9.jar <PID>
+     java -Xbootclasspath/a:$JAVA_HOME/lib/tools.jar -jar opentracing-specialagent-1.6.0.jar <PID>
      ```
 
    * For jdk9+
      ```bash
-     java -jar opentracing-specialagent-1.5.9.jar <PID>
+     java -jar opentracing-specialagent-1.6.0.jar <PID>
      ```
 
 **Note:** Properties that are provided in the command to dynamically attach will be absorbed by the target application. This applies to properties specific to SpecialAgent, such as `-Dsa.log.level=FINER`, as well as other properties such as `-Djava.util.logging.config.file=out.log`.
@@ -274,7 +274,7 @@ If the above supported application environment is detected, <ins>Static Deferred
 The following command can be used as an example:
 
 ```bash
-java -javaagent:opentracing-specialagent-1.5.9.jar -Dsa.init.defer=false -jar MySpringBootApp.jar
+java -javaagent:opentracing-specialagent-1.6.0.jar -Dsa.init.defer=false -jar MySpringBootApp.jar
 ```
 
 ## 3 Configuration
@@ -775,5 +775,5 @@ This project is licensed under the Apache 2 License - see the [LICENSE.txt](LICE
 [specialagent-pom]: https://github.com/opentracing-contrib/java-specialagent/blob/master/pom.xml
 [travis]: https://travis-ci.org/opentracing-contrib/java-specialagent
 
-[main-release]: https://repo1.maven.org/maven2/io/opentracing/contrib/specialagent/opentracing-specialagent/1.5.9/opentracing-specialagent-1.5.9.jar
-[main-snapshot]: https://oss.sonatype.org/content/repositories/snapshots/io/opentracing/contrib/specialagent/opentracing-specialagent/1.6.0-SNAPSHOT
+[main-release]: https://repo1.maven.org/maven2/io/opentracing/contrib/specialagent/opentracing-specialagent/1.6.0/opentracing-specialagent-1.6.0.jar
+[main-snapshot]: https://oss.sonatype.org/content/repositories/snapshots/io/opentracing/contrib/specialagent/opentracing-specialagent/1.6.1-SNAPSHOT

agentrule-maven-plugin/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>agentrule-maven-plugin</artifactId>
   <packaging>maven-plugin</packaging>

assemble-maven-plugin/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>assemble-maven-plugin</artifactId>
   <packaging>maven-plugin</packaging>

fingerprint/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>fingerprint</artifactId>
   <name>Fingerprint Utility for SpecialAgent</name>

itest-maven-plugin/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>itest-maven-plugin</artifactId>
   <packaging>maven-plugin</packaging>

opentracing-specialagent-api/README.md

@@ -50,7 +50,7 @@ The <ins>SpecialAgent Rule API</ins> is intended to be integrated into an OpenTr
    <dependency>
      <groupId>io.opentracing.contrib.specialagent</groupId>
      <artifactId>opentracing-specialagent-api</artifactId>
-     <version>1.5.9</version>
+     <version>1.6.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
@@ -158,7 +158,7 @@ The `AgentRunner` is available in the test jar of the <ins>SpecialAgent</ins> mo
 <dependency>
   <groupId>io.opentracing.contrib.specialagent</groupId>
   <artifactId>opentracing-specialagent</artifactId>
-  <version>1.5.9</version>
+  <version>1.6.0</version>
   <type>test-jar</type>
   <scope>test</scope>
 </dependency>
@@ -235,7 +235,7 @@ The <ins>SpecialAgent</ins> has specific requirements for packaging of <ins>Inst
       <plugin>
         <groupId>io.opentracing.contrib.specialagent</groupId>
         <artifactId>agentrule-maven-plugin</artifactId>
-        <version>1.5.9</version>
+        <version>1.6.0</version>
         <executions>
           <execution>
             <goals>

opentracing-specialagent-api/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>opentracing-specialagent-api</artifactId>
   <name>OpenTracing SpecialAgent API</name>

opentracing-specialagent-util/pom.xml

@@ -21,7 +21,7 @@
     <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>opentracing-specialagent-util</artifactId>
   <name>Utilities for SpecialAgent</name>

opentracing-specialagent/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>opentracing-specialagent</artifactId>
   <name>OpenTracing SpecialAgent</name>

pom.xml

@@ -20,7 +20,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>io.opentracing.contrib.specialagent</groupId>
   <artifactId>specialagent</artifactId>
-  <version>1.6.0-SNAPSHOT</version>
+  <version>1.6.0</version>
   <packaging>pom</packaging>
   <name>Java SpecialAgent</name>
   <description>Java Agent for OpenTracing, with automatic instrumentation</description>

rewrite/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent</groupId>
     <artifactId>specialagent</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>rewrite</artifactId>
   <name>Rewritable Tracer for SpecialAgent</name>

rule/akka-actor/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>akka-actor</artifactId>
   <name>SpecialAgent Rule for Akka Actor</name>

rule/akka-http/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>akka-http</artifactId>
   <name>SpecialAgent Rule for Akka Http</name>

rule/apache-httpclient/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>apache-httpclient</artifactId>
   <name>SpecialAgent Rule for Apache HttpClient</name>

rule/asynchttpclient/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>asynchttpclient</artifactId>
   <name>SpecialAgent Rule for AsyncHttpClient</name>

rule/aws-sdk-1/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>aws-sdk-1</artifactId>
   <name>SpecialAgent Rule for AWS SDK v1</name>

rule/aws-sdk-2/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>aws-sdk-2</artifactId>
   <name>SpecialAgent Rule for AWS SDK v2</name>

rule/camel/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>camel</artifactId>
   <name>SpecialAgent Rule for Apache Camel</name>

rule/cassandra-driver-3/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>cassandra-driver-3</artifactId>
   <name>SpecialAgent Rule for Cassandra 3 Driver</name>

rule/cassandra-driver-4/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>cassandra-driver-4</artifactId>
   <name>SpecialAgent Rule for Cassandra 4 Driver</name>

rule/concurrent/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>concurrent</artifactId>
   <name>SpecialAgent Rule for Java Concurrent API</name>

rule/couchbase-client/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>couchbase-client</artifactId>
   <name>SpecialAgent Rule for Couchbase Client</name>

rule/cxf/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>cxf</artifactId>
   <name>SpecialAgent Rule for Apache CXF</name>

rule/dynamic/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>dynamic</artifactId>
   <name>SpecialAgent Rule for Dynamic Instrumentation</name>

rule/elasticsearch-client-rest/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>elasticsearch-client-rest</artifactId>
   <name>SpecialAgent Rule for Elasticsearch Rest Client</name>

rule/elasticsearch-client-transport/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>elasticsearch-client-transport</artifactId>
   <name>SpecialAgent Rule for Elasticsearch Transport Client</name>

rule/feign/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>feign</artifactId>
   <name>SpecialAgent Rule for Feign</name>

rule/google-http-client/pom.xml

@@ -21,7 +21,7 @@
   <parent>
     <groupId>io.opentracing.contrib.specialagent.rule</groupId>
     <artifactId>rule</artifactId>
-    <version>1.6.0-SNAPSHOT</version>
+    <version>1.6.0</version>
   </parent>
   <artifactId>google-http-client</artifactId>
   <name>SpecialAgent Rule for Google Http Client</name>