Skip to content

Commit

Permalink
Clean up several pages
Browse files Browse the repository at this point in the history
No big changes here, just housecleaning
  • Loading branch information
bhs committed Dec 25, 2016
1 parent 2a08236 commit 565b907
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 26 deletions.
2 changes: 1 addition & 1 deletion _docs/pages/authors-and-contributors.md
@@ -1,6 +1,6 @@
# Authors and Contributors

(in alphabetical order)
Incomplete, outdated, and in alphabetical order :)

* @adriancole (Adrian Cole)
* @bcronin (Ben Cronin)
Expand Down
6 changes: 3 additions & 3 deletions _docs/pages/instrumentation/instrumenting-large-systems.md
Expand Up @@ -6,15 +6,15 @@ _Before getting onto recommendations on how to instrument your large-scale syste

The two fundamental aspects of implementing OpenTracing across your infrastructure are _Spans_ and the _Relationships_ between those spans:

* **_[Span](/pages/spec#spans)_** is a logical unit of work in the system that has a start time and a duration. In a trace Spans are associated with the components of the system as they are exercised on a specified path.
* **_[Spans](/pages/spec#spans)_** are logical units of work in a distributed system, and by definition they all have a name, a start time, and a duration. In a trace, Spans are associated with the distributed system component that generated them.

![image of spans in a system](/images/OTHT_0.png)

* **_[Relationships](/pages/spec/#causal-span-references)_** are the connections between Spans. A Span may reference zero or more Spans that are causally related. This allows for the spans to be connected and help identify the critical path of a trace.
* **_[Relationships](/pages/spec/#causal-span-references)_** are the connections between Spans. A Span may reference zero or more other Spans that are causally related. These connections between Spans help describe the semantics of the running system, as well as the critical path for latency-sensitive (distributed) transactions.

![image of relationships in a system](/images/OTHT_1.png)

Your desired end state is to get Spans for all or your code components as well as the relationships between those Spans. When starting to build out your infrastructure with distributed tracing the best practice is to start with service frameworks (i.e. RPC layer) or other components known to have broad interaction with multiple execution paths.
Your desired end state is to emit Spans for all or your code components along with the relationships between those Spans. When starting to build out your infrastructure with distributed tracing, the best practice is to start with service frameworks (e.g., an RPC layer) or other components known to have broad interaction with multiple execution paths.

By using a service framework that is instrumented with OpenTracing ([gRPC](https://github.com/grpc/grpc-go), etc.) you can get a head start on this effort. However, if you are working with a non-instrumented framework you can get some assistance with this part by reading the [IPC/RPC Framework Guide](/pages/instrumentation/instrumenting-frameworks).

Expand Down
24 changes: 4 additions & 20 deletions _docs/pages/supported-tracers.md
Expand Up @@ -6,30 +6,12 @@

## Jaeger

[Jaeger \ˈyā-gər\](http://uber.github.io/jaeger) is Uber's distributed tracing system, built with OpenTracing support from inception. Jaeger includes OpenTracing client libraries in several languages: [Java](https://github.com/uber/jaeger-client-java), [Go](https://github.com/uber/jaeger-client-go), [Python](https://github.com/uber/jaeger-client-python), and [Node.js](https://github.com/uber/jaeger-client-node).
[Jaeger \ˈyā-gər\ˈ](http://uber.github.io/jaeger) is Uber's distributed tracing system, built with OpenTracing support from inception. Jaeger includes OpenTracing client libraries in several languages: [Java](https://github.com/uber/jaeger-client-java), [Go](https://github.com/uber/jaeger-client-go), [Python](https://github.com/uber/jaeger-client-python), and [Node.js](https://github.com/uber/jaeger-client-node).


## Appdash

Appdash ([background reading](https://sourcegraph.com/blog/announcing-appdash-an-open-source-perf-tracing/)) is a lightweight, Golang-based distributed tracing system, originally developed and since open-sourced by [sourcegraph](https://sourcegraph.com/). There is an OpenTracing-compatible `Tracer` implementation that uses Appdash as a backend; binding Appdash to OpenTracing instrumentation is trivial:

```go
import (
"github.com/sourcegraph/appdash"
appdashtracer "github.com/sourcegraph/appdash/opentracing"
)

func main() {
// Initialization with a local collector:
collector := appdash.NewLocalCollector(myAppdashStore)
chunkedCollector := appdash.NewChunkedCollector(collector)
tracer := appdashtracer.NewTracer(chunkedCollector)

// Initialization with a remote collector:
collector := appdash.NewRemoteCollector("localhost:8700")
tracer := appdashtracer.NewTracer(collector)
}
```
Appdash ([background reading](https://sourcegraph.com/blog/announcing-appdash-an-open-source-perf-tracing/)) is a lightweight, Golang-based distributed tracing system, originally developed and since open-sourced by [sourcegraph](https://sourcegraph.com/). There is an OpenTracing-compatible `Tracer` implementation that uses Appdash as a backend.

For more details, read [the godocs](https://godoc.org/github.com/sourcegraph/appdash/opentracing).

Expand All @@ -38,10 +20,12 @@ For more details, read [the godocs](https://godoc.org/github.com/sourcegraph/app

[LightStep](http://lightstep.com/) runs a private beta with OpenTracing-native tracers in production environments. There are OpenTracing-compatible [LightStep Tracers](https://github.com/lightstep) available for Go, Python, Javascript, Objective-C, Java, PHP, Ruby, and C++.


## Hawkular

[Hawkular APM](http://www.hawkular.org/hawkular-apm/) supports OpenTracing-Java and has plans to support other platforms in the near future.


## Instana

[Instana](https://www.instana.com) provides an APM solution supporting OpenTracing in [Java](https://github.com/instana/instana-java-opentracing/blob/master/README.md), [Node.js](https://github.com/instana/nodejs-sensor/blob/master/README.md#opentracing) and [Go](https://github.com/instana/golang-sensor/blob/master/README.md). The Instana OpenTracing tracers are interoperable with the other Instana out of the box tracers for Java, Scala, NodeJs, PHP and Ruby.
2 changes: 0 additions & 2 deletions _docs/pages/translations.md
@@ -1,5 +1,3 @@
# Choose your translation

(in alphabetical order)

* [Simplified Chinese, 简体中文 🇨🇳](https://wu-sheng.gitbooks.io/opentracing-io/content/), [**Download**](https://www.gitbook.com/download/pdf/book/wu-sheng/opentracing-io), by [吴晟 @wu-sheng](https://github.com/wu-sheng) , updated Nov. 2016

0 comments on commit 565b907

Please sign in to comment.