Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation Data sources Zipkin Template variables

Zipkin template variables

Use template variables to create dynamic, reusable dashboards. Instead of hard-coding trace IDs, you can use variables to let dashboard viewers select or input trace IDs at view time, making it easier to share dashboards across teams.

For an introduction to Grafana template variables, refer to Variables.

Supported variable types

The Zipkin data source doesn’t support query-based variables, but you can use custom or text box variables to parameterize trace ID queries.

Create a text box variable

A text box variable lets dashboard viewers enter a trace ID directly. This is the most common variable type for Zipkin.

To create a text box variable:

1. Navigate to Dashboard settings > Variables.
2. Click Add variable.
3. Select Textbox as the variable type.
4. Set the Name to traceId.
5. Optionally, set a Default value with a known trace ID for initial display.
6. Click Apply.

The dashboard displays a text input where viewers can paste a trace ID.

Create a custom variable

A custom variable provides a predefined list of values. This is useful when you want to give viewers a set of known trace IDs to choose from.

To create a custom variable:

1. Navigate to Dashboard settings > Variables.

2. Click Add variable.

3. Select Custom as the variable type.

4. Set the Name to traceId.

5. Enter trace IDs in the Values separated by comma field:

   Copy

   efe9cb8857f68c8f,463ac35c9f6413ad48485a3953bb6124

6. Click Apply.

The dashboard displays a drop-down where viewers can select from the predefined trace IDs.

Create a data source variable

A data source variable lets viewers switch between multiple Zipkin instances. This is useful when you have separate Zipkin deployments for different environments.

To create a data source variable:

1. Navigate to Dashboard settings > Variables.
2. Click Add variable.
3. Select Data source as the variable type.
4. Set the Name to zipkinDs.
5. Select Zipkin as the Type.
6. Click Apply.

Then, in your panel’s query editor, select ${zipkinDs} as the data source instead of a specific Zipkin instance.

Use variables in queries

You can use template variables in the Trace ID field of the query editor. Grafana replaces the variable with its current value when the query runs.

For example, if you create a text box variable named traceId, enter ${traceId} in the trace ID field. When the viewer enters a new trace ID, the query automatically runs with the new value.

For more information about variable syntax, refer to Variable syntax.

Troubleshoot template variable issues

If template variables aren’t working as expected, refer to Troubleshoot Zipkin data source issues.