Skip to content

Commit

Permalink
Adds documentation for OpenCensus in tracing readme and package doc (#…
Browse files Browse the repository at this point in the history
…730)

* add package doc for opencensus tracing middleware

* add description for OpenCensus in tracing readme
  • Loading branch information
basvanbeek authored and peterbourgon committed Jul 16, 2018
1 parent 402eeb3 commit fa92d6d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
13 changes: 13 additions & 0 deletions tracing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ binding to use. Instrumentation exists for `kit/transport/http` and
`kit/transport/grpc`. The bindings are highlighted in the [addsvc] example. For
more information regarding Zipkin feel free to visit [Zipkin's Gitter].

## OpenCensus

Go kit supports transport and endpoint middlewares for the [OpenCensus]
instrumentation library. OpenCensus provides a cross language consistent data
model and instrumentation libraries for tracing and metrics. From this data
model it allows exports to various tracing and metrics backends including but
not limited to Zipkin, Prometheus, Stackdriver Trace & Monitoring, Jaeger,
AWS X-Ray and Datadog. Go kit uses the [opencensus-go] implementation to power
its middlewares.

## OpenTracing

Go kit supports the [OpenTracing] API and uses the [opentracing-go] package to
Expand Down Expand Up @@ -71,3 +81,6 @@ OpenTracing interface and are highlighted in the [addsvc] example.

[LightStep]: http://lightstep.com/
[lightstep-tracer-go]: https://github.com/lightstep/lightstep-tracer-go

[OpenCensus]: https://opencensus.io/
[opencensus-go]: https://github.com/census-instrumentation/opencensus-go
6 changes: 6 additions & 0 deletions tracing/opencensus/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Package opencensus provides Go kit integration to the OpenCensus project.
// OpenCensus is a single distribution of libraries for metrics and distributed
// tracing with minimal overhead that allows you to export data to multiple
// backends. The Go kit OpenCencus package as provided here contains middlewares
// for tracing.
package opencensus

0 comments on commit fa92d6d

Please sign in to comment.