Menu
Grafana Cloud

Write TraceQL queries with the editor

Inspired by PromQL and LogQL, TraceQL is a query language designed for selecting traces. TraceQL provides a method for formulating precise queries so you can zoom in to the data you need. Query results are returned faster because the queries limit what is searched.

To learn more about how to query by TraceQL, refer to the TraceQL documentation.

The TraceQL query editor, located on the Explore > TraceQL tab in Grafana, lets you search by trace ID and write TraceQL queries using autocomplete.

The TraceQL query editor

Enable the query editor

This feature is automatically available in Grafana 10 (and newer) and Grafana Cloud.

To use the TraceQL query editor in self-hosted Grafana 9.3.2 and older, you need to enable the traceqlEditor feature toggle.

Write TraceQL queries using the query editor

The Tempo data source’s TraceQL query editor helps you query and display traces from Tempo in Explore.

To access the query editor, follow these steps:

  1. Sign into Grafana or Grafana Cloud.
  2. Select your Tempo data source.
  3. From the menu, choose Explore and select the TraceQL tab.
  4. Start your query on the text line by entering {. For help with TraceQL syntax, refer to the Construct a TraceQL query documentation.
  5. Optional: Use the Time picker drop-down to change the time and range for the query (refer to the documentation for instructions).
  6. Once you have finished your query, select Run query.

This video provides and example of creating a TraceQL query using the custom tag grouping.

Query by TraceID

To query a particular trace by its trace ID:

  1. From the menu, choose Explore, select the desired Tempo data source, and navigate to the TraceQL tab.
  2. Enter the trace ID into the query field. For example: 41928b92edf1cdbe0ba6594baee5ae9
  3. Click Run query or use the keyboard shortcut Shift + Enter.

Search for a trace ID using the TraceQL query editor

Use autocomplete to write queries

You can use the query editor’s autocomplete suggestions to write queries. The editor detects span sets to provide relevant autocomplete options. It uses regular expressions (regex) to detect where it’s inside a spanset and provide attribute names, scopes, intrinsic names, logic operators, or attribute values from Tempo’s API, depending on what’s expected for the current situation.

Query editor showing the auto-complete feature

To create a query using autocomplete, follow these steps:

  1. From the menu, choose Explore, select the desired Tempo data source, and navigate to the TraceQL tab.

  2. Enter your query. As you type your query, autocomplete suggestions appear as a drop-down. Each letter you enter refines the autocomplete options to match.

  3. Use your mouse or arrow keys to select any option you wish. When the desired option is highlighted, press Tab on your keyboard to add the selection to your query.

  4. Once your query is complete, select Run query.

View query results

Query results for both the editor and the builder are returned in a table. Selecting the Trace ID or Span ID provides more detailed information.

Selecting the trace ID from the returned results opens a trace diagram. Selecting a span from the returned results opens a trace diagram and reveals the relevant span in the trace diagram (the highlighted blue line).

In the trace diagram, the bold text on the left side of each span indicates the service name, for example mythical-requester: requester, and it is hidden when subsequent spans have the same service name (nested spans). Each service has a color assigned to it, which is visible to the left of the name and timeline in the graph. Spans with the same color belong to the same service. The grey text to the right of the service name indicates the span name.

Query editor showing span results

Streaming results

The Tempo data source supports streaming responses to TraceQL queries so you can see partial query results as they come in without waiting for the whole query to finish.

Note

To use this experimental feature, enable the traceQLStreaming feature toggle. If you’re using Grafana Cloud and would like to enable this feature, please contact customer support.

Streaming is available for both the Search and TraceQL query types, and you’ll get immediate visibility of incoming traces on the results table.