[v11.0.x] [docs/sources/panels-visualizations] Replace docs/reference shortcode with ref URIs (#88056)
This commit is contained in:
Jack Baldry
@@ -15,6 +15,25 @@ labels:
|
||||
description: Configure options for Grafana's traces visualization
|
||||
title: Traces
|
||||
weight: 100
|
||||
refs:
|
||||
panel-editor-documentation:
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/panel-editor-overview/
|
||||
generative-ai-features:
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/dashboards/manage-dashboards/#set-up-generative-ai-features-for-dashboards
|
||||
tracing-in-explore:
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/explore/trace-integration/
|
||||
variables-documentation:
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/dashboards/variables/
|
||||
tempo-data-source:
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/connect-externally-hosted/data-sources/tempo/
|
||||
configure-panel-options-documentation:
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/visualizations/panels-visualizations/configure-panel-options/
|
||||
---
|
||||
|
||||
# Traces
|
||||
@@ -24,8 +43,8 @@ The traces visualization displays traces data in a diagram that allows you to ea
|
||||
|
||||
For more information about traces and how to use them, refer to the following documentation:
|
||||
|
||||
- [Tracing in Explore][]
|
||||
- [Tempo data source][]
|
||||
- [Tracing in Explore](ref:tracing-in-explore)
|
||||
- [Tempo data source](ref:tempo-data-source)
|
||||
- [Getting started with Tempo](/docs/tempo/latest/getting-started)
|
||||
|
||||
{{< figure src="/static/img/docs/explore/trace-view-9-4.png" class="docs-image--no-shadow" max-width= "900px" caption="Screenshot of the trace view" >}}
|
||||
@@ -35,20 +54,20 @@ For more information about traces and how to use them, refer to the following do
|
||||
Once you have tracing data available in your Grafana stack, you can add tracing panels to your Grafana dashboards.
|
||||
|
||||
Using a dashboard variable, `traceID`, lets you create a query to show specific traces for a given trace ID.
|
||||
For more information about dashboard variables, refer to the [Variables documentation][].
|
||||
For more information about dashboard variables, refer to the [Variables documentation](ref:variables-documentation).
|
||||
|
||||
### Before you begin
|
||||
|
||||
To use this procedure, you need:
|
||||
|
||||
- A Grafana instance
|
||||
- A [Tempo data source][] connected to your Grafana instance
|
||||
- A [Tempo data source](ref:tempo-data-source) connected to your Grafana instance
|
||||
|
||||
### Add the traces visualization query {#add-the-traces-panel-query}
|
||||
|
||||
To view and analyze traces data in a dashboard, you need to add the traces visualization to your dashboard and define a query using the panel editor.
|
||||
The query determines the data that is displayed in the visualization.
|
||||
For more information on the panel editor, refer to the [Panel editor documentation][].
|
||||
For more information on the panel editor, refer to the [Panel editor documentation](ref:panel-editor-documentation).
|
||||
|
||||
This procedure uses dashboard variables and templates to allow you to enter trace IDs which can then be visualized. You'll use a variable called `traceId` and add it as a template query.
|
||||
|
||||
@@ -56,7 +75,7 @@ This procedure uses dashboard variables and templates to allow you to enter trac
|
||||
1. Select **Add visualization** from a new dashboard or select **Add Panel** on an existing dashboard.
|
||||
1. Search for and select the appropriate tracing data source.
|
||||
1. In the top-right of the panel editor, select the **Visualizations** tab, search for, and select **Traces**.
|
||||
1. Under the **Panel options**, enter a **Title** for your trace panel or have Grafana create one using [generative AI features][]. For more information on the panel editor, refer to the [Configure panel options documentation][].
|
||||
1. Under the **Panel options**, enter a **Title** for your trace panel or have Grafana create one using [generative AI features](ref:generative-ai-features). For more information on the panel editor, refer to the [Configure panel options documentation](ref:configure-panel-options-documentation).
|
||||
1. In the query editor, select the **TraceQL** query type tab.
|
||||
1. Enter `${traceId}` in the TraceQL query field to create a dashboard variable. This variable is used as the template query.
|
||||
|
||||
@@ -80,7 +99,7 @@ It’s more useful to instead be able to use TraceQL queries to search for speci
|
||||
1. Select the same trace data source you used in the previous section.
|
||||
1. In the top-right of the panel editor, select the **Visualizations** tab, search for, and select **Table**.
|
||||
1. In the query editor, select the **TraceQL** tab.
|
||||
1. Under the **Panel options**, enter a **Title** for your trace panel or have Grafana create one using [generative AI features][].
|
||||
1. Under the **Panel options**, enter a **Title** for your trace panel or have Grafana create one using [generative AI features](ref:generative-ai-features).
|
||||
1. Add an appropriate TraceQL query to search for traces that you would like to visualize in the dashboard. This example uses a simple, static query. You can write the TraceQL query as a template query to take advantage of other dashboard variables, if they exist. This lets you create dynamic queries based on these variables.
|
||||
|
||||
{{< figure src="/static/img/docs/panels/traces/screenshot-traces-dynamic-query.png" caption="Create a dynamic query" >}}
|
||||
@@ -119,26 +138,3 @@ You should now see a list of matching traces in the table visualization. While s
|
||||
## Panel options
|
||||
|
||||
{{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}
|
||||
|
||||
{{% docs/reference %}}
|
||||
[Tracing in Explore]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/explore/trace-integration"
|
||||
[Tracing in Explore]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA_VERSION>/explore/trace-integration"
|
||||
|
||||
[Tempo data source]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/datasources/tempo"
|
||||
[Tempo data source]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/tempo"
|
||||
|
||||
[Panel editor documentation]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/panel-editor-overview"
|
||||
[Panel editor documentation]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/panel-editor-overview"
|
||||
|
||||
[Variables documentation]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/dashboards/variables"
|
||||
[Variables documentation]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/dashboards/variables"
|
||||
|
||||
[Configure panel options documentation]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/configure-panel-options"
|
||||
[Configure panel options documentation]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-panel-options"
|
||||
|
||||
[Tempo data source]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/datasources/tempo"
|
||||
[Tempo data source]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/tempo"
|
||||
|
||||
[generative AI features]: "/docs/grafana/ -> /docs/grafana/<GRAFANA_VERSION>/dashboards/manage-dashboards#set-up-generative-ai-features-for-dashboards"
|
||||
[generative AI features]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/dashboards/manage-dashboards#set-up-generative-ai-features-for-dashboards"
|
||||
{{% /docs/reference %}}
|
||||
|
||||
Reference in New Issue
Block a user