linkerd-zipkin
linkerd-zipkin copied to clipboard
linkerd telemeter plugins for writing trace data to zipkin
linkerd-zipkin
This repo contains linkerd telemeters for writing tracing data to Zipkin, using linkerd's plugin interface and Zipkin's finagle-zipkin library.
Building
Plugin jar
To build a plugin jar, run:
$ ./sbt assembly
That will build a linkerd-zipkin plugin jar in plugins/
. Put that jar in
linkerd's class path to make the telemeters available. Further information on
installing plugins is available in the linkerd
plugin documentation.
Docker
If you're using Docker, this repo provides a Dockerfile that you can use to layer in the plugin jar on top of the linkerd base image. To build, run:
$ ./sbt assembly
$ docker build -t linkerd-zipkin:latest .
That will build a docker image called linkerd-zipkin:latest
, which runs
linkerd and autoloads the telemeters from this repo. You can tag that image
as needed and push to your own docker repo for deployment.
Usage
Two telemeters are provided, for writing to Zipkin with different transports.
io.zipkin.http
This telemeter writes tracing data to zipkin over HTTP. Sample configuration:
telemetry:
- kind: io.zipkin.http
host: localhost:9411
initialSampleRate: 0.02
Available configuration options for this telemeter:
Option | Default | Description |
---|---|---|
host |
localhost:9411 | The network location of the Zipkin http service. |
hostHeader |
zipkin | The Host header used when sending spans to Zipkin |
compressionEnabled |
true | True implies that spans will be gzipped before transport |
initialSampleRate |
0.001 (0.1%) | Percentage of traces to sample in the range [0.0 - 1.0] |
io.zipkin.kafka
This telemeter writes tracing data to zipkin using Kafka. Sample configuration:
telemetry:
- kind: io.zipkin.kafka
bootstrapServers: localhost:9092
initialSampleRate: 0.02
Available configuration options for this telemeter:
Option | Default | Description |
---|---|---|
bootstrapServers |
localhost:9092 | Initial set of kafka servers to connect to (comma separated) |
topic |
zipkin | Kafka topic zipkin traces will be sent to |
initialSampleRate |
0.001 (0.1%) | Percentage of traces to sample in the range [0.0 - 1.0] |