Reworks README and archives old libraries (#403)

README.md

@@ -1,36 +1,55 @@
-# brave #
-
 [![Build Status](https://circleci.com/gh/openzipkin/brave.svg?style=svg)](https://circleci.com/gh/openzipkin/brave)
 [![Maven Central](https://img.shields.io/maven-central/v/io.zipkin.brave/brave.svg)](https://maven-badges.herokuapp.com/maven-central/io.zipkin.brave/brave)
+[![Gitter chat](http://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/openzipkin/zipkin)
 
-Java Distributed Tracing implementation compatible with [Zipkin](http://zipkin.io).
-
-Zipkin is based on [Dapper](http://research.google.com/pubs/pub36356.html).
+# Brave
+Brave is a library used to capture latency information about distributed
+operations. It reports this data to [Zipkin](http://zipkin.io) as spans.
 
-dapper (dutch) = brave (english)... so that's where the name comes from.
+Zipkin is based on [Dapper](http://research.google.com/pubs/pub36356.html). Dapper (dutch) = Brave (english)... So, that's where the name comes from.
 
-## introduction ##
+## What's included
 
-More information on Distributed Tracing and OpenZipkin here: <https://openzipkin.github.io>
+Most users won't write tracing code directly. Rather, they reuse instrumentation
+code  others have written. Check for [instrumentation written here](instrumentation/) and [Zipkin's list](http://zipkin.io/pages/existing_instrumentations.html)
+before rolling your own. Common tracing libraries like JDBC, Servlet
+and Spring already exist. Instrumentation written here are tested and
+benchmarked.
 
-You can use brave if you use the JVM and:
+You can look at our [example project](https://github.com/openzipkin/brave-webmvc-example) for how to trace a simple web application.
 
-*   You can't use [Finagle](https://github.com/twitter/finagle).
-*   You don't want to add Scala as a dependency to your Java project.
-*   You want out of the box integration support for [RESTEasy](http://resteasy.jboss.org), [Jersey](https://jersey.java.net), [Apache HttpClient](http://hc.apache.org/httpcomponents-client-4.3.x/index.html).
+If you are trying to trace legacy applications, you may be interested in
+[Spring XML Configuration](brave-spring-beans/). This allows you to setup
+tracing without any custom code.
 
-Brave is compatible with OpenZipkin backends such as [zipkin-server](https://github.com/openzipkin/zipkin/blob/master/zipkin-server/README.md)
+You may want to put trace IDs into your log files, or change thread local
+behavior. Look at our [context libraries](context/), for integration with
+tools such as SLF4J.
 
-A deep dive on Brave's api can be found [here](brave/README.md)
+Brave's dependency-free [tracer library](brave/) works against JRE6+.
+This is the underlying api that instrumentation use to time operations
+and add tags that describe them. This library also includes code that
+parses `X-B3-TraceId` headers.
 
-## Maven artifacts ##
+## Writing new instrumentation
+We worked very hard to make writing new instrumentation easy and efficient.
+Most of our built-in instrumentation are 50-100 lines of code, yet allow
+flexible configuration of tags and sampling policy.
 
-Maven artifacts for each release are published to Maven Central. 
+If you need to write new http instrumentation, check [our docs](instrumentation/README.md),
+as this shows how to write it in a way that is least effort for you and
+easy for others to configure. For example, we have a standard [test suite](instrumentation/http-tests)
+you can use to make sure things interop, and standard configuration works.
 
-## Changelog ##
+If you need to do something not http, you'll want to use our [tracer library](brave/README.md).
+If you are in this position, you may find our [feature tests](brave/src/test/java/brave/features)
+helpful.
 
-For an overview of the available releases see [Github releases](https://github.com/kristofa/brave/releases).
-As of release 2.0 we try to stick to [Semantic Versioning](http://semver.org).
+Regardless, you may need support along the way. Please reach out on [gitter](https://gitter.im/openzipkin/zipkin),
+as there's usually others around to help.
 
-Brave was redesigned starting with version 4. Please see the
-[README](brave/README.md) for details on how to use Brave's Tracer.
+## Artifacts
+### Library Releases
+Releases are uploaded to [Bintray](https://bintray.com/openzipkin/maven/brave) and synchronized to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.zipkin.brave%22)
+### Library Snapshots
+Snapshots are uploaded to [JFrog](http://oss.jfrog.org/artifactory/oss-snapshot-local) after commits to master.

archive/README.md

@@ -0,0 +1,36 @@
+# brave #
+
+[![Build Status](https://circleci.com/gh/openzipkin/brave.svg?style=svg)](https://circleci.com/gh/openzipkin/brave)
+[![Maven Central](https://img.shields.io/maven-central/v/io.zipkin.brave/brave.svg)](https://maven-badges.herokuapp.com/maven-central/io.zipkin.brave/brave)
+
+Java Distributed Tracing implementation compatible with [Zipkin](http://zipkin.io).
+
+Zipkin is based on [Dapper](http://research.google.com/pubs/pub36356.html).
+
+dapper (dutch) = brave (english)... so that's where the name comes from.
+
+## introduction ##
+
+More information on Distributed Tracing and OpenZipkin here: <https://openzipkin.github.io>
+
+You can use brave if you use the JVM and:
+
+*   You can't use [Finagle](https://github.com/twitter/finagle).
+*   You don't want to add Scala as a dependency to your Java project.
+*   You want out of the box integration support for [RESTEasy](http://resteasy.jboss.org), [Jersey](https://jersey.java.net), [Apache HttpClient](http://hc.apache.org/httpcomponents-client-4.3.x/index.html).
+
+Brave is compatible with OpenZipkin backends such as [zipkin-server](https://github.com/openzipkin/zipkin/blob/master/zipkin-server/README.md)
+
+A deep dive on Brave's api can be found [here](brave/README.md)
+
+## Maven artifacts ##
+
+Maven artifacts for each release are published to Maven Central. 
+
+## Changelog ##
+
+For an overview of the available releases see [Github releases](https://github.com/kristofa/brave/releases).
+As of release 2.0 we try to stick to [Semantic Versioning](http://semver.org).
+
+Brave was redesigned starting with version 4. Please see the
+[README](brave/README.md) for details on how to use Brave's Tracer.

brave-apache-http-interceptors/pom.xml → archive/brave-apache-http-interceptors/pom.xml

@@ -7,13 +7,13 @@
     <version>4.3.0-SNAPSHOT</version>
   </parent>
   <artifactId>brave-apache-http-interceptors</artifactId>
-  <name>brave-apache-http-interceptors</name>
+  <name>archive/brave-apache-http-interceptors</name>
   <description>
     Apache http client request and response interceptor implementations.
   </description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
   </properties>
   <dependencies>
     <dependency>

brave-benchmarks/pom.xml → archive/brave-benchmarks/pom.xml

@@ -7,11 +7,11 @@
   </parent>
 
   <artifactId>brave-benchmarks</artifactId>
-  <name>Brave benchmarks</name>
+  <name>archive/Brave benchmarks</name>
   <description>Brave benchmarks (JMH)</description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
   </properties>
 
   <dependencies>

brave-core-spring/pom.xml → archive/brave-core-spring/pom.xml

@@ -9,14 +9,14 @@
 
   <artifactId>brave-core-spring</artifactId>
   <packaging>jar</packaging>
-  <name>brave-core-spring</name>
+  <name>archive/brave-core-spring</name>
   <description>
     Spring Configuration and helper classes for using brave-core with Spring as dependency injection 
     framework.
   </description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
   </properties>
   <dependencies>
      <dependency>

brave-core/pom.xml → archive/brave-core/pom.xml

@@ -9,11 +9,11 @@
   <artifactId>brave-core</artifactId>
   <packaging>jar</packaging>
 
-  <name>brave-core</name>
+  <name>archive/brave-core</name>
   <description>Brave core.</description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
     <main.java.version>1.6</main.java.version>
     <main.signature.artifact>java16</main.signature.artifact>
   </properties>

brave-grpc/pom.xml → archive/brave-grpc/pom.xml

@@ -8,13 +8,13 @@
     </parent>
     <artifactId>brave-grpc</artifactId>
     <packaging>jar</packaging>
-    <name>brave-grpc</name>
+    <name>archive/brave-grpc</name>
     <description>
         gRPC integration that uses the brave api to submit client and server side span information.
     </description>
 
     <properties>
-        <main.basedir>${project.basedir}/..</main.basedir>
+        <main.basedir>${project.basedir}/../..</main.basedir>
         <protobuf.version>3.0.2</protobuf.version>
     </properties>
 

brave-http-tests/pom.xml → archive/brave-http-tests/pom.xml

@@ -8,11 +8,11 @@
   </parent>
   <artifactId>brave-http-tests</artifactId>
   <packaging>jar</packaging>
-  <name>brave-http-tests</name>
+  <name>archive/brave-http-tests</name>
   <description>Brave JUnit integration tests</description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
     <main.java.version>1.8</main.java.version>
     <main.signature.artifact>java18</main.signature.artifact>
   </properties>

brave-http/pom.xml → archive/brave-http/pom.xml

@@ -9,13 +9,13 @@
     <artifactId>brave-http</artifactId>
     <packaging>jar</packaging>
 
-    <name>brave-http</name>
+    <name>archive/brave-http</name>
     <description>
         Abstraction that makes it easier to implement brave in http clients and servers.
     </description>
 
     <properties>
-        <main.basedir>${project.basedir}/..</main.basedir>
+        <main.basedir>${project.basedir}/../..</main.basedir>
         <main.java.version>1.6</main.java.version>
         <main.signature.artifact>java16</main.signature.artifact>
     </properties>

brave-jaxrs2/pom.xml → archive/brave-jaxrs2/pom.xml

@@ -8,13 +8,13 @@
     </parent>
     <artifactId>brave-jaxrs2</artifactId>
     <packaging>jar</packaging>
-    <name>brave-jaxrs2</name>
+    <name>archive/brave-jaxrs2</name>
     <description>
         Jersey 2.x integration that uses the brave api to submit client and server side span information.
     </description>
 
     <properties>
-        <main.basedir>${project.basedir}/..</main.basedir>
+        <main.basedir>${project.basedir}/../..</main.basedir>
     </properties>
 
     <dependencies>

brave-jersey/pom.xml → archive/brave-jersey/pom.xml

@@ -8,13 +8,13 @@
     </parent>
    <artifactId>brave-jersey</artifactId>
    <packaging>jar</packaging>
-   <name>brave-jersey</name>
+   <name>archive/brave-jersey</name>
   <description>
     Jersey integration that uses the brave api to submit client and server side span information.
   </description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
     <!-- indirectly depends on servlet 3.0.1 -->
     <jersey.version>1.19.3</jersey.version>
   </properties>

brave-jersey2/pom.xml → archive/brave-jersey2/pom.xml

@@ -8,13 +8,13 @@
     </parent>
     <artifactId>brave-jersey2</artifactId>
     <packaging>jar</packaging>
-    <name>brave-jersey2</name>
+    <name>archive/brave-jersey2</name>
     <description>
         Jersey 2.x integration that uses the brave api to submit client and server side span information.
     </description>
 
     <properties>
-        <main.basedir>${project.basedir}/..</main.basedir>
+        <main.basedir>${project.basedir}/../..</main.basedir>
         <!-- indirectly depends on servlet 3.0.1 -->
         <jersey.version>2.25.1</jersey.version>
     </properties>

brave-mysql/pom.xml → archive/brave-mysql/pom.xml

@@ -8,13 +8,13 @@
     </parent>
    <artifactId>brave-mysql</artifactId>
    <packaging>jar</packaging>
-   <name>brave-mysql</name>
+   <name>archive/brave-mysql</name>
   <description>
     MySQL integration that uses the brave api to submit client span information.
   </description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
   </properties>
 
     <dependencies>

brave-okhttp/pom.xml → archive/brave-okhttp/pom.xml

@@ -8,11 +8,12 @@
   <modelVersion>4.0.0</modelVersion>
 
   <artifactId>brave-okhttp</artifactId>
+  <name>archive/brave-okhttp</name>
 
   <description>OkHttp tracing interceptor implementation</description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
   </properties>
 
   <dependencies>

brave-p6spy/pom.xml → archive/brave-p6spy/pom.xml

@@ -8,13 +8,13 @@
     </parent>
     <artifactId>brave-p6spy</artifactId>
     <packaging>jar</packaging>
-    <name>brave-p6spy</name>
+    <name>archive/brave-p6spy</name>
     <description>
         p6spy integration for brave
     </description>
 
     <properties>
-        <main.basedir>${project.basedir}/..</main.basedir>
+        <main.basedir>${project.basedir}/../..</main.basedir>
         <p6spy.version>3.0.0</p6spy.version>
         <derby.version>10.13.1.1</derby.version>
         <!-- Tests fail on connect exception using latest liquibase -->

brave-resteasy-spring/pom.xml → archive/brave-resteasy-spring/pom.xml

@@ -9,13 +9,13 @@
   <artifactId>brave-resteasy-spring</artifactId>
   <packaging>jar</packaging>
 
-  <name>brave-resteasy-spring</name>
+  <name>archive/brave-resteasy-spring</name>
   <description>
     RestEasy client and server side interceptors that use the brave api to submit client and server side span information.
   </description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
     <!-- 2.3.10.Final has an unpublished dependency. This is the version prior to that -->
     <!-- indirectly depends on servlet 2.5 -->
     <resteasy.version>2.3.7.Final</resteasy.version>

brave-resteasy3-spring/pom.xml → archive/brave-resteasy3-spring/pom.xml

@@ -9,13 +9,13 @@
   <artifactId>brave-resteasy3-spring</artifactId>
   <packaging>jar</packaging>
 
-  <name>brave-resteasy3-spring</name>
+  <name>archive/brave-resteasy3-spring</name>
   <description>
     RestEasy client and server side interceptors that use the brave api to submit client and server side span information.
   </description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
     <spring.version>${spring4.version}</spring.version>
   </properties>
 

brave-sampler-zookeeper/pom.xml → archive/brave-sampler-zookeeper/pom.xml

@@ -9,13 +9,13 @@
 
   <artifactId>brave-sampler-zookeeper</artifactId>
   <packaging>jar</packaging>
-  <name>brave-sampler-zookeeper</name>
+  <name>archive/brave-sampler-zookeeper</name>
   <description>
     Contains ZooKeeperSampler which gets receives its sample rate from ZooKeeper.
   </description>
 
   <properties>
-    <main.basedir>${project.basedir}/..</main.basedir>
+    <main.basedir>${project.basedir}/../..</main.basedir>
   </properties>
 
   <dependencies>

brave-spancollector-http/pom.xml → archive/brave-spancollector-http/pom.xml

@@ -10,11 +10,11 @@
     <artifactId>brave-spancollector-http</artifactId>
     <packaging>jar</packaging>
 
-    <name>brave-spancollector-http</name>
+    <name>archive/brave-spancollector-http</name>
     <description>Brave SpanCollector that submits spans to zipkins http endpoint</description>
 
     <properties>
-        <main.basedir>${project.basedir}/..</main.basedir>
+        <main.basedir>${project.basedir}/../..</main.basedir>
     </properties>
 
     <dependencies>

brave-spancollector-kafka/pom.xml → archive/brave-spancollector-kafka/pom.xml

@@ -10,11 +10,11 @@
     <artifactId>brave-spancollector-kafka</artifactId>
     <packaging>jar</packaging>
 
-    <name>brave-spancollector-kafka</name>
+    <name>archive/brave-spancollector-kafka</name>
     <description>Brave SpanCollector that submits spans to Kafka</description>
 
     <properties>
-        <main.basedir>${project.basedir}/..</main.basedir>
+        <main.basedir>${project.basedir}/../..</main.basedir>
         <!-- This is pinned to Kafka 0.8.x client as 0.9.x brokers work with them, but not visa-versa
              http://docs.confluent.io/2.0.0/upgrade.html -->
         <kafka.version>0.8.2.2</kafka.version>