From 483ca71621c62985758084919e09ff568a409e4f Mon Sep 17 00:00:00 2001 From: Joey Tawadrous <90795735+joey-grafana@users.noreply.github.com> Date: Fri, 13 Jan 2023 17:22:34 +0000 Subject: [PATCH] Docs: Update trace to logs docs (#61099) * Extend trace to logs docs * Update docs text * Update trace to logs tag types format * adjusts formatting of unorderedlist * adjusts formatting, adds intro to table * Update docs/sources/datasources/zipkin/_index.md Co-authored-by: Joey Tawadrous <90795735+joey-grafana@users.noreply.github.com> * added table intros Co-authored-by: Chris Moyer Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> --- docs/sources/datasources/jaeger/_index.md | 19 +++++++++++++++++-- docs/sources/datasources/tempo/_index.md | 14 ++++++++++++-- docs/sources/datasources/zipkin/_index.md | 20 ++++++++++++++++++-- 3 files changed, 47 insertions(+), 6 deletions(-) diff --git a/docs/sources/datasources/jaeger/_index.md b/docs/sources/datasources/jaeger/_index.md index c9ae0ebde24..d5f3f3b106e 100644 --- a/docs/sources/datasources/jaeger/_index.md +++ b/docs/sources/datasources/jaeger/_index.md @@ -47,10 +47,25 @@ You can also configure settings specific to the Jaeger data source: ### Configure trace to logs +{{< figure src="/static/img/docs/explore/traces-to-logs-settings-8-2.png" class="docs-image--no-shadow" caption="Screenshot of the trace to logs settings" >}} + > **Note:** Available in Grafana v7.4 and higher. -The **Trace to logs** section configures the [trace to logs feature]({{< relref "../../explore/trace-integration/" >}}). -Select a target data source, limited to Loki and Splunk \[logs\] data sources, and which tags to use in the logs query. +The **Trace to logs** setting configures the [trace to logs feature]({{< relref "../../explore/trace-integration" >}}) that is available when you integrate Grafana with Jaeger. + +**To configure trace to logs:** + +1. Select the target data source. +2. 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. + - **Single tag** + - Configuring `job` as a tag and clicking on a span link will take you to your configured logs datasource with the query `{job='value from clicked span'}`. + - **Multiple tags** + - If multiple tags are used they will be concatenated so the logs query would look like `{job='value from clicked span', service='value from clicked span'}`. + - **Mapped tags** + - For a mapped tag `service.name` with value `service`, clicking on a span link will take you to your configured logs datasource with the query `{service='value from clicked span'}` instead of `{service.name='value from clicked span'}`. + - This is useful for instances where your tracing datasource tags and your logs datasource tags don't match one-to-one. + +The following table describes the ways in which you can configure your trace to logs settings: | Name | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/sources/datasources/tempo/_index.md b/docs/sources/datasources/tempo/_index.md index 1c5dc8a0727..c3f87a28360 100644 --- a/docs/sources/datasources/tempo/_index.md +++ b/docs/sources/datasources/tempo/_index.md @@ -53,12 +53,22 @@ You can also configure settings specific to the Tempo data source: > **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" >}}) available when integrating Grafana with Tempo. +The **Trace to logs** setting configures the [trace to logs feature]({{< relref "../../explore/trace-integration" >}}) that is available when you integrate Grafana with Tempo. **To configure trace to logs:** 1. Select the target data source. -1. Select which tags to use in the logs query. +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. + + - **Single tag** + - Configuring `job` as a tag and clicking on a span link will take you to your configured logs datasource with the query `{job='value from clicked span'}`. + - **Multiple tags** + - If multiple tags are used they will be concatenated so the logs query would look like `{job='value from clicked span', service='value from clicked span'}`. + - **Mapped tags** + - For a mapped tag `service.name` with value `service`, clicking on a span link will take you to your configured logs datasource with the query `{service='value from clicked span'}` instead of `{service.name='value from clicked span'}`. + - This is useful for instances where your tracing datasource tags and your logs datasource tags don't match one-to-one. + +The following table describes the ways in which you can configure your trace to logs settings: | Setting name | Description | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/sources/datasources/zipkin/_index.md b/docs/sources/datasources/zipkin/_index.md index 9adb88eae88..833c5f8aa7c 100644 --- a/docs/sources/datasources/zipkin/_index.md +++ b/docs/sources/datasources/zipkin/_index.md @@ -44,10 +44,26 @@ Set the data source's basic configuration options carefully: ### Configure trace to logs +{{< figure src="/static/img/docs/explore/traces-to-logs-settings-8-2.png" class="docs-image--no-shadow" caption="Screenshot of the trace to logs settings" >}} + > **Note:** Available in Grafana v7.4 and higher. -The **Trace to logs** section configures the [trace to logs feature]({{< relref "../../explore/trace-integration/" >}}). -Select a target data source, limited to Loki and Splunk \[logs\] data sources, and which tags to use in the logs query. +The **Trace to logs** setting configures the [trace to logs feature]({{< relref "../../explore/trace-integration" >}}) that is available when you integrate Grafana with Zipkin. + +**To configure trace to logs:** + +1. Select the target data source. +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. + + - **Single tag** + - Configuring `job` as a tag and clicking on a span link will take you to your configured logs datasource with the query `{job='value from clicked span'}`. + - **Multiple tags** + - If multiple tags are used they will be concatenated so the logs query would look like `{job='value from clicked span', service='value from clicked span'}`. + - **Mapped tags** + - For a mapped tag `service.name` with value `service`, clicking on a span link will take you to your configured logs datasource with the query `{service='value from clicked span'}` instead of `{service.name='value from clicked span'}`. + - This is useful for instances where your tracing datasource tags and your logs datasource tags don't match one-to-one. + +The following table describes the ways in which you can configure your trace to logs settings: | Name | Description | | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |