How-To: Set up Jaeger for distributed tracing

Set up Jaeger for distributed tracing

Dapr currently supports two kind of tracing protocol: OpenCensus and Zipkin. Since Jaeger is compatible with Zipkin, the Zipkin protocol can be used to talk to Jaeger.

Configure self hosted mode

Setup

The simplest way to start Jaeger is to use the pre-built all-in-one Jaeger image published to DockerHub:

  1. docker run -d --name jaeger \
  2.   -e COLLECTOR_ZIPKIN_HTTP_PORT=9412 \
  3.   -p 16686:16686 \
  4.   -p 9412:9412 \
  5.   jaegertracing/all-in-one:1.21

Next, create the following YAML files locally:

  • config.yaml: Note that because we are using the Zipkin protocol to talk to Jaeger, we specify the zipkin section of tracing configuration set the endpointAddress to address of the Jaeger instance.
  1. apiVersion: dapr.io/v1alpha1
  2. kind: Configuration
  3. metadata:
  4.   name: tracing
  5.   namespace: default
  6. spec:
  7.   tracing:
  8.     samplingRate: "1"
  9.     zipkin:
  10.       endpointAddress: "http://localhost:9412/api/v2/spans"

To launch the application referring to the new YAML file, you can use --config option:

  1. dapr run --app-id mynode --app-port 3000 node app.js --config config.yaml

Viewing Traces

To view traces, in your browser go to http://localhost:16686 and you will see the Zipkin UI.

Configure Kubernetes

The following steps shows you how to configure Dapr to send distributed tracing data to Jaeger running as a container in your Kubernetes cluster, how to view them.

Setup

First create the following YAML file to install Jaeger

  • jaeger-operator.yaml
  1. apiVersion: jaegertracing.io/v1
  2. kind: "Jaeger"
  3. metadata:
  4.   name: "jaeger"
  5. spec:
  6.   strategy: allInOne
  7.   ingress:
  8.     enabled: false
  9.   allInOne:
  10.     image: jaegertracing/all-in-one:1.13
  11.     options:
  12.       query:
  13.         base-path: /jaeger

Now, use the above YAML file to install Jaeger

  1. # Install Jaeger
  2. helm repo add jaegertracing https://jaegertracing.github.io/helm-charts
  3. helm install jaeger-operator jaegertracing/jaeger-operator
  4. kubectl apply -f jaeger-operator.yaml
  6. # Wait for Jaeger to be up and running
  7. kubectl wait deploy --selector app.kubernetes.io/name=jaeger --for=condition=available

Next, create the following YAML file locally:

  • tracing.yaml
  1. apiVersion: dapr.io/v1alpha1
  2. kind: Configuration
  3. metadata:
  4.   name: tracing
  5.   namespace: default
  6. spec:
  7.   tracing:
  8.     samplingRate: "1"
  9.     zipkin:
  10.       endpointAddress: "http://jaeger-collector.default.svc.cluster.local:9411/api/v2/spans"

Finally, deploy the the Dapr component and configuration files:

  1. kubectl apply -f tracing.yaml

In order to enable this configuration for your Dapr sidecar, add the following annotation to your pod spec template:

  1. annotations:
  2.   dapr.io/config: "tracing"

That’s it! your sidecar is now configured for use with Jaeger.

Viewing Tracing Data

To view traces, connect to the Jaeger Service and open the UI:

  1. kubectl port-forward svc/jaeger-query 16686

In your browser, go to http://localhost:16686 and you will see the Jaeger UI.

jaeger

References

Last modified February 16, 2021: Merge pull request #1235 from dapr/update-v0.11 (b4e9fbb)