News New Look, Same Vision: KrakenD’s Website Redesign

Enterprise v2.5 Documentation

You are viewing a previous version of KrakenD Enterprise Edition (v2.5), go to the latest version

Document updated on Oct 24, 2022

Zipkin Telemetry Integration

Zipkin is a distributed tracing system. It helps gather timing data needed to troubleshoot latency problems in service architectures.

The Opencensus exporter allows you export data to Zipkin. Enabling it only requires you to add the zipkin exporter in the opencensus module.

The following configuration snippet sends data to your Zipkin:

{
  "version": 3,
  "extra_config": {
    "telemetry/opencensus": {
      "sample_rate": 100,
      "reporting_period": 0,
      "exporters": {
        "zipkin": {
          "collector_url": "http://192.168.99.100:9411/api/v2/spans",
          "service_name": "krakend"
        }
      }
    }
  }
}

As with all OpenCensus exporters, you can add optional settings in the telemetry/opencensus level:

Fields of "telemetry/opencensus"
* required fields

enabled_layers
Lets you specify what data you want to export. All layers are enabled by default unless you declare this section.
backend boolean
Reports the activity between KrakenD and your services
Defaults to false
pipe boolean
Reports the activity at the beginning of the proxy layer. It gives a more detailed view of the internals of the pipe between end-users and KrakenD, having into account merging of different backends.
Defaults to false
router boolean
Reports the activity between end-users and KrakenD
Defaults to false
reporting_period integer
The number of seconds passing between reports. If duration is less than or equal to zero, it enables the default behavior of each exporter.
Defaults to 0
sample_rate integer
A number between 0 (no requests at all) and 100 (all requests) representing the percentage of sampled requests you want to send to the exporter. Sampling the 100% of the requests is generally discouraged when the relationship between traffic and dedicated resources is sparse.
Defaults to 0
Schema: https://www.krakend.io/schema/v2.5/telemetry/opencensus.json

Then, the exporters key must contain an zipkin entry with the following properties:

Fields of "telemetry/opencensus": { "exporters":{} }
* required fields

zipkin object
Export telemetry data to a Zipkin collector
collector_url string
The URL (including port and path) where your Zipkin is accepting the spans, e.g., http://zipkin:9411/api/v2/spans
Example: "http://192.168.99.100:9411/api/v2/spans"
service_name string
The service name registered in Zipkin.
Example: "krakend"
Schema: https://www.krakend.io/schema/v2.5/telemetry/opencensus.json
Scarf

Unresolved issues?

The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.

See all support channels