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 Jaeger

Jaeger data source

Grafana ships with built-in support for Jaeger, which provides open source, end-to-end distributed tracing. This topic explains configuration and queries specific to the Jaeger data source.

For instructions on how to add a data source to Grafana, refer to the administration documentation. Only users with the organization administrator role can add data sources. Administrators can also configure the data source via YAML with Grafana’s provisioning system.

Once you’ve added the data source, you can configure it so your Grafana instance’s users can create queries in the query editor when the users build dashboards and use Explore.

You can also upload a JSON trace file, link to a trace ID from logs, and link to a trace ID from metrics.

Configure the data source

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

1. Click Connections in the left-side menu.

2. Under Your connections, click Data sources.

3. Enter Jaeger in the search bar.

4. Select Jaeger.

   The Settings tab of the data source is displayed.

5. Set the data source’s basic configuration options:

   Name	Description
   Name	Sets the name you use to refer to the data source in panels and queries.
   Default	Defines whether this data source is pre-selected for new panels.
   URL	Sets the URL of the Jaeger instance, such as http://localhost:16686.
   Basic Auth	Enables basic authentication for the Jaeger data source.
   User	Defines the user name for basic authentication.
   Password	Defines the password for basic authentication.

You can also configure settings specific to the Jaeger data source. These options are described in the sections below.

Trace to logs

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

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. Since 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 spans 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 if the tag has dots in the name and the target data source does not allow dots in labels. In that case, you can, for example, remap http.status to http_status.

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. Since the logs timestamps may not exactly match the timestamps of the spans in the trace, you may need to widen or shift the time range to find the desired logs.

3. Optionally, select tags to map. These tags can be used in the custom query with ${__tags} variable. This variable will interpolate the mapped tags as a 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 does not 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 like this method="${__span.tags.method}".

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 is present only if all the variables are interpolated with non-empty values to prevent creating an invalid query.

Variables that can be used in a custom query

To use a variable you need to wrap it in ${}. For example: ${__span.name}.

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

Trace to metrics

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

To configure trace to metrics:

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. Create any desired linked queries.

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"}.

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.

Span bar

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

You can choose one of three options:

Provision the data source

You can define and configure the 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.

Provisioning example

yaml Copy

apiVersion: 1

datasources:
  - name: Jaeger
    type: jaeger
    uid: EbPG8fYoz
    url: http://localhost:16686
    access: proxy
    basicAuth: true
    basicAuthUser: my_user
    readOnly: false
    isDefault: 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]))'
      nodeGraph:
        enabled: true
      traceQuery:
        timeShiftEnabled: true
        spanStartTimeShift: '1h'
        spanEndTimeShift: '-1h'
      spanBar:
        type: 'None'
    secureJsonData:
      basicAuthPassword: my_password

Query the data source

You can query and display traces from Jaeger via Explore.

This topic explains configuration and queries specific to the Jaeger data source. For general documentation on querying data sources in Grafana, see Query and transform data.

Query by search

To search for traces:

1. Select Search from the Query type selector.
2. Fill out the search form:

Query by trace ID

To query a particular trace:

1. Select the TraceID query type.
2. Enter the trace’s ID into the Trace ID field.

Upload a JSON trace file

You can upload a JSON file that contains a single trace and visualize it. If the file has multiple traces, Grafana visualizes its first trace.

Trace JSON example

json Copy

{
  "data": [
    {
      "traceID": "2ee9739529395e31",
      "spans": [
        {
          "traceID": "2ee9739529395e31",
          "spanID": "2ee9739529395e31",
          "flags": 1,
          "operationName": "CAS",
          "references": [],
          "startTime": 1616095319593196,
          "duration": 1004,
          "tags": [
            {
              "key": "sampler.type",
              "type": "string",
              "value": "const"
            }
          ],
          "logs": [],
          "processID": "p1",
          "warnings": null
        }
      ],
      "processes": {
        "p1": {
          "serviceName": "loki-all",
          "tags": [
            {
              "key": "jaeger.version",
              "type": "string",
              "value": "Go-2.25.0"
            }
          ]
        }
      },
      "warnings": null
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0,
  "errors": null
}

Span Filters

Using span filters, you can filter your spans in the trace timeline viewer. The more filters you add, the more specific are the filtered spans.

You can add one or more of the following filters:

• Service name
• Span name
• Duration
• Tags (which include tags, process tags, and log fields)

To only show the spans you have matched, you can press the Show matches only toggle.

Link to a trace ID from logs

You can link to Jaeger traces from logs in Loki, Elasticsearch, Splunk, and other logs data sources by configuring an internal link.

To configure this feature, see the Derived fields section of the Loki data source docs or the Data links section of the Elasticsearch or Splunk data source docs.

Link to a trace ID from metrics

You can link to Jaeger traces from metrics in Prometheus data sources by configuring an exemplar.

To configure this feature, see the introduction to exemplars documentation.

Visualizing the dependency graph

If service dependency information is available in Jaeger, it can be visualized in Grafana. Use the Jaeger data source with the “Dependency Graph” query type on a Node Graph panel for this.