mirror of
https://github.com/grafana/grafana.git
synced 2025-02-20 11:48:34 -06:00
596e5b43d9
* Jaeger and Zipkin upgrades docs and condig * Update text * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/jaeger/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/tempo/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/tempo/query-editor/index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/tempo/query-editor/index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/zipkin/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/zipkin/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/datasources/zipkin/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Minor text formatting updates * yarn prettier:write * Update docs/sources/datasources/zipkin/_index.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> --------- Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
213 lines
18 KiB
Markdown
213 lines
18 KiB
Markdown
---
|
|
aliases:
|
|
- ../data-sources/zipkin/
|
|
- ../data-sources/zipkin/query-editor/
|
|
description: Guide for using Zipkin in Grafana
|
|
keywords:
|
|
- grafana
|
|
- zipkin
|
|
- tracing
|
|
- querying
|
|
menuTitle: Zipkin
|
|
title: Zipkin data source
|
|
weight: 1600
|
|
---
|
|
|
|
# Zipkin data source
|
|
|
|
Grafana ships with built-in support for Zipkin, an open source, distributed tracing system. This topic explains configuration and queries specific to the Zipkin data source.
|
|
|
|
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.
|
|
Administrators can also [configure the data source via YAML]({{< relref "#provision-the-data-source" >}}) with Grafana's provisioning system.
|
|
|
|
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/" >}}).
|
|
|
|
## Configure the data source
|
|
|
|
**To access the data source configuration page:**
|
|
|
|
1. Hover the cursor over the **Configuration** (gear) icon.
|
|
1. Select **Data Sources**.
|
|
1. Select the Zipkin data source.
|
|
|
|
Set the data source's basic configuration options carefully:
|
|
|
|
| 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 Zipkin instance, such as `http://localhost:9411`. |
|
|
| **Basic Auth** | Enables basic authentication for the Zipkin data source. |
|
|
| **User** | Defines the user name for basic authentication. |
|
|
| **Password** | Defines the password for basic authentication. |
|
|
|
|
### Trace to logs
|
|
|
|
|
|
|
|
> **Note:** Available in Grafana v7.4 and higher.
|
|
> If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature.
|
|
|
|
The **Trace to logs** setting configures the [trace to logs feature]({{< relref "../../explore/trace-integration" >}}) that is available when you integrate Grafana with Zipkin.
|
|
|
|
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]({{< relref "../../dashboards/variables/variable-syntax">}}) to interpolate variables from the trace or span.
|
|
|
|
#### Use a simple configuration
|
|
|
|
1. Select the target data source.
|
|
1. 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.
|
|
1. 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 using dots in labels. In that case, you can for example remap `http.status` to `http_status`.
|
|
1. 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.
|
|
1. 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.
|
|
1. 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 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 when the tag has dots in the name and the target data source does not allow using 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}"`.
|
|
1. Skip **Filter by trace ID** and **Filter by span ID** settings as these cannot be used with a custom query.
|
|
1. Switch on **Use custom query**.
|
|
1. 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.
|
|
|
|
#### Variables that can be used in a custom query
|
|
|
|
To use a variable you need to wrap it in `${}`. For example `${__span.name}`.
|
|
|
|
| Variable name | Description |
|
|
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **\_\_tags** | This 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.spanId** | The ID of the span. |
|
|
| **\_\_span.traceId** | The ID of the trace. |
|
|
| **\_\_span.duration** | The duration of the span. |
|
|
| **\_\_span.name** | Name of the span. |
|
|
| **\_\_span.tags** | Namespace 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.traceId** | The ID of the trace. |
|
|
| **\_\_trace.duration** | The duration of the trace. |
|
|
| **\_\_trace.name** | The name of the trace. |
|
|
|
|
The following table describes the ways in which you can configure your trace to logs settings:
|
|
|
|
| Setting name | Description |
|
|
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **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 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`. |
|
|
| **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. |
|
|
| **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. |
|
|
|
|
### Trace to metrics
|
|
|
|
> **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.
|
|
|
|
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.
|
|
|
|
To configure trace to metrics:
|
|
|
|
1. Select the target data source.
|
|
1. Create any desired linked queries.
|
|
|
|
| Setting name | Description |
|
|
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **Data source** | Defines the target data source. |
|
|
| **Tags** | Defines 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. |
|
|
|
|
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]({{< relref "../../panels-visualizations/visualizations/node-graph/" >}}), which is disabled by default.
|
|
|
|
Once enabled, Grafana displays the Node Graph after loading the trace view.
|
|
|
|
### Span bar label
|
|
|
|
The **Span bar label** section helps you display additional information in the span bar row.
|
|
|
|
You can choose one of three options:
|
|
|
|
| Name | Description |
|
|
| ------------ | -------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **None** | Adds nothing to 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`. |
|
|
|
|
## Query the data source
|
|
|
|
You can query and display traces from Zipkin via [Explore]({{< relref "../../explore/" >}}).
|
|
|
|
This topic explains configuration and queries specific to the Zipkin data source.
|
|
For general documentation on querying data sources in Grafana, see [Query and transform data]({{< relref "../../panels-visualizations/query-transform-data" >}}).
|
|
|
|
### Query by trace ID
|
|
|
|
To query a particular trace:
|
|
|
|
1. Select the **TraceID** query type.
|
|
1. Enter the trace's ID into the **Trace ID** field.
|
|
|
|
{{< figure src="/static/img/docs/v70/zipkin-query-editor.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor" >}}
|
|
|
|
### Query by trace selector
|
|
|
|
To select a particular trace from all traces logged in the time range you have selected in Explore, you can also query by trace selector.
|
|
The trace selector has three levels of nesting:
|
|
|
|
- The service you're interested in.
|
|
- Particular operation, part of the selected service
|
|
- Specific trace in which the selected operation occurred, represented by the root operation name and trace duration
|
|
|
|
{{< figure src="/static/img/docs/v70/zipkin-query-editor-open.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor with trace selector expanded" >}}
|
|
|
|
## View data mapping in the trace UI
|
|
|
|
You can view Zipkin annotations in the trace view as logs with annotation value displayed under the annotation key.
|
|
|
|
## 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.
|
|
|
|
{{< figure src="/static/img/docs/explore/zipkin-upload-json.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin data source in explore with upload selected" >}}
|
|
|
|
### Trace JSON example
|
|
|
|
```json
|
|
[
|
|
{
|
|
"traceId": "efe9cb8857f68c8f",
|
|
"parentId": "efe9cb8857f68c8f",
|
|
"id": "8608dc6ce5cafe8e",
|
|
"kind": "SERVER",
|
|
"name": "get /api",
|
|
"timestamp": 1627975249601797,
|
|
"duration": 23457,
|
|
"localEndpoint": { "serviceName": "backend", "ipv4": "127.0.0.1", "port": 9000 },
|
|
"tags": {
|
|
"http.method": "GET",
|
|
"http.path": "/api",
|
|
"jaxrs.resource.class": "Resource",
|
|
"jaxrs.resource.method": "printDate"
|
|
},
|
|
"shared": true
|
|
}
|
|
]
|
|
```
|
|
|
|
## Link 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.
|
|
|
|
For details, refer to [Derived fields]({{< relref "../loki/#configure-derived-fields" >}}) section of the [Loki data source]({{< relref "../loki/" >}}) documentation.
|