ballerinax/zipkin Ballerina library

Package Overview

The Zipkin Observability Extension is one of the tracing extensions of the Ballerina language.

It provides an implementation for tracing and publishing traces to a Zipkin Agent.

Enabling Zipkin Extension

To package the Zipkin extension into the Jar, follow the following steps.

1. Add the following import to your program.

import ballerinax/zipkin as _;

2. Add the following to the Ballerina.toml when building your program.

[package]
org = "my_org"
name = "my_package"
version = "1.0.0"

[build-options]
observabilityIncluded=true

To enable the extension and publish traces to Zipkin, add the following to the Config.toml when running your program.

[ballerina.observe]
tracingEnabled=true
tracingProvider="zipkin"

[ballerinax.zipkin]
reporterEndpoint="<TRACE_API>"  # Optional Configuration. This will override the values of agentHostname & agentPort.
agentHostname="127.0.0.1"  # Optional Configuration. Default value is localhost
agentPort=9411             # Optional Configuration. Default value is 9411

Note

• If the reporterEndpoint is provided, the agentHostname and agentPort will be ignored.
• If you want to pass a token for the reporter endpoint, configure the token as the environment variable TRACE_API_TOKEN and pass it to the reporterEndpoint as follows.

[ballerinax.zipkin]
reporterEndpoint="<TRACE_API>?<TRACE_API_TOKEN_KEY>=$TRACE_API_TOKEN"