From ef2e371d27be2ddb42323ea9e72f943779e15ccc Mon Sep 17 00:00:00 2001 From: Bas van Beek Date: Mon, 16 Jul 2018 16:35:35 +0200 Subject: [PATCH 1/2] add package doc for opencensus tracing middleware --- tracing/opencensus/doc.go | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 tracing/opencensus/doc.go diff --git a/tracing/opencensus/doc.go b/tracing/opencensus/doc.go new file mode 100644 index 000000000..31dc98aec --- /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 From 806586e0cb0e60151385354405b03333826b3acd Mon Sep 17 00:00:00 2001 From: Bas van Beek Date: Mon, 16 Jul 2018 16:46:01 +0200 Subject: [PATCH 2/2] add description for OpenCensus in tracing readme --- tracing/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/tracing/README.md b/tracing/README.md index 0eb311b4f..508b96c38 100644 --- a/tracing/README.md +++ b/tracing/README.md @@ -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 @@ -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