Revert some scenes documentation (#92222)
This commit is contained in:
Jack Baldry
@@ -249,7 +249,5 @@ If you want to add all of the current dashboard's variables to the URL, then use
|
||||
|
||||
1. If you want the link to open in a new tab, toggle the **Open in a new tab** switch.
|
||||
1. Click **Save** to save changes and close the dialog box.
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and then **Exit edit**.
|
||||
|
||||
If you add multiple data links, you can control the order in which they appear in the visualization. To do this, click and drag the data link to the desired position.
|
||||
1. Click **Apply** to see your changes in the dashboard.
|
||||
1. Click the **Save dashboard** icon to save your changes to the dashboard.
|
||||
|
||||
@@ -244,8 +244,7 @@ To add a field override, follow these steps:
|
||||
1. Select the field option that you want to apply.
|
||||
1. Continue to add overrides to this field by clicking **Add override property**.
|
||||
1. Add as many overrides as you need.
|
||||
1. When you're finished, click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and then **Exit edit**.
|
||||
1. When you're finished, click **Save** to save all panel edits to the dashboard.
|
||||
|
||||
## Edit a field override
|
||||
|
||||
@@ -260,7 +259,5 @@ To edit a field override, follow these steps:
|
||||
- Edit settings on existing overrides or field selection parameters.
|
||||
- Delete existing override properties by clicking the **X** next to the property.
|
||||
- Delete an override entirely by clicking the trash icon at the top-right corner.
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and then **Exit edit**.
|
||||
|
||||
The changes you make take effect immediately.
|
||||
|
||||
@@ -95,8 +95,7 @@ To configure repeating panels, follow these steps:
|
||||
- **Vertical** - Arrange panels in a column. The width of repeated panels is the same as the original, repeated panel.
|
||||
|
||||
1. If you selected **Horizontal** in the previous step, select a value in the **Max per row** drop-down list to control the maximum number of panels that can be in a row.
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and then **Exit edit**.
|
||||
1. Click **Save**.
|
||||
1. To propagate changes to all panels, reload the dashboard.
|
||||
|
||||
You can stop a panel from repeating by selecting **Disable repeating** in the **Repeat by variable** drop-down list.
|
||||
|
||||
@@ -174,8 +174,6 @@ You can add as many thresholds to a visualization as you want. Grafana automatic
|
||||
1. Click the colored circle to the left of the threshold value to open the color picker, where you can update the threshold color.
|
||||
1. Under **Thresholds mode**, select either **Absolute** or **Percentage**.
|
||||
1. Under **Show thresholds**, set how the threshold is displayed or turn it off.
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and then **Exit edit**.
|
||||
|
||||
To delete a threshold, navigate to the panel that contains the threshold and click the trash icon next to the threshold you want to remove.
|
||||
|
||||
|
||||
@@ -185,6 +185,3 @@ The following image shows a table visualization with value mappings. If you want
|
||||
1. Click **Update** to save the value mapping.
|
||||
|
||||
After you've added a mapping, the **Edit value mappings** button replaces the **Add value mappings** button. Click the edit button to add or update mappings.
|
||||
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and then **Exit edit**.
|
||||
|
||||
@@ -52,7 +52,7 @@ refs:
|
||||
|
||||
In the panel editor, you can update all the elements of a visualization including the data source, queries, time range, and visualization display options.
|
||||
|
||||
|
||||
|
||||
|
||||
This following sections describe the areas of the Grafana panel editor.
|
||||
|
||||
@@ -60,25 +60,26 @@ This following sections describe the areas of the Grafana panel editor.
|
||||
|
||||
The header section lists the dashboard in which the panel appears and the following controls:
|
||||
|
||||
- **Back to dashboard** - Return to the dashboard with changes applied, but not yet saved.
|
||||
- **Discard panel changes** - Discard changes you have made to the panel since you last saved the dashboard.
|
||||
- **Save dashboard** - Save your changes to the dashboard.
|
||||
- **Discard:** Discards changes you have made to the panel since you last saved the dashboard.
|
||||
- **Save:** Saves changes you made to the panel.
|
||||
- **Apply:** Applies changes you made and closes the panel editor, returning you to the dashboard. You'll have to save the dashboard to persist the applied changes.
|
||||
|
||||
## Visualization preview
|
||||
|
||||
The visualization preview section contains the following options:
|
||||
|
||||
- **Table view** - Convert any visualization to a table so you can see the data. Table views are helpful for troubleshooting. This view only contains the raw data. It doesn't include transformations you might have applied to the data or the formatting options available in the [Table](ref:table) visualization.
|
||||
- **Time range controls** - **Default** is either the browser local timezone or the timezone selected at a higher level.
|
||||
- **Refresh** - Query the data source.
|
||||
- **Table view:** Convert any visualization to a table so you can see the data. Table views are helpful for troubleshooting. This view only contains the raw data. It doesn't include transformations you might have applied to the data or the formatting options available in the [Table](ref:table) visualization.
|
||||
- **Fill:** The visualization preview fills the available space. If you change the width of the side pane or height of the bottom pane the visualization changes to fill the available space.
|
||||
- **Actual:** The visualization preview has the exact size as the size on the dashboard. If not enough space is available, the visualization scales down preserving the aspect ratio.
|
||||
- **Time range controls:** **Default** is either the browser local timezone or the timezone selected at a higher level.
|
||||
|
||||
## Data section
|
||||
|
||||
The data section contains tabs where you enter queries, transform your data, and create alert rules (if applicable).
|
||||
|
||||
- **Queries** - Select your data source and enter queries here. For more information, refer to [Add a query](ref:add-a-query). When you create a new dashboard, you'll be prompted to select a data source before you get to the panel editor. You set or update the data source in existing dashboards using the drop-down in the **Queries** tab.
|
||||
- **Transformations** - Apply data transformations. For more information, refer to [Transform data](ref:transform-data).
|
||||
- **Alert** - Write alert rules. For more information, refer to [the overview of Grafana Alerting](ref:the-overview-of-grafana-alerting).
|
||||
- **Query tab:** Select your data source and enter queries here. For more information, refer to [Add a query](ref:add-a-query). When you create a new dashboard, you'll be prompted to select a data source before you get to the panel editor. You set or update the data source in existing dashboards using the drop-down in the **Query** tab.
|
||||
- **Transform tab:** Apply data transformations. For more information, refer to [Transform data](ref:transform-data).
|
||||
- **Alert tab:** Write alert rules. For more information, refer to [the overview of Grafana Alerting](ref:the-overview-of-grafana-alerting).
|
||||
|
||||
## Panel display options
|
||||
|
||||
|
||||
@@ -175,12 +175,9 @@ To add a panel in a new dashboard click **+ Add visualization** in the middle of
|
||||
|
||||
|
||||
|
||||
To add a panel to an existing dashboard, follow these steps:
|
||||
To add a panel to an existing dashboard, click **Add** in the dashboard header and select **Visualization** in the drop-down:
|
||||
|
||||
1. Click **Edit** in the top-right corner of the dashboard.
|
||||
1. Click the **Add** drop-down and select **Visualization**:
|
||||
|
||||
|
||||
|
||||
|
||||
## Panel configuration
|
||||
|
||||
|
||||
@@ -41,6 +41,10 @@ refs:
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/datasources/tempo/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/connect-externally-hosted/data-sources/tempo/
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/datasources/tempo/
|
||||
- pattern: /docs/grafana-cloud/
|
||||
destination: /docs/grafana-cloud/connect-externally-hosted/data-sources/tempo/
|
||||
configure-panel-options-documentation:
|
||||
- pattern: /docs/grafana/
|
||||
destination: /docs/grafana/<GRAFANA_VERSION>/panels-visualizations/configure-panel-options/
|
||||
@@ -86,30 +90,20 @@ For more information on the panel editor, refer to the [Panel editor documentati
|
||||
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.
|
||||
|
||||
1. From your Grafana stack, create a new dashboard or go to an existing dashboard where you'd like to add traces visualizations.
|
||||
1. Do one of the following:
|
||||
|
||||
- New dashboard - Click **+ Add visualization**.
|
||||
- Existing dashboard - Click **Edit** in the top-right corner and then select **Visualization** in the **Add** drop-down.
|
||||
|
||||
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 corner 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](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, click the **TraceQL** query type tab.
|
||||
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](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.
|
||||
|
||||
{{< figure src="/static/img/docs/panels/traces/screenshot-traces-template-query.png" caption="Add a template query" >}}
|
||||
|
||||
1. Click **Back to dashboard**.
|
||||
1. Click **Settings** and go to the **Variables** tab.
|
||||
1. Add a new variable called `traceId`, of variable type **Custom**, giving it a label if required.
|
||||
1. Select **Apply** in the panel editor to add the panel to the dashboard.
|
||||
1. Go to the dashboard **Settings** and add a new variable called `traceId`, of variable type **Custom**, giving it a label if required. Select **Apply** to add the variable to the dashboard.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/screenshot-traces-custom-variable-11.2.png" max-width="50%" caption="Add a Custom variable" >}}
|
||||
{{< figure src="/static/img/docs/panels/traces/screenshot-traces-custom-variable.png" max-width="50%" caption="Add a Custom variable" >}}
|
||||
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and **Exit edit**.
|
||||
1. Verify that the panel works by using a valid trace ID for the data source used for the trace panel and editing the ID in the dashboard variable.
|
||||
|
||||
{{< figure src="/static/img/docs/panels/traces/screenshot-traces-traceid-panel.png" caption="Results of query in trace panel" >}}
|
||||
@@ -119,19 +113,15 @@ This procedure uses dashboard variables and templates to allow you to enter trac
|
||||
While you can add a trace visualization to a dashboard, having to manually add trace IDs as a dashboard variable is cumbersome.
|
||||
It’s more useful to instead be able to use TraceQL queries to search for specific types of traces and then select appropriate traces from matching results.
|
||||
|
||||
1. In the same dashboard where you added the trace visualization, click **Edit** in the top-right corner.
|
||||
1. In the **Add** drop-down, select **Visualization**.
|
||||
1. In the same dashboard where you added the trace visualization, select **Add panel** to add a new visualization panel.
|
||||
1. Select the same trace data source you used in the previous section.
|
||||
1. In the top-right corner of the panel editor, select the **Visualizations** tab, search for, and select **Table**.
|
||||
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](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" >}}
|
||||
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and **Exit edit**.
|
||||
|
||||
When results are returned from a query, the results are rendered in the panel’s table.
|
||||
|
||||
{{< figure src="/static/img/docs/panels/traces/screenshot-traces-returned-query.png" caption="Results of a returned query in the panel table" >}}
|
||||
@@ -142,7 +132,7 @@ The results in the traces visualization include links to the **Explore** page th
|
||||
|
||||
To create a set of data links in the panel, use the following steps:
|
||||
|
||||
1. In the panel editor menu, under **Data links**, click **Add link**.
|
||||
1. In the right-side menu, under **Data links**, select **Add link**.
|
||||
1. Add a **Title** for the data link.
|
||||
1. Find the UUID of the dashboard by looking in your browser’s address bar when the full dashboard is being rendered. Because this is a link to a dashboard in the same Grafana stack, only the path of the dashboard is required.
|
||||
|
||||
@@ -154,8 +144,8 @@ To create a set of data links in the panel, use the following steps:
|
||||
{{< figure src="/static/img/docs/panels/traces/screenshot-traces-edit-link.png" caption="Edit link and add the Trace link" >}}
|
||||
|
||||
1. Select **Save** to save the data link.
|
||||
1. Click **Save dashboard**.
|
||||
1. Click **Back to dashboard** and **Exit edit**.
|
||||
1. Select **Apply** from the panel editor to apply the panel to the dashboard.
|
||||
1. Save the dashboard.
|
||||
|
||||
You should now see a list of matching traces in the table visualization. While selecting the **TraceID** or **SpanID** fields will give you the option to either open the **Explore** page to visualize the trace or following the data link, selecting any other field (such as **Start time**, **Name** or **Duration**) automatically follows the data link, filling in the `traceId` dashboard variable, and then shows the relevant trace in the trace panel.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user