vendor/github.com/go-kit/kit/tracing/README.md

   1 # package tracing
   2
   3 `package tracing` provides [Dapper][]-style request tracing to services.
   4
   5 ## Rationale
   6
   7 Request tracing is a fundamental building block for large distributed
   8 applications. It's instrumental in understanding request flows, identifying
   9 hot spots, and diagnosing errors. All microservice infrastructures will
  10 benefit from request tracing; sufficiently large infrastructures will require
  11 it.
  12
  13 ## OpenTracing
  14
  15 Go kit builds on top of the [OpenTracing] API and uses the [opentracing-go]
  16 package to provide tracing middlewares for its servers and clients. Currently
  17 `kit/transport/http` and `kit/transport/grpc` transports are supported.
  18
  19 Since [OpenTracing] is an upcoming standard API, Go kit should support a
  20 multitude of tracing backends. If a Tracer implementation in Go for your
  21 back-end exists, it should work out of the box. The following tracing back-ends
  22 are known to work with Go kit through the OpenTracing interface and are
  23 highlighted in the [addsvc] example.
  24
  25
  26 ### LightStep
  27
  28 [LightStep] support is available through their standard Go package
  29 [lightstep-tracer-go].
  30
  31 ### AppDash
  32
  33 [Appdash] support is available straight from their system repository in the
  34 [appdash/opentracing] directory.
  35
  36 ### Zipkin
  37
  38 [Zipkin] support is now available from the [zipkin-go-opentracing] package which
  39 can be found at the [Open Zipkin GitHub] page. This means our old custom
  40 `tracing/zipkin` package is now deprecated. In the `kit/tracing/zipkin`
  41 directory you can still find the `docker-compose` script to bootstrap a Zipkin
  42 development environment and a [README] detailing how to transition from the
  43 old package to the new.
  44
  45 [Dapper]: http://research.google.com/pubs/pub36356.html
  46 [addsvc]:https://github.com/go-kit/kit/tree/master/examples/addsvc
  47 [README]: https://github.com/go-kit/kit/blob/master/tracing/zipkin/README.md
  48
  49 [OpenTracing]: http://opentracing.io
  50 [opentracing-go]: https://github.com/opentracing/opentracing-go
  51
  52 [Zipkin]: http://zipkin.io/
  53 [Open Zipkin GitHub]: https://github.com/openzipkin
  54 [zipkin-go-opentracing]: https://github.com/openzipkin/zipkin-go-opentracing
  55
  56 [Appdash]: https://github.com/sourcegraph/appdash
  57 [appdash/opentracing]: https://github.com/sourcegraph/appdash/tree/master/opentracing
  58
  59 [LightStep]: http://lightstep.com/
  60 [lightstep-tracer-go]: https://github.com/lightstep/lightstep-tracer-go