Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds documentation for OpenCensus in tracing readme and package doc #730

Merged
merged 2 commits into from
Jul 16, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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