IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-22 08:56:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Tracing: Docs and config improvements for Tempo/Jaeger/Zipkin (#65255)

Browse Source 
* Docs and config improvements

* Add note

* Add traceToLogs (v1) in provisioning example

* Remove old provisioning

* PR updates
This commit is contained in:
Joey 2023-03-30 07:41:27 +01:00 committed by GitHub
parent 2025c1dac1
commit 10d896d24e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 219 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
devenv/docker/blocks/tempo/docker-compose.yaml
View File

@ -81,7 +81,7 @@ services:
- "4318:4318" # otlp http - "4318:4318" # otlp http
prometheus: prometheus:
image: prom/prometheus:main image: prom/prometheus:latest
command: command:
- --config.file=/etc/prometheus.yaml - --config.file=/etc/prometheus.yaml
- --web.enable-remote-write-receiver - --web.enable-remote-write-receiver

75
docs/sources/datasources/jaeger/_index.md
View File

@ -15,8 +15,7 @@ weight: 800
# Jaeger data source # Jaeger data source
Grafana ships with built-in support for Jaeger, which provides open source, end-to-end distributed tracing. 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.
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]({{< relref "../../administration/data-source-management" >}}). For instructions on how to add a data source to Grafana, refer to the [administration documentation]({{< relref "../../administration/data-source-management" >}}).
Only users with the organization administrator role can add data sources. Only users with the organization administrator role can add data sources.
@ -24,7 +23,7 @@ Administrators can also [configure the data source via YAML]({{< relref "#provis
Once you've added the data source, you can [configure it]({{< relref "#configure-the-data-source" >}}) so your Grafana instance's users can create queries in the [query editor]({{< relref "#query-the-data-source" >}}) when the users [build dashboards]({{< relref "../../dashboards/build-dashboards/" >}}) and use [Explore]({{< relref "../../explore/" >}}). Once you've added the data source, you can [configure it]({{< relref "#configure-the-data-source" >}}) so your Grafana instance's users can create queries in the [query editor]({{< relref "#query-the-data-source" >}}) when the users [build dashboards]({{< relref "../../dashboards/build-dashboards/" >}}) and use [Explore]({{< relref "../../explore/" >}}).
You can also [upload a JSON trace file]({{< relref "#upload-a-json-trace-file" >}}), and [link a trace ID from logs]({{< relref "#link-a-trace-id-from-logs" >}}) in Loki. You can also [upload a JSON trace file]({{< relref "#upload-a-json-trace-file" >}}), [link to a trace ID from logs]({{< relref "#link-to-a-trace-id-from-logs" >}}), and [link to a trace ID from metrics]({{< relref "#link-to-a-trace-id-from-metrics" >}}).
## Configure the data source ## Configure the data source
@ -95,23 +94,23 @@ 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: The following table describes the ways in which you can configure your trace to logs settings:
| Setting name | Description | | Setting name | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Data source** | Defines the target data source. You can select only Loki or Splunk \[logs\] data sources. | | **Data source** | Defines the target data source. You can select only Loki or Splunk \[logs\] data sources. |
| **Span start time shift** | Shifts 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 start time shift** | Shifts 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 shift** | Shifts the end time for the logs query, based on the span's end time. You can use time units. Default: `0`. | | **Span end time shift** | Shifts the end time for the logs query, based on the span's end time. You can use time units. Default: `0`. |
| **Tags** | Defines the the tags to use in the logs query. Default is `cluster`, `hostname`, `namespace`, `pod`. 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`. | | **Tags** | Defines the tags to use in the logs query. Default: `cluster`, `hostname`, `namespace`, `pod`. 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 ID** | Toggles whether to append the trace ID to the logs query. | | **Filter by trace ID** | Toggles whether to append the trace ID to the logs query. |
| **Filter by span ID** | Toggles whether to append the span ID to the logs query. | | **Filter by span ID** | Toggles whether to append the span ID to the logs query. |
| **Use custom query** | Toggles use of custom query with interpolation. | | **Use custom query** | Toggles use of custom query with interpolation. |
| **Query** | Input to write custom query. Use variable interpolation to customize it with variables from span. | | **Query** | Input to write custom query. Use variable interpolation to customize it with variables from span. |
### Trace to metrics ### Trace to metrics
> **Note:** This feature is behind the `traceToMetrics` [feature toggle]({{< relref "../../setup-grafana/configure-grafana#feature_toggles" >}}). > **Note:** This feature is behind the `traceToMetrics` [feature toggle]({{< relref "../../setup-grafana/configure-grafana#feature_toggles" >}}).
> If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature. > If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature.
The **Trace to metrics** section configures the [trace to metrics feature](/blog/2022/08/18/new-in-grafana-9.1-trace-to-metrics-allows-users-to-navigate-from-a-trace-span-to-a-selected-data-source/) available when integrating Grafana with Jaeger. The **Trace to metrics** setting configures the [trace to metrics feature](/blog/2022/08/18/new-in-grafana-9.1-trace-to-metrics-allows-users-to-navigate-from-a-trace-span-to-a-selected-data-source/) available when integrating Grafana with Jaeger.
To configure trace to metrics: To configure trace to metrics:
@ -136,9 +135,9 @@ The **Node Graph** setting enables the [Node Graph visualization]({{< relref "..
Once enabled, Grafana displays the Node Graph above the trace view. Once enabled, Grafana displays the Node Graph above the trace view.
### Span bar label ### Span bar
The **Span bar label** section helps you display additional information in the span bar row. The **Span bar** setting helps you display additional information in the span bar row.
You can choose one of three options: You can choose one of three options:
@ -151,11 +150,9 @@ You can choose one of three options:
### Provision the data source ### Provision the data source
You can define and configure the data source in YAML files as part of Grafana's provisioning system. You can define and configure the data source in YAML files as part of Grafana's provisioning system.
For more information about provisioning, and for available configuration options, refer to [Provisioning Grafana]({{< relref "../../administration/provisioning#data-sources" >}}). For more information about provisioning and available configuration options, refer to [Provisioning Grafana]({{< relref "../../administration/provisioning#data-sources" >}}).
#### Provisioning examples #### Provisioning example
**Using basic auth and the trace-to-logs field:**
```yaml ```yaml
apiVersion: 1 apiVersion: 1
@ -163,31 +160,37 @@ apiVersion: 1
datasources: datasources:
- name: Jaeger - name: Jaeger
type: jaeger type: jaeger
uid: jaeger-spectra uid: EbPG8fYoz
url: http://localhost:16686
access: proxy access: proxy
url: http://localhost:16686/
basicAuth: true basicAuth: true
basicAuthUser: my_user basicAuthUser: my_user
editable: true readOnly: false
isDefault: false isDefault: false
jsonData: jsonData:
tracesToLogs: tracesToLogsV2:
# Field with internal link pointing to a logs data source in Grafana. # Field with an internal link pointing to a logs data source in Grafana.
# datasourceUid value must match the datasourceUid value of the logs data source. # datasourceUid value must match the uid value of the logs data source.
datasourceUid: 'loki' datasourceUid: 'loki'
tags: ['job', 'instance', 'pod', 'namespace']
mappedTags: [{ key: 'service.name', value: 'service' }]
mapTagNamesEnabled: false
spanStartTimeShift: '1h' spanStartTimeShift: '1h'
spanEndTimeShift: '1h' spanEndTimeShift: '-1h'
tags: ['job', 'instance', 'pod', 'namespace']
filterByTraceID: false filterByTraceID: false
filterBySpanID: false filterBySpanID: false
customQuery: true
query: 'method="${__span.tags.method}"'
tracesToMetrics: tracesToMetrics:
datasourceUid: 'prom' datasourceUid: 'prom'
spanStartTimeShift: '1h'
spanEndTimeShift: '-1h'
tags: [{ key: 'service.name', value: 'service' }, { key: 'job' }] tags: [{ key: 'service.name', value: 'service' }, { key: 'job' }]
queries: queries:
- name: 'Sample query' - name: 'Sample query'
query: 'sum(rate(traces_spanmetrics_latency_bucket{$__tags}[5m]))' query: 'sum(rate(traces_spanmetrics_latency_bucket{$__tags}[5m]))'
nodeGraph:
enabled: true
spanBar:
type: 'None'
secureJsonData: secureJsonData:
basicAuthPassword: my_password basicAuthPassword: my_password
``` ```
@ -283,8 +286,14 @@ If the file has multiple traces, Grafana visualizes its first trace.
} }
``` ```
## Link a trace ID from logs ## Link to a trace ID from logs
You can link to a Jaeger trace from logs in [Loki](/docs/loki/latest/) by configuring a derived field with an internal link. You can link to Jaeger traces from logs in Loki, Elasticsearch, Splunk, and other logs data sources by configuring an internal link.
For details, refer to [Derived fields]({{< relref "../loki/#configure-derived-fields" >}}) section of the [Loki data source]({{< relref "../loki/" >}}) documentation. To configure this feature, see the [Derived fields]({{< relref "../loki#configure-derived-fields" >}}) section of the Loki data source docs or the [Data links]({{< relref "../elasticsearch#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]({{< relref "docs/grafana/latest/fundamentals/exemplars" >}}) documentation.

4
docs/sources/datasources/parca.md
View File

@ -24,8 +24,8 @@ To access Parca settings, click the **Configuration** (gear) icon, then click **
| ------------ | ------------------------------------------------------------------ | | ------------ | ------------------------------------------------------------------ |
| `Name` | A name to specify the data source in panels, queries, and Explore. | | `Name` | A name to specify the data source in panels, queries, and Explore. |
| `Default` | The default data source will be pre-selected for new panels. | | `Default` | The default data source will be pre-selected for new panels. |
| `URL` | The URL of the Tempo instance, e.g., `http://localhost:4100` | | `URL` | The URL of the Parca instance, e.g., `http://localhost:4100` |
| `Basic Auth` | Enable basic authentication to the Tempo data source. | | `Basic Auth` | Enable basic authentication to the Parca data source. |
| `User` | User name for basic authentication. | | `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. | | `Password` | Password for basic authentication. |

4
docs/sources/datasources/phlare.md
View File

@ -24,8 +24,8 @@ To access Phlare settings, click the **Configuration** (gear) icon, then click *
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Name` | A name to specify the data source in panels, queries, and Explore. | | `Name` | A name to specify the data source in panels, queries, and Explore. |
| `Default` | The default data source will be pre-selected for new panels. | | `Default` | The default data source will be pre-selected for new panels. |
| `URL` | The URL of the Tempo instance, e.g., `http://localhost:4100` | | `URL` | The URL of the Phlare instance, e.g., `http://localhost:4100` |
| `Basic Auth` | Enable basic authentication to the Tempo data source. | | `Basic Auth` | Enable basic authentication to the Phlare data source. |
| `User` | User name for basic authentication. | | `User` | User name for basic authentication. |
| `Password` | Password for basic authentication. | | `Password` | Password for basic authentication. |
| `Minimal step` | Similar to Prometheus, Phlare scrapes profiles at certain intervals. To prevent querying at smaller interval use Minimal step same or higher than your Phlare scrape interval. | | `Minimal step` | Similar to Prometheus, Phlare scrapes profiles at certain intervals. To prevent querying at smaller interval use Minimal step same or higher than your Phlare scrape interval. |

89
docs/sources/datasources/tempo/_index.md
View File

@ -23,7 +23,7 @@ Administrators can also [configure the data source via YAML]({{< relref "#provis
Once you've added the data source, you can [configure it]({{< relref "#configure-the-data-source" >}}) so that your Grafana instance's users can create queries in its [query editor]({{< relref "./query-editor/" >}}) when they [build dashboards]({{< relref "../../dashboards/build-dashboards/" >}}) and use [Explore]({{< relref "../../explore/" >}}). Once you've added the data source, you can [configure it]({{< relref "#configure-the-data-source" >}}) so that your Grafana instance's users can create queries in its [query editor]({{< relref "./query-editor/" >}}) when they [build dashboards]({{< relref "../../dashboards/build-dashboards/" >}}) and use [Explore]({{< relref "../../explore/" >}}).
You can also [use the Service Graph]({{< relref "#use-the-service-graph" >}}) to view service relationships, [track RED metrics]({{< relref "#open-the-service-graph-view" >}}), [upload a JSON trace file]({{< relref "#upload-a-json-trace-file" >}}), and [link a trace ID from logs]({{< relref "#link-a-trace-id-from-logs" >}}) from a logs data source. You can also [use the Service Graph]({{< relref "#use-the-service-graph" >}}) to view service relationships, [track RED metrics]({{< relref "#open-the-service-graph-view" >}}), [upload a JSON trace file]({{< relref "#upload-a-json-trace-file" >}}), [link to a trace ID from logs]({{< relref "#link-to-a-trace-id-from-logs" >}}), and [link to a trace ID from metrics]({{< relref "#link-to-a-trace-id-from-metrics" >}}).
## Configure the data source ## Configure the data source
@ -94,16 +94,16 @@ 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: The following table describes the ways in which you can configure your trace to logs settings:
| Setting name | Description | | Setting name | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Data source** | Defines the target data source. You can select only Loki or Splunk \[logs\] data sources. | | **Data source** | Defines the target data source. You can select only Loki or Splunk \[logs\] data sources. |
| **Span start time shift** | Shifts 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 start time shift** | Shifts 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 shift** | Shifts the end time for the logs query, based on the span's end time. You can use time units. Default: `0`. | | **Span end time shift** | Shifts the end time for the logs query, based on the span's end time. You can use time units. Default: `0`. |
| **Tags** | Defines the the tags to use in the logs query. Default is `cluster`, `hostname`, `namespace`, `pod`. 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`. | | **Tags** | Defines the tags to use in the logs query. Default: `cluster`, `hostname`, `namespace`, `pod`. 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 ID** | Toggles whether to append the trace ID to the logs query. | | **Filter by trace ID** | Toggles whether to append the trace ID to the logs query. |
| **Filter by span ID** | Toggles whether to append the span ID to the logs query. | | **Filter by span ID** | Toggles whether to append the span ID to the logs query. |
| **Use custom query** | Toggles use of custom query with interpolation. | | **Use custom query** | Toggles use of custom query with interpolation. |
| **Query** | Input to write custom query. Use variable interpolation to customize it with variables from span. | | **Query** | Input to write custom query. Use variable interpolation to customize it with variables from span. |
### Trace to metrics ### Trace to metrics
@ -131,7 +131,7 @@ Each linked query consists of:
### Service Graph ### Service Graph
The **Service Graph** section configures the [Service Graph](/docs/tempo/latest/grafana-agent/service-graphs/) feature. The **Service Graph** setting configures the [Service Graph](/docs/tempo/latest/grafana-agent/service-graphs/) feature.
Configure the **Data source** setting to define in which Prometheus instance the Service Graph data is stored. Configure the **Data source** setting to define in which Prometheus instance the Service Graph data is stored.
@ -145,20 +145,32 @@ Once enabled, Grafana displays the node graph above the trace view.
### Tempo search ### Tempo search
The **Search** section configures [Tempo search](/docs/tempo/latest/configuration/#search). The **Search** setting configures [Tempo search](/docs/tempo/latest/configuration/#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. You can configure the **Hide search** setting to hide the search query option in **Explore** if search is not configured in the Tempo instance.
### Loki search ### Loki search
The **Loki search** section configures the Loki search query type. 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. Configure the **Data source** setting to define which Loki instance you want to use to search traces.
You must configure [derived fields]({{< relref "../loki#configure-derived-fields" >}}) in the Loki instance. You must configure [derived fields]({{< relref "../loki#configure-derived-fields" >}}) in the Loki instance.
### Span bar label ### TraceID query
The **Span bar label** section helps you display additional information in the span bar row. 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:
| Name | Description |
| --------------------- | ----------------------------------------------------------- |
| **Enable time range** | Use a time range in the TraceID query. Default: `disabled`. |
| **Time shift start** | Time shift for start of search. Default: `30m`. |
| **Time shift end** | Time 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: You can choose one of three options:
@ -171,9 +183,9 @@ You can choose one of three options:
### Provision the data source ### Provision the data source
You can define and configure the Tempo data source in YAML files as part of Grafana's provisioning system. 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 for available configuration options, refer to [Provisioning Grafana]({{< relref "../../administration/provisioning/#data-sources" >}}). For more information about provisioning and available configuration options, refer to [Provisioning Grafana]({{< relref "../../administration/provisioning/#data-sources" >}}).
#### Provisioning examples #### Provisioning example
```yaml ```yaml
apiVersion: 1 apiVersion: 1
@ -181,34 +193,41 @@ apiVersion: 1
datasources: datasources:
- name: Tempo - name: Tempo
type: tempo type: tempo
# Access mode - proxy (server in the UI) or direct (browser in the UI). uid: EbPG8fYoz
access: proxy
url: http://localhost:3200 url: http://localhost:3200
access: proxy
basicAuth: false
jsonData: jsonData:
httpMethod: GET tracesToLogsV2:
tracesToLogs: # 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' datasourceUid: 'loki'
tags: ['job', 'instance', 'pod', 'namespace']
mappedTags: [{ key: 'service.name', value: 'service' }]
mapTagNamesEnabled: false
spanStartTimeShift: '1h' spanStartTimeShift: '1h'
spanEndTimeShift: '1h' spanEndTimeShift: '-1h'
tags: ['job', 'instance', 'pod', 'namespace']
filterByTraceID: false filterByTraceID: false
filterBySpanID: false filterBySpanID: false
customQuery: true
query: 'method="${__span.tags.method}"'
tracesToMetrics: tracesToMetrics:
datasourceUid: 'prom' datasourceUid: 'prom'
spanStartTimeShift: '1h'
spanEndTimeShift: '-1h'
tags: [{ key: 'service.name', value: 'service' }, { key: 'job' }] tags: [{ key: 'service.name', value: 'service' }, { key: 'job' }]
queries: queries:
- name: 'Sample query' - name: 'Sample query'
query: 'sum(rate(traces_spanmetrics_latency_bucket{$__tags}[5m]))' query: 'sum(rate(traces_spanmetrics_latency_bucket{$__tags}[5m]))'
serviceMap: serviceMap:
datasourceUid: 'prometheus' datasourceUid: 'prometheus'
search:
hide: false
nodeGraph: nodeGraph:
enabled: true enabled: true
search:
hide: false
lokiSearch: lokiSearch:
datasourceUid: 'loki' datasourceUid: 'loki'
spanBar:
type: 'Tag'
tag: 'http.path'
``` ```
## Query the data source ## Query the data source
@ -311,7 +330,7 @@ Each circle's color represents the percentage of requests in each state:
Service graph view displays a table of request rate, error rate, and duration metrics (RED) calculated from your incoming spans. It also includes a node graph view built from your spans. Service graph view displays a table of request rate, error rate, and duration metrics (RED) calculated from your incoming spans. It also includes a node graph view built from your spans.
{{< figure src="/static/img/docs/tempo/apm-table.png" class="docs-image--no-shadow" max-width="500px" caption="Screenshot of the Service Graph view table" >}} {{< figure src="/static/img/docs/tempo/apm-table.png" class="docs-image--no-shadow" max-width="500px" caption="Screenshot of the Service Graph view" >}}
For details, refer to the [Service Graph view documentation](/docs/tempo/latest/metrics-generator/service-graph-view/). For details, refer to the [Service Graph view documentation](/docs/tempo/latest/metrics-generator/service-graph-view/).
@ -331,8 +350,14 @@ To open a query in Prometheus with the span name of that row automatically set i
To open a query in Tempo with the span name of that row automatically set in the query, click a row in the **links** column. To open a query in Tempo with the span name of that row automatically set in the query, click a row in the **links** column.
## Link a trace ID from logs ## Link to a trace ID from logs
You can link to Tempo trace from logs in [Loki](/docs/loki/latest) or Elasticsearch by configuring an internal link. You can link to Tempo 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]({{< relref "../loki#configure-derived-fields" >}}) section of the [Loki data source docs]({{< relref "../loki/" >}}), or the [Data links]({{< relref "../elasticsearch#data-links" >}}) section of the [Elasticsearch data source docs]({{< relref "../elasticsearch" >}}). To configure this feature, see the [Derived fields]({{< relref "../loki#configure-derived-fields" >}}) section of the Loki data source docs or the [Data links]({{< relref "../elasticsearch#data-links" >}}) section of the Elasticsearch or Splunk data source docs.
## Link to a trace ID from metrics
You can link to Tempo traces from metrics in Prometheus data sources by configuring an exemplar.
To configure this feature, see the [introduction to exemplars]({{< relref "docs/grafana/latest/fundamentals/exemplars" >}}) documentation.

6
docs/sources/datasources/tempo/query-editor/index.md
View File

@ -54,7 +54,7 @@ Tempo includes the ability to search the entire backend datastore.
To configure your Tempo data source to use this feature, refer to the [Tempo documentation](/docs/tempo/latest/getting-started/tempo-in-grafana/#search-of-the-backend-datastore). To configure your Tempo data source to use this feature, refer to the [Tempo documentation](/docs/tempo/latest/getting-started/tempo-in-grafana/#search-of-the-backend-datastore).
## Query by trace ID ## Query by TraceID
To query a particular trace: To query a particular trace:
@ -63,6 +63,10 @@ To query a particular trace:
{{< figure src="/static/img/docs/tempo/query-editor-traceid.png" class="docs-image--no-shadow" max-width="750px" caption="Screenshot of the Tempo TraceID query type" >}} {{< figure src="/static/img/docs/tempo/query-editor-traceid.png" class="docs-image--no-shadow" max-width="750px" caption="Screenshot of the Tempo TraceID query type" >}}
## Query by TraceQL
To learn more about how to query by TraceQL, refer to the [TraceQL documentation](/docs/tempo/latest/traceql).
## Query Loki for traces ## Query Loki for traces
To find traces to visualize, you can use the [Loki query editor]({{< relref "../../loki#loki-query-editor" >}}). To find traces to visualize, you can use the [Loki query editor]({{< relref "../../loki#loki-query-editor" >}}).

88
docs/sources/datasources/zipkin/_index.md
View File

@ -23,6 +23,8 @@ Administrators can also [configure the data source via YAML]({{< relref "#provis
Once you've added the Zipkin data source, you can [configure it]({{< relref "#configure-the-data-source" >}}) so that your Grafana instance's users can create queries in its [query editor]({{< relref "#query-the-data-source" >}}) when they [build dashboards]({{< relref "../../dashboards/build-dashboards/" >}}) and use [Explore]({{< relref "../../explore/" >}}). Once you've added the Zipkin data source, you can [configure it]({{< relref "#configure-the-data-source" >}}) so that your Grafana instance's users can create queries in its [query editor]({{< relref "#query-the-data-source" >}}) when they [build dashboards]({{< relref "../../dashboards/build-dashboards/" >}}) and use [Explore]({{< relref "../../explore/" >}}).
You can also [upload a JSON trace file]({{< relref "#upload-a-json-trace-file" >}}), [link to a trace ID from logs]({{< relref "#link-to-a-trace-id-from-logs" >}}), and [link to a trace ID from metrics]({{< relref "#link-to-a-trace-id-from-metrics" >}}).
## Configure the data source ## Configure the data source
**To access the data source configuration page:** **To access the data source configuration page:**
@ -90,23 +92,23 @@ 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: The following table describes the ways in which you can configure your trace to logs settings:
| Setting name | Description | | Setting name | Description |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Data source** | Defines the target data source. You can select only Loki or Splunk \[logs\] data sources. | | **Data source** | Defines the target data source. You can select only Loki or Splunk \[logs\] data sources. |
| **Span start time shift** | Shifts 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 start time shift** | Shifts 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 shift** | Shifts the end time for the logs query, based on the span's end time. You can use time units. Default: `0`. | | **Span end time shift** | Shifts the end time for the logs query, based on the span's end time. You can use time units. Default: `0`. |
| **Tags** | Defines the the tags to use in the logs query. Default is `cluster`, `hostname`, `namespace`, `pod`. 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`. | | **Tags** | Defines the tags to use in the logs query. Default: `cluster`, `hostname`, `namespace`, `pod`. 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 ID** | Toggles whether to append the trace ID to the logs query. | | **Filter by trace ID** | Toggles whether to append the trace ID to the logs query. |
| **Filter by span ID** | Toggles whether to append the span ID to the logs query. | | **Filter by span ID** | Toggles whether to append the span ID to the logs query. |
| **Use custom query** | Toggles use of custom query with interpolation. | | **Use custom query** | Toggles use of custom query with interpolation. |
| **Query** | Input to write custom query. Use variable interpolation to customize it with variables from span. | | **Query** | Input to write custom query. Use variable interpolation to customize it with variables from span. |
### Trace to metrics ### Trace to metrics
> **Note:** This feature is behind the `traceToMetrics` [feature toggle]({{< relref "../../setup-grafana/configure-grafana#feature_toggles" >}}). > **Note:** This feature is behind the `traceToMetrics` [feature toggle]({{< relref "../../setup-grafana/configure-grafana#feature_toggles" >}}).
> If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature. > If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature.
The **Trace to metrics** section configures the [trace to metrics feature](/blog/2022/08/18/new-in-grafana-9.1-trace-to-metrics-allows-users-to-navigate-from-a-trace-span-to-a-selected-data-source/) available when integrating Grafana with Zipkin. The **Trace to metrics** setting configures the [trace to metrics feature](/blog/2022/08/18/new-in-grafana-9.1-trace-to-metrics-allows-users-to-navigate-from-a-trace-span-to-a-selected-data-source/) available when integrating Grafana with Zipkin.
To configure trace to metrics: To configure trace to metrics:
@ -131,9 +133,9 @@ The **Node Graph** setting enables the [Node Graph visualization]({{< relref "..
Once enabled, Grafana displays the Node Graph after loading the trace view. Once enabled, Grafana displays the Node Graph after loading the trace view.
### Span bar label ### Span bar
The **Span bar label** section helps you display additional information in the span bar row. The **Span bar** setting helps you display additional information in the span bar row.
You can choose one of three options: You can choose one of three options:
@ -143,6 +145,54 @@ You can choose one of three options:
| **Duration** | _(Default)_ Displays the span duration on the span bar row. | | **Duration** | _(Default)_ Displays the span duration on the span bar row. |
| **Tag** | Displays the span tag on the span bar row. You must also specify which tag key to use to get the tag value, such as `span.kind`. | | **Tag** | Displays the span tag on the span bar row. You must also specify which tag key to use to get the tag value, such as `span.kind`. |
### 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]({{< relref "../../administration/provisioning#data-sources" >}}).
#### Provisioning example
```yaml
apiVersion: 1
datasources:
- name: Zipkin
type: zipkin
uid: EbPG8fYoz
url: http://localhost:16686
access: proxy
basicAuth: true
basicAuthUser: my_user
readOnly: true
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
spanBar:
type: 'None'
secureJsonData:
basicAuthPassword: my_password
```
## Query the data source ## Query the data source
You can query and display traces from Zipkin via [Explore]({{< relref "../../explore/" >}}). You can query and display traces from Zipkin via [Explore]({{< relref "../../explore/" >}}).
@ -205,8 +255,14 @@ If the file has multiple traces, Grafana visualizes its first trace.
] ]
``` ```
## Link a trace ID from logs ## Link to a trace ID from logs
You can link to a Zipkin trace from logs in [Loki](/docs/loki/latest/) or Splunk by configuring a derived field with an internal link. You can link to Zipkin traces from logs in Loki, Elasticsearch, Splunk, and other logs data sources by configuring an internal link.
For details, refer to [Derived fields]({{< relref "../loki/#configure-derived-fields" >}}) section of the [Loki data source]({{< relref "../loki/" >}}) documentation. To configure this feature, see the [Derived fields]({{< relref "../loki#configure-derived-fields" >}}) section of the Loki data source docs or the [Data links]({{< relref "../elasticsearch#data-links" >}}) section of the Elasticsearch or Splunk data source docs.
## Link to a trace ID from metrics
You can link to Zipkin traces from metrics in Prometheus data sources by configuring an exemplar.
To configure this feature, see the [introduction to exemplars]({{< relref "docs/grafana/latest/fundamentals/exemplars" >}}) documentation.

20
docs/sources/explore/trace-integration.md
View File

@ -13,10 +13,10 @@ Explore allows you to visualize traces from tracing data sources. This is availa
Supported data sources are: Supported data sources are:
- [Jaeger]({{< relref "../datasources/jaeger/" >}})
- [Tempo]({{< relref "../datasources/tempo/" >}}) - [Tempo]({{< relref "../datasources/tempo/" >}})
- [X-Ray](https://grafana.com/grafana/plugins/grafana-x-ray-datasource) - [Jaeger]({{< relref "../datasources/jaeger/" >}})
- [Zipkin]({{< relref "../datasources/zipkin/" >}}) - [Zipkin]({{< relref "../datasources/zipkin/" >}})
- [X-Ray](https://grafana.com/grafana/plugins/grafana-x-ray-datasource)
For information on how to configure queries for the data sources listed above, refer to the documentation for specific data source. For information on how to configure queries for the data sources listed above, refer to the documentation for specific data source.
@ -57,8 +57,8 @@ Clicking anywhere on the span row shows span details.
{{< figure src="/static/img/docs/v70/explore-trace-view-span-details.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the trace view span details" >}} {{< figure src="/static/img/docs/v70/explore-trace-view-span-details.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the trace view span details" >}}
- Operation name - Operation name.
- Span metadata - Span metadata.
- Tags: Any tags associated with this span. - Tags: Any tags associated with this span.
- Process metadata: Metadata about the process that logged this span. - Process metadata: Metadata about the process that logged this span.
- Logs: List of logs logged by this span and associated key values. In case of Zipkin logs section shows Zipkin annotations. - Logs: List of logs logged by this span and associated key values. In case of Zipkin logs section shows Zipkin annotations.
@ -67,12 +67,18 @@ Clicking anywhere on the span row shows span details.
> **Note:** Available in Grafana 7.4 and later versions. > **Note:** Available in Grafana 7.4 and later versions.
You can navigate from a span in a trace view directly to logs relevant for that span. This is available for Tempo, Jaeger, and Zipkin data sources at this moment. Refer to their relevant documentation for instructions on how to configure this feature. You can navigate from a span in a trace view directly to logs relevant for that span. This feature is available for Tempo, Jaeger, and Zipkin data sources. Refer to their [relevant documentation](/docs/grafana/latest/datasources/tempo/#trace-to-logs) for configuration instructions.
{{< figure src="/static/img/docs/explore/trace-to-log-7-4.png" class="docs-image--no-shadow" max-width= "600px" caption="Screenshot of the trace view in Explore with icon next to the spans" >}} {{< figure src="/static/img/docs/explore/trace-to-log-7-4.png" class="docs-image--no-shadow" max-width= "600px" caption="Screenshot of the trace view in Explore with icon next to the spans" >}}
Click the document icon to open a split view in Explore with the configured data source and query relevant logs for the span. Click the document icon to open a split view in Explore with the configured data source and query relevant logs for the span.
### Trace to metrics
> **Note:** This feature is currently in beta & behind the `traceToMetrics` feature toggle.
You can navigate from a span in a trace view directly to metrics relevant for that span. This feature is available for Tempo, Jaeger, and Zipkin data sources. Refer to their [relevant documentation](/docs/grafana/latest/datasources/tempo/#trace-to-metrics) for configuration instructions.
## Node Graph ## Node Graph
You can optionally expand the node graph for the displayed trace. Depending on the data source, this can show spans of the trace as nodes in the graph, or as some additional context like service graph based on the current trace. You can optionally expand the node graph for the displayed trace. Depending on the data source, this can show spans of the trace as nodes in the graph, or as some additional context like service graph based on the current trace.
@ -84,7 +90,7 @@ You can optionally expand the node graph for the displayed trace. Depending on t
The Service Graph visualizes the span metrics (traces data for rates, error rates, and durations (RED)) and service graphs. The Service Graph visualizes the span metrics (traces data for rates, error rates, and durations (RED)) and service graphs.
Once the requirements are set up, this pre-configured view is immediately available. Once the requirements are set up, this pre-configured view is immediately available.
For more information, refer to the [Service Graph view table section](https://grafana.com/docs/grafana/latest/datasources/tempo/#service-graph-view-table) of the Tempo data source page and the [service graph view page](https://grafana.com/docs/tempo/latest/metrics-generator/service-graph-view/) in the Tempo documentation. For more information, refer to the [Service Graph view section]({{< relref "/docs/grafana/latest/datasources/tempo/#open-the-service-graph-view" >}}) of the Tempo data source page and the [service graph view page]({{< relref "/docs/tempo/latest/metrics-generator/service-graph-view/" >}}) in the Tempo documentation.
{{< figure src="/static/img/docs/grafana-cloud/apm-overview.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the Service Graph view" >}} {{< figure src="/static/img/docs/grafana-cloud/apm-overview.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the Service Graph view" >}}
@ -118,4 +124,4 @@ Optional fields:
| stackTraces | string[] | List of stack traces associated with the current span. | | stackTraces | string[] | List of stack traces associated with the current span. |
| errorIconColor | string | Color of the error icon in case span is tagged with `error: true`. | | errorIconColor | string | Color of the error icon in case span is tagged with `error: true`. |
For details about the types see [TraceSpanRow](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/trace.ts#L28), [TraceKeyValuePair](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/trace.ts#L4) and [TraceLog](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/trace.ts#L12) For details about the types see [TraceSpanRow](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/trace.ts#L28), [TraceKeyValuePair](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/trace.ts#L4) and [TraceLog](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/types/trace.ts#L12).

6
public/app/core/components/TraceToLogs/TraceToLogsSettings.tsx
View File

@ -168,7 +168,7 @@ export function TraceToLogsSettings({ options, onOptionsChange }: Props) {
<InlineFieldRow> <InlineFieldRow>
<InlineField <InlineField
tooltip="Use a custom query with possibility to interpolate variables from the trace or span" tooltip="Use a custom query with the possibility to interpolate variables from the trace or span"
label="Use custom query" label="Use custom query"
labelWidth={26} labelWidth={26}
> >
@ -241,11 +241,11 @@ function TimeRangeShift(props: TimeRangeShiftProps) {
label={`Span ${props.type} time shift`} label={`Span ${props.type} time shift`}
labelWidth={26} labelWidth={26}
grow grow
tooltip={`Shifts the ${props.type} time of the span. Default: 0 (Time units can be used here, for example: 5s, 1m, 3h)`} tooltip={`Shifts the ${props.type} time of the span. Default: 0 (Time units can be used here, for example: 5s, -1m, 3h)`}
> >
<Input <Input
type="text" type="text"
placeholder="1h" placeholder="0"
width={40} width={40}
onChange={(e) => props.onChange(e.currentTarget.value)} onChange={(e) => props.onChange(e.currentTarget.value)}
value={props.value} value={props.value}

39
public/app/core/components/TraceToMetrics/TraceToMetricsSettings.tsx
View File

@ -78,30 +78,16 @@ export function TraceToMetricsSettings({ options, onOptionsChange }: Props) {
) : null} ) : null}
</InlineFieldRow> </InlineFieldRow>
<InlineFieldRow>
<InlineField tooltip="Tags that will be used in the metrics query" label="Tags" labelWidth={26}>
<TagMappingInput
values={options.jsonData.tracesToMetrics?.tags ?? []}
onChange={(v) =>
updateDatasourcePluginJsonDataOption({ onOptionsChange, options }, 'tracesToMetrics', {
...options.jsonData.tracesToMetrics,
tags: v,
})
}
/>
</InlineField>
</InlineFieldRow>
<InlineFieldRow> <InlineFieldRow>
<InlineField <InlineField
label="Span start time shift" label="Span start time shift"
labelWidth={26} labelWidth={26}
grow grow
tooltip="Shifts the start time of the span. Default: 0 (Time units can be used here, for example: 5s, 1m, 3h)" tooltip="Shifts the start time of the span. Default: 0 (Time units can be used here, for example: 5s, -1m, 3h)"
> >
<Input <Input
type="text" type="text"
placeholder="-1h" placeholder="0"
width={40} width={40}
onChange={(v) => onChange={(v) =>
updateDatasourcePluginJsonDataOption({ onOptionsChange, options }, 'tracesToMetrics', { updateDatasourcePluginJsonDataOption({ onOptionsChange, options }, 'tracesToMetrics', {
@ -119,11 +105,11 @@ export function TraceToMetricsSettings({ options, onOptionsChange }: Props) {
label="Span end time shift" label="Span end time shift"
labelWidth={26} labelWidth={26}
grow grow
tooltip="Shifts the end time of the span. Default: 0 (Time units can be used here, for example: 5s, 1m, 3h)" tooltip="Shifts the end time of the span. Default: 0 (Time units can be used here, for example: 5s, -1m, 3h)"
> >
<Input <Input
type="text" type="text"
placeholder="1h" placeholder="0"
width={40} width={40}
onChange={(v) => onChange={(v) =>
updateDatasourcePluginJsonDataOption({ onOptionsChange, options }, 'tracesToMetrics', { updateDatasourcePluginJsonDataOption({ onOptionsChange, options }, 'tracesToMetrics', {
@ -136,14 +122,29 @@ export function TraceToMetricsSettings({ options, onOptionsChange }: Props) {
</InlineField> </InlineField>
</InlineFieldRow> </InlineFieldRow>
<InlineFieldRow>
<InlineField tooltip="Tags that will be used in the metrics query" label="Tags" labelWidth={26}>
<TagMappingInput
values={options.jsonData.tracesToMetrics?.tags ?? []}
onChange={(v) =>
updateDatasourcePluginJsonDataOption({ onOptionsChange, options }, 'tracesToMetrics', {
...options.jsonData.tracesToMetrics,
tags: v,
})
}
/>
</InlineField>
</InlineFieldRow>
{options.jsonData.tracesToMetrics?.queries?.map((query, i) => ( {options.jsonData.tracesToMetrics?.queries?.map((query, i) => (
<div key={i} className={styles.queryRow}> <div key={i} className={styles.queryRow}>
<InlineField label="Link Label" labelWidth={10}> <InlineField label="Link Label" labelWidth={26} tooltip="Descriptive label for the linked query">
<Input <Input
label="Link Label" label="Link Label"
type="text" type="text"
allowFullScreen allowFullScreen
value={query.name} value={query.name}
width={40}
onChange={(e) => { onChange={(e) => {
let newQueries = options.jsonData.tracesToMetrics?.queries.slice() ?? []; let newQueries = options.jsonData.tracesToMetrics?.queries.slice() ?? [];
newQueries[i].name = e.currentTarget.value; newQueries[i].name = e.currentTarget.value;

4
public/app/features/explore/TraceView/components/settings/SpanBarSettings.tsx
View File

@ -52,7 +52,7 @@ export default function SpanBarSettings({ options, onOptionsChange }: Props) {
placeholder="Duration" placeholder="Duration"
isClearable isClearable
aria-label={'select-label-name'} aria-label={'select-label-name'}
width={25} width={40}
/> />
</InlineField> </InlineField>
</InlineFieldRow> </InlineFieldRow>
@ -73,7 +73,7 @@ export default function SpanBarSettings({ options, onOptionsChange }: Props) {
}) })
} }
value={options.jsonData.spanBar?.tag || ''} value={options.jsonData.spanBar?.tag || ''}
width={25} width={40}
/> />
</InlineField> </InlineField>
</InlineFieldRow> </InlineFieldRow>