3.3 KiB

Raw Blame History

Set up Zipkin for distributed tracing

Configure self hosted mode
Configure Kubernetes
Tracing configuration

Configure self hosted mode

For self hosted mode, create a Dapr configuration file locally and reference it with the Dapr CLI.

Create the following YAML files:

zipkin.yaml

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: zipkin
spec:
  type: exporters.zipkin
  metadata:
  - name: enabled
    value: "true"
  - name: exporterAddress
    value: "http://localhost:9411/api/v2/spans"

tracing.yaml

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
  name: tracing
spec:
  tracing:
    enabled: true
    expandParams: true
    includeBody: true

Copy zipkin.yaml to a /components subfolder under the same folder where you run your application.
Launch Zipkin using Docker:

docker run -d -p 9411:9411 openzipkin/zipkin

Launch your application with Dapr CLI using the --config param:

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

Viewing Traces

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

Configure Kubernetes

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

Setup

First, deploy Zipkin:

kubectl run zipkin --image openzipkin/zipkin --port 9411

Create a Kubernetes service for the Zipkin pod:

kubectl expose deploy zipkin --type ClusterIP --port 9411

Next, create the following YAML files locally:

zipkin.yaml component

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: zipkin
spec:
  type: exporters.zipkin
  metadata:
  - name: enabled
    value: "true"
  - name: exporterAddress
    value: "http://zipkin.default.svc.cluster.local:9411/api/v2/spans"

tracing.yaml configuration

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
  name: tracing
spec:
  tracing:
    enabled: true
    expandParams: true
    includeBody: true

Finally, deploy the the Dapr component and configuration files:

kubectl apply -f tracing.yaml
kubectl apply -f zipkin.yaml

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

annotations:
  dapr.io/config: "tracing"

That's it! your sidecar is now configured for use with Open Census and Zipkin.

Viewing Tracing Data

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

kubectl port-forward svc/zipkin 9411:9411

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

Tracing configuration

The tracing section under the Configuration spec contains the following properties:

tracing:
    enabled: true
    expandParams: true
    includeBody: true

The following table lists the different properties.

Property	Type	Description
enabled	bool	Set tracing to be enabled or disabled
expandParams	bool	When true, expands parameters passed to HTTP endpoints
includeBody	bool	When true, includes the request body in the tracing event

3.3 KiB Raw Blame History