IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: improvements to visualizations docs (#69503)

Browse Source 
* made changes from PR 67118

* made changes from PR 67123

* made some changes from PR 67128

* made changes from PR 67129

* made changes from PR 67133
This commit is contained in:
Isabel 2023-06-07 11:28:37 -04:00 committed by GitHub
parent 994defeeb4
commit 337ffd3015
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/sources/panels-visualizations/configure-panel-options/index.md
View File

@ -19,7 +19,7 @@ weight: 2
# Configure panel options
A Grafana panel is the user interface you use to define a data source query, and transform and format data that appears in visualizations.
A Grafana panel is a visual representation of data that you can customize by defining a data source query, transforming and formatting data, and configuring visualization settings.
A panel editor includes a query builder and a series of options that you can use to transform data and add information to your panels.
@ -28,7 +28,7 @@ This topic describes how to:
- Open a panel for editing
- Add a panel title and description
- View a panel JSON model
- Add repeating rows and panels
- Configure repeating rows and panels
## Edit a panel
@ -78,7 +78,7 @@ Explore and export panel, panel data, and data frame JSON models.
- **Panel JSON:** Displays a JSON object representing the panel.
- **Panel data:** Displays a JSON object representing the data that was passed to the panel.
- **DataFrame structure:** Displays the raw result set with transformations, field configurations, and override configurations applied.
- **DataFrame structure:** Displays the data structure of the panel, including any transformations, field configurations, and override configurations that have been applied.
1. To explore the JSON, click `>` to expand or collapse portions of the JSON model.

12
docs/sources/panels-visualizations/configure-thresholds/index.md
View File

@ -15,7 +15,7 @@ weight: 300
# Configure thresholds
This section includes information about using thresholds in your visualizations. You'll learn about thresholds and their defaults, how to add or delete a threshold, and adding a threshold to a legacy panel.
This section includes information about using thresholds in your visualizations. You'll learn about thresholds, their defaults, how to add or delete a threshold, and adding a threshold to a legacy panel.
## About thresholds
@ -25,7 +25,7 @@ Thresholds provide one method for you to conditionally style and color your visu
You can use thresholds to:
- Color grid lines or grid ares areas in the [Time-series visualization]({{< relref "../visualizations/time-series/" >}})
- Color grid lines or grid areas in the [Time-series visualization]({{< relref "../visualizations/time-series/" >}})
- Color lines in the [Time-series visualization]({{< relref "../visualizations/time-series#from-thresholds" >}})
- Color the background or value text in the [Stat visualization]({{< relref "../visualizations/stat/" >}})
- Color the gauge and threshold markers in the [Gauge visualization]({{< relref "../visualizations/gauge/" >}})
@ -52,7 +52,7 @@ The **Base** value represents minus infinity. It is generally the “good” col
You can add as many thresholds to a panel as you want. Grafana automatically sorts thresholds values from highest to lowest.
Delete a threshold when it is no longer relevant to your business operations. When you delete a threshold, the system removes the threshold from all visualizations that include the threshold.
Delete a threshold when it is no longer needed. When you delete a threshold, the system removes the threshold from all visualizations that include the threshold.
1. To add a threshold:
@ -83,7 +83,7 @@ In the Graph panel visualization, thresholds enable you to add lines or sections
- **critical -** Fill and line color are red.
- **warning -** Fill and line color are yellow.
- **ok -** Fill and line color are green.
- **Fill -** Controls whether the threshold fill is displayed.
- **Line -** Controls whether the threshold line is displayed.
- **Y-Axis -** Choose **left** or **right**.
- **Fill -** Toggle the display of the threshold fill.
- **Line -** Toggle the display of the threshold line.
- **Y-Axis -** Choose to display the y-axis on either the **left** or **right** of the panel.
1. Click **Save** to save the changes in the dashboard.

8
docs/sources/panels-visualizations/configure-value-mappings/index.md
View File

@ -18,18 +18,18 @@ weight: 600
In addition to field overrides, value mapping is a technique that you can use to change the visual treatment of data that appears in a visualization.
Values mapped via value mappings bypass the unit formatting. This means that a text value mapped to a numerical value is not formatted using the configured unit.
Values mapped using value mappings bypass the unit formatting. This means that a text value mapped to a numerical value is not formatted using the configured unit.
![Value mappings example](/static/img/docs/value-mappings/value-mappings-example-8-0.png)
If value mappings are present in a panel, then Grafana displays a summary in the side pane of the panel editor.
## Types of value mappings
{{% admonition type="note" %}}
The new value mappings are not compatible with some visualizations, such as Graph (old), Text, and Heatmap.
{{% /admonition %}}
## Types of value mappings
Grafana supports the following value mappings:
- **Value:** Maps text values to a color or different display text. For example, you can configure a value mapping so that all instances of the value `10` appear as **Perfection!** rather than the number.
@ -123,7 +123,7 @@ Map a special value when you want to format uncommon, boolean, or empty values.
## Edit a value mapping
You can change a value mapping at any time.
You can edit a value mapping at any time.
1. Edit the panel that contains the value mapping you want to edit.
1. In the panel display options, in the **Value mappings** section, click **Edit value mappings**.

6
docs/sources/panels-visualizations/query-transform-data/share-query/index.md
View File

@ -8,7 +8,7 @@ weight: 60
# Share query results with another panel
Grafana let you use the query result from one panel for any other panel in the dashboard. Sharing query results across panels reduces the number of queries made to your data source, which can improve the performance of your dashboard.
Grafana lets you use the query result from one panel for any other panel in the dashboard. Sharing query results across panels reduces the number of queries made to your data source, which can improve the performance of your dashboard.
The Dashboard data source lets you select a panel in your dashboard that contains the queries ‌you want to share the results for. Instead of sending a separate query for each panel, Grafana sends one query and other panels use the query results to construct visualizations.
@ -20,9 +20,9 @@ This strategy can drastically reduce the number of queries being made when you f
If you don't have a data source available, use the **Grafana** data source, which returns a random time series that you can use for testing.
1. Add a second panel and select the **Dashboard** data source in the query editor.
1. Add a new panel and select the **Dashboard** data source in the query editor.
1. In the **Use results from panel list**, select the first panel you created.
All queries defined in the source panel are now available to the new panel. Queries made in the source panel can be shared with multiple panels.
All queries defined in the source panel are now available to the new panel. Queries defined in the source panel can be shared with multiple panels.
You can click on any of the queries to go to the panel where they are defined.

8
docs/sources/panels-visualizations/visualizations/news/index.md
View File

@ -14,10 +14,12 @@ weight: 800
## News
This panel visualization displays an RSS feed. By default, it displays articles from the Grafana Labs blog.
This panel visualization displays an RSS feed. By default, it displays articles from the Grafana Labs blog, and users can change this by entering a different RSS feed URL.
Enter the URL of an RSS in the URL field in the Display section. This panel type does not accept any other queries.
Enter the URL of an RSS in the URL field in the Display section. This panel type does not accept any other queries, and users should not expect to be able to filter or query the RSS feed data in any way using this panel.
In version 8.5, we discontinued the "Use Proxy" option for Grafana news panels. As a result, RSS feeds that are not configured for request by Grafana's frontend (with the appropriate [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)) may not load.
If the RSS feed you're trying to display fails to load, consider rehosting the RSS feed or prefixing the RSS URL with your own "CORS proxy". Alternatively, you can use the community [RSS/Atom data source](https://grafana.com/grafana/plugins/volkovlabs-rss-datasource/) in combination with the [Dynamic text](https://grafana.com/grafana/plugins/marcusolsson-dynamictext-panel/) community panel to display the RSS feed.
If you're having trouble loading an RSS feed, you can try rehosting the feed on a different server or using a CORS proxy. A CORS proxy is a tool that allows you to bypass CORS restrictions by making requests to the RSS feed on your behalf. You can find more information about using CORS proxies online.
If you're unable to display an RSS feed using the News panel, you can try using the community RSS/Atom data source plugin [RSS/Atom data source](https://grafana.com/grafana/plugins/volkovlabs-rss-datasource/) in combination with the Dynamic text community panel [Dynamic text](https://grafana.com/grafana/plugins/marcusolsson-dynamictext-panel/). This will allow you to display the RSS feed in a different way.