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

Variable type	Description	Supported
Custom	Define a fixed list of trace IDs or other values.	Yes
Text box	Let users type a trace ID at dashboard view time.	Yes
Data source	Let users switch between Zipkin instances.	Yes
Query	Populate options from a data source query.	No

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:

Navigate to the dashboard you want to update.
Select Editing in the dashboard mode drop-down list.
Click the Add new element icon (blue plus sign).
Click Variable.
Select Textbox as the variable type.
Set the Name to traceId.
Select an option in the Display drop-down list to control where on the dashboard the variable is displayed.
(Optional) Set a default Value with a known trace ID for initial display.
Click Save.
(Optional) Enter a description of the changes you’ve made.
Click Save.
Select Viewing in the dashboard mode drop-down list.

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:

Navigate to the dashboard you want to update.
Select Editing in the dashboard mode drop-down list.
Click the Add new element icon (blue plus sign).
Click Variable.
Select Custom as the variable type.
Set the Name to traceId.
Select an option in the Display drop-down list to control where on the dashboard the variable is displayed.
Click Open variable editor to open the Custom options dialog box.
Enter trace IDs in the Values separated by comma field:
```
efe9cb8857f68c8f,463ac35c9f6413ad48485a3953bb6124
```
Click Apply.
Click Save.
(Optional) Enter a description of the changes you’ve made.
Click Save.
Select Viewing in the dashboard mode drop-down list.

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:

Navigate to the dashboard you want to update.
Select Editing in the dashboard mode drop-down list.
Click the Add new element icon (blue plus sign).
Click Variable.
Select Data source as the variable type.
Set the Name to zipkinDs.
Select an option in the Display drop-down list to control where on the dashboard the variable is displayed.
Select Zipkin as the Type.
Click Save.
(Optional) Enter a description of the changes you’ve made.
Click Save.
Select Viewing in the dashboard mode drop-down list.

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.