diff --git a/tracing/README.md b/tracing/README.md index 0eb311b..508b96c 100644 --- a/tracing/README.md +++ b/tracing/README.md @@ -19,6 +19,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 @@ -71,3 +81,6 @@ [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 diff --git a/tracing/opencensus/doc.go b/tracing/opencensus/doc.go new file mode 100644 index 0000000..31dc98a --- /dev/null +++ b/tracing/opencensus/doc.go @@ -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