forked from openzipkin/brave
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reworks README and archives old libraries (openzipkin#403)
- Loading branch information
1 parent
9d1207d
commit 14fb86b
Showing
332 changed files
with
148 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.