Menu
Grafana Cloud

Configure the Tempo data source

To configure basic settings for the Tempo data source, complete the following steps:

  1. Click Connections in the left-side menu.

  2. Under Your connections, click Data sources.

  3. Enter Tempo in the search bar.

  4. Select Tempo.

  5. On the Settings tab, set the data source’s basic configuration options:

    NameDescription
    NameSets the name you use to refer to the data source in panels and queries.
    DefaultSets the data source that’s pre-selected for new panels.
    URLSets the URL of the Tempo instance, such as http://tempo.
    Basic AuthEnables basic authentication to the Tempo data source.
    UserSets the user name for basic authentication.
    PasswordSets the password for basic authentication.

You can also configure settings specific to the Tempo data source.

This video explains how to add data sources, including Loki, Tempo, and Mimir, to Grafana and Grafana Cloud. Tempo data source set up starts at 4:58 in the video.

Trace to logs

Trace to logs settings

The Trace to logs setting configures the trace to logs feature that is available when you integrate Grafana with Tempo.

There are two ways to configure the trace to logs feature:

  • Use a simplified configuration with default query, or
  • Configure a custom query where you can use a template language to interpolate variables from the trace or span.

Use a simple configuration

  1. Select the target data source from the drop-down list.

    You can also click Open advanced data source picker to see more options, including adding a data source.

  2. Set start and end time shift. As the logs timestamps may not exactly match the timestamps of the spans in trace it may be necessary to search in larger or shifted time range to find the desired logs.

  3. Select which tags to use in the logs query. The tags you configure must be present in the span’s attributes or resources for a trace to logs span link to appear. You can optionally configure a new name for the tag. This is useful, for example, if the tag has dots in the name and the target data source does not allow using dots in labels. In that case, you can for example remap http.status (the span attribute) to http_status (the data source field). “Data source” in this context can refer to Loki, or another log data source.

  4. Optionally switch on the Filter by trace ID and/or Filter by span ID setting to further filter the logs if your logs consistently contain trace or span IDs.

Configure a custom query

  1. Select the target data source from the drop-down list.

    You can also click Open advanced data source picker to see more options, including adding a data source.

  2. Set start and end time shift. As the logs timestamps may not exactly match the timestamps of the spans in the trace it may be necessary to widen or shift the time range to find the desired logs.

  3. Optional: Select tags to map. These tags can be used in the custom query with ${__tags} variable. This variable interpolates the mapped tags as list in an appropriate syntax for the data source. Only the tags that were present in the span are included; tags that aren’t present are omitted You can also configure a new name for the tag. This is useful in cases where the tag has dots in the name and the target data source doesn’t allow dots in labels. For example, you can remap http.status to http_status. If you don’t map any tags here, you can still use any tag in the query, for example, method="${__span.tags.method}". You can learn more about custom query variables here.

  4. Skip Filter by trace ID and Filter by span ID settings as these cannot be used with a custom query.

  5. Switch on Use custom query.

  6. Specify a custom query to be used to query the logs. You can use various variables to make that query relevant for current span. The link will only be shown only if all the variables are interpolated with non-empty values to prevent creating an invalid query.

Configure trace to logs

The following table describes the ways in which you can configure your trace to logs settings:

Setting nameDescription
Data sourceDefines the target data source. You can select only Loki or Splunk [logs] data sources.
Span start time shiftShifts the start time for the logs query, based on the span’s start time. You can use time units, such as 5s, 1m, 3h. To extend the time to the past, use a negative value. Default: 0.
Span end time shiftShifts the end time for the logs query, based on the span’s end time. You can use time units. Default: 0.
TagsDefines the tags to use in the logs query. Default: cluster, hostname, namespace, pod, service.name, service.namespace. You can change the tag name for example to remove dots from the name if they are not allowed in the target data source. For example, map http.status to http_status.
Filter by trace IDToggles whether to append the trace ID to the logs query.
Filter by span IDToggles whether to append the span ID to the logs query.
Use custom queryToggles use of custom query with interpolation.
QueryInput to write custom query. Use variable interpolation to customize it with variables from span.

Trace to metrics

The Trace to metrics setting configures the trace to metrics feature available when integrating Grafana with Tempo.

There are two ways to configure the trace to metrics feature:

  • Use a basic configuration with a default query, or
  • Configure one or more custom queries where you can use a template language to interpolate variables from the trace or span.

Simple config

To use a simple configuration, follow these steps:

  1. Select a metrics data source from the Data source drop-down.

  2. Optional: Choose any tags to use in the query. If left blank, the default values of cluster, hostname, namespace, pod, service.name and service.namespace are used.

    The tags you configure must be present in the spans attributes or resources for a trace to metrics span link to appear. You can optionally configure a new name for the tag. This is useful for example if the tag has dots in the name and the target data source doesn’t allow using dots in labels. In that case you can for example remap service.name to service_name.

  3. Do not select Add query.

  4. Select Save and Test.

Custom queries

To use custom queries with the configuration, follow these steps:

  1. Select a metrics data source from the Data source drop-down.

  2. Optional: Choose any tags to use in the query. If left blank, the default values of cluster, hostname, namespace, pod, service.name and service.namespace are used.

    These tags can be used in the custom query with ${__tags} variable. This variable interpolates the mapped tags as list in an appropriate syntax for the data source and will only include the tags that were present in the span omitting those that weren’t present. You can optionally configure a new name for the tag. This is useful in cases where the tag has dots in the name and the target data source doesn’t allow using dots in labels. For example, you can remap service.name to service_name in such a case. If you don’t map any tags here, you can still use any tag in the query like this method="${__span.tags.method}". You can learn more about custom query variables here.

  3. Click Add query to add a custom query.

  4. Specify a custom query to be used to query metrics data.

    Each linked query consists of:

    • Link Label: (Optional) Descriptive label for the linked query.
    • Query: The query ran when navigating from a trace to the metrics data source. Interpolate tags using the $__tags keyword. For example, when you configure the query requests_total{$__tags}with the tags k8s.pod=pod and cluster, the result looks like requests_total{pod="nginx-554b9", cluster="us-east-1"}.
  5. Select Save and Test.

Configure trace to metrics

Setting nameDescription
Data sourceDefines the target data source.
Span start time shiftShifts the start time for the metrics query, based on the span’s start time. You can use time units, such as 5s, 1m, 3h. To extend the time to the past, use a negative value. Default: 0.
Span end time shiftShifts the end time for the metrics query, based on the span’s end time. You can use time units. Default: 0.
TagsDefines the tags used in linked queries. The key sets the span attribute name, and the optional value sets the corresponding metric label name. For example, you can map k8s.pod to pod. To interpolate these tags into queries, use the $__tags keyword.
Link Label(Optional) Descriptive label for the linked query.
QueryInput to write a custom query. Use variable interpolation to customize it with variables from span.

Trace to profiles

Using Trace to profiles, you can use Grafana’s ability to correlate different signals by adding the functionality to link between traces and profiles.

Trace to profiles lets you link your Grafana Pyroscope data source to tracing data. When configured, this connection lets you run queries from a trace span into the profile data.

There are two ways to configure the trace to profiles feature:

  • Use a basic configuration with default query, or
  • Configure a custom query where you can use a template language to interpolate variables from the trace or span.

Note

Traces to profile requires a Tempo data source with Traces to profiles configured and a Pyroscope data source. This integration supports profile data generated using Go, Ruby, and Java instrumentation SDKs.

To use trace to profiles, navigate to Explore and query a trace. Each span now links to your queries. Clicking a link runs the query in a split panel. If tags are configured, Grafana dynamically inserts the span attribute values into the query. The query runs over the time range of the (span start time - 60) to (span end time + 60 seconds).

Selecting a link in the span queries the profile data source

To use trace to profiles, you must have a configured Grafana Pyroscope data source. For more information, refer to the Grafana Pyroscope data source documentation.

Embedded flame graphs are also inserted into each span details section that has a linked profile (requires a configured Grafana Pyroscope data source). This lets you see resource consumption in a flame graph visualization for each span without having to navigate away from the current view. Hover over a particular block in the flame graph to see more details about the resources being consumed.

Configuration options

The following table describes options for configuring your Trace to profiles settings:

Setting nameDescription
Data sourceDefines the target data source. You can currently select a Pyroscope [profiling] data source.
TagsDefines the tags to use in the profile query. Default: cluster, hostname, namespace, pod, service.name, service.namespace. You can change the tag name for example to remove dots from the name if they are not allowed in the target data source. For example, map http.status to http_status.
Profile typeDefines the profile type that used in the query.
Use custom queryToggles use of custom query with interpolation.
QueryInput to write custom query. Use variable interpolation to customize it with variables from span.

Use a basic configuration

To use a basic configuration, follow these steps:

  1. In the left menu, select Connections > Data sources.

  2. Select your configured Tempo data source from the Data source list.

  3. Scroll down to the Traces to profiles section.

  4. Select a Pyroscope data source in the Data source drop-down.

  5. Optional: Add one or more tags to use in the query. If left blank, the default values of service.name and service.namespace are used.

    The tags you configure must be present in the spans attributes or resources for a trace-to-profiles span link to appear.

    You can optionally configure a new name for the tag. This is useful if the tag has dots in the name and the target data source doesn’t allow dots in labels. In that case, you can remap service.name to service_name.

  6. Select one or more profile types to use in the query. Select the drop-down and choose options from the menu.

    The profile type or app must be selected for the query to be valid. Grafana doesn’t show any data if the profile type or app isn’t selected when a query runs. Traces to profile configuration options in the Tempo data source

  7. Select Save and Test.

If you have configured a Pyroscope data source and no profile data is available or the Profiles for this span button and the embedded flame graph isn’t visible, verify that the pyroscope.profile.id key-value pair exists in your span tags.

Configure a custom query

To use a custom query with the configuration, follow these steps:

  1. In the left menu, select Connections > Data sources.

  2. Select a configured Tempo data source from the Data source list.

  3. Scroll down to the Traces to profiles section.

  4. Select a Pyroscope data source in the Data source drop-down.

  5. Optional: Choose any tags to use in the query. If left blank, the default values of service.name and service.namespace are used.

    These tags can be used in the custom query with ${__tags} variable. This variable interpolates the mapped tags as list in an appropriate syntax for the data source. Only the tags that were present in the span are included; tags that aren’t present are omitted. You can also configure a new name for the tag. This is useful in cases where the tag has dots in the name and the target data source doesn’t allow using dots in labels. For example, you can remap service.name to service_name. If you don’t map any tags here, you can still use any tag in the query, for example: method="${__span.tags.method}". You can learn more about custom query variables here.

  6. Select one or more profile types to use in the query. Select the drop-down and choose options from the menu.

  7. Switch on Use custom query to enter a custom query.

  8. Specify a custom query to be used to query profile data. You can use various variables to make that query relevant for current span. The link is shown only if all the variables are interpolated with non-empty values to prevent creating an invalid query. You can interpolate the configured tags using the $__tags keyword.

  9. Select Save and Test.

                                                                                                                                                                                                     |
    

Custom query variables

To use a variable in your trace to logs, metrics or profiles you need to wrap it in ${}. For example, ${__span.name}.

Variable nameDescription
__tagsThis variable uses the tag mapping from the UI to create a label matcher string in the specific data source syntax. The variable only uses tags that are present in the span. The link is still created even if only one of those tags is present in the span. You can use this if all tags are not required for the query to be useful.
__span.spanIdThe ID of the span.
__span.traceIdThe ID of the trace.
__span.durationThe duration of the span.
__span.nameName of the span.
__span.tagsNamespace for the tags in the span. To access a specific tag named version, you would use ${__span.tags.version}. In case the tag contains dot, you have to access it as ${__span.tags["http.status"]}.
__trace.traceIdThe ID of the trace.
__trace.durationThe duration of the trace.
__trace.nameThe name of the trace.

Service Graph

The Service Graph setting configures the Service Graph feature.

Configure the Data source setting to define in which Prometheus instance the Service Graph data is stored.

To use the Service Graph, refer to the Service Graph documentation.

Node Graph

The Node Graph setting enables the node graph visualization, which is disabled by default.

Once enabled, Grafana displays the node graph above the trace view.

The Search setting configures Tempo search.

You can configure the Hide search setting to hide the search query option in Explore if search is not configured in the Tempo instance.

The Loki search setting configures the Loki search query type.

Configure the Data source setting to define which Loki instance you want to use to search traces. You must configure derived fields in the Loki instance.

TraceID query

The TraceID query setting modifies how TraceID queries are run. The time range can be used when there are performance issues or timeouts since it will narrow down the search to the defined range. This setting is disabled by default.

You can configure this setting as follows:

NameDescription
Enable time rangeUse a time range in the TraceID query. Default: disabled.
Time shift startTime shift for start of search. Default: 30m.
Time shift endTime shift for end of search. Default: 30m.

Span bar

The Span bar setting helps you display additional information in the span bar row.

You can choose one of three options:

NameDescription
NoneAdds nothing to the span bar row.
Duration(Default) Displays the span duration on the span bar row.
TagDisplays the span tag on the span bar row. You must also specify which tag key to use to get the tag value, such as component.

Provision the data source

You can define and configure the Tempo data source in YAML files as part of Grafana’s provisioning system. For more information about provisioning and available configuration options, refer to Provisioning Grafana.

Example provision YAML file:

yaml
apiVersion: 1

datasources:
  - name: Tempo
    type: tempo
    uid: EbPG8fYoz
    url: http://localhost:3200
    access: proxy
    basicAuth: false
    jsonData:
      tracesToLogsV2:
        # Field with an internal link pointing to a logs data source in Grafana.
        # datasourceUid value must match the uid value of the logs data source.
        datasourceUid: 'loki'
        spanStartTimeShift: '1h'
        spanEndTimeShift: '-1h'
        tags: ['job', 'instance', 'pod', 'namespace']
        filterByTraceID: false
        filterBySpanID: false
        customQuery: true
        query: 'method="${__span.tags.method}"'
      tracesToMetrics:
        datasourceUid: 'prom'
        spanStartTimeShift: '1h'
        spanEndTimeShift: '-1h'
        tags: [{ key: 'service.name', value: 'service' }, { key: 'job' }]
        queries:
          - name: 'Sample query'
            query: 'sum(rate(traces_spanmetrics_latency_bucket{$$__tags}[5m]))'
      traceToProfiles:
        datasourceUid: 'grafana-pyroscope-datasource'
        tags: ['job', 'instance', 'pod', 'namespace']
        profileTypeId: 'process_cpu:cpu:nanoseconds:cpu:nanoseconds'
        customQuery: true
        query: 'method="${__span.tags.method}"'
      serviceMap:
        datasourceUid: 'prometheus'
      nodeGraph:
        enabled: true
      search:
        hide: false
      lokiSearch:
        datasourceUid: 'loki'
      traceQuery:
        timeShiftEnabled: true
        spanStartTimeShift: '1h'
        spanEndTimeShift: '-1h'
      spanBar:
        type: 'Tag'
        tag: 'http.path'