Docs: updates for file-based menu (#28500)

* initial

* cleanup

* remove bad aliases

* cleanup, fix links

* add docs-file-based-command

* update docs

* update readme

* fix broken links

* fix spelling

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
Robby Milo
2020-11-09 12:26:49 -08:00
committed by GitHub
co-authored by Diana Payton
parent a7e092f243
commit abee02dbcd
271 changed files with 260 additions and 1266 deletions
+1 -4
View File
@@ -1,9 +1,6 @@
+++
title = "Panels"
type = "docs"
[menu.docs]
identifier = "panels"
weight = 4
weight = 70
+++
# Panel overview
-5
View File
@@ -1,11 +1,6 @@
+++
title = "Add a panel"
type = "docs"
[menu.docs]
identifier = "add-a-panel"
parent = "panels"
weight = 100
draft = "true"
+++
# Add a panel
-4
View File
@@ -1,9 +1,5 @@
+++
title = "Calculations list"
type = "docs"
[menu.docs]
identifier = "calculations-list"
parent = "panels"
weight = 300
+++
@@ -1,9 +1,7 @@
+++
title = "Field options and overrides"
type = "docs"
keywords = ["grafana", "field options", "documentation", "format fields"]
aliases = ["/docs/grafana/latest/panels/field-configuration-options/", "/docs/grafana/latest/panels/field-options/"]
[menu.docs]
weight = 500
+++
@@ -1,7 +1,6 @@
+++
title = "Configure all fields"
keywords = ["grafana", "field options", "documentation", "format fields", "change all fields"]
type = "docs"
weight = 200
+++
@@ -1,7 +1,6 @@
+++
title = "Configure specific fields"
keywords = ["grafana", "field options", "documentation", "format fields", "overrides", "override fields"]
type = "docs"
weight = 300
+++
@@ -1,7 +1,6 @@
+++
title = "Standard field options"
keywords = ["grafana", "table options", "documentation", "format tables"]
type = "docs"
weight = 400
+++
+5 -9
View File
@@ -1,9 +1,5 @@
+++
title = "Inspect a panel"
type = "docs"
[menu.docs]
identifier = "inspect-a-panel"
parent = "panels"
weight = 400
+++
@@ -27,7 +23,7 @@ The panel inspector consists of four tabs:
> **Note:** Not all panel types include all four tabs. For example, dashboard list panels do not have raw data to inspect, so they do not display the Stats, Data, or Query tabs.
## Panel inspector tasks
Tasks you can perform in the panel inspector are described below.
Tasks you can perform in the panel inspector are described below.
### Open the panel inspector
@@ -42,14 +38,14 @@ The panel inspector pane opens on the right side of the screen.
### Inspect raw query results
View raw query results in a table. This is the data returned by the query with transformations applied and before the panel applies field options or field option overrides.
View raw query results in a table. This is the data returned by the query with transformations applied and before the panel applies field options or field option overrides.
1. Open the panel inspector and then click the **Data** tab or in the panel menu click **Inspect > Data**.
1. If your panel contains multiple queries or queries multiple nodes, then you have additional options.
- **Select result -** Choose which result set data you want to view.
- **Transform data**
- **Join by time -** View raw data from all your queries at once, one result set per column. Click a column heading to reorder the data.
View raw query results in a table with field options and options overrides applied:
1. Open the **Data** tab in panel inspector.
1. Click on **Data display options** above the table.
@@ -70,7 +66,7 @@ To download a CSV file specifically formatted for Excel, expand the **Data optio
The Stats tab displays statistics that tell you how long your query takes, how many queries you send, and the number of rows returned. This information can help you troubleshoot your queries, especially if any of the numbers are unexpectedly high or low.
1. Open the panel inspector.
1. Navigate to the Stats tab.
1. Navigate to the Stats tab.
Statistics are displayed in read-only format.
@@ -83,7 +79,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 configuration, and overrides configuration applied.
1. You can expand or collapse portions of the JSON to explore it, or you can click **Copy to clipboard** and paste the JSON in another application.
1. You can expand or collapse portions of the JSON to explore it, or you can click **Copy to clipboard** and paste the JSON in another application.
### View raw request and response to data source
-3
View File
@@ -1,8 +1,5 @@
+++
title = "Panel editor"
type = "docs"
[menu.docs]
identifier = "panel-editor"
weight = 200
+++
-4
View File
@@ -1,11 +1,7 @@
+++
title = "Panels"
type = "docs"
aliases = ["/docs/grafana/latest/features/panels/panels/"]
[menu.docs]
identifier = "panels"
weight = 4
draft = "true"
+++
# Panel overview
+8 -12
View File
@@ -1,9 +1,5 @@
+++
title = "Queries"
type = "docs"
[menu.docs]
identifier = "queries"
parent = "panels"
weight = 300
+++
@@ -81,15 +77,15 @@ Grafana sets defaults that are shown in dark gray text. Changes are displayed in
Panel data source query options:
- **Max data points -** If the data source supports it, sets the maximum numbers of data points for each series returned. If the query returns more data points than the max data points setting, then the data source consolidates them (reduces the number of points returned by aggregating them together by average or max or other function).
There are two main reasons for limiting the number of points, performance and smoothing the line. The default value is the width (or number of pixels) of the graph as there is no point in having more data points than the graph panel can display.
With streaming data, the max data points value is used for the rolling buffer. (Streaming is a continuous flow of data and buffering is a way of dividing the stream into chunks). Loki streams data in the live tailing mode.
- **Min interval -** Sets a minimum limit for the automatically calculated interval, typically the minimum scrape interval. If a data point is saved every 15 seconds, then there's no point in having an interval lower than that. Another use case is to set it to a higher minimum than the scrape interval to get more coarse-grained, well-functioning queries.
- **Interval -** The interval is a time span that you can use when aggregating or grouping data points by time.
- **Interval -** The interval is a time span that you can use when aggregating or grouping data points by time.
Grafana automatically calculates an appropriate interval and it can be used as a variable in templated queries. The variable is either in seconds: `$__interval` or in milliseconds: `$__interval_ms`. It is typically used in aggregation functions like sum or average. For example, a Prometheus query using the interval variable: `rate(http_requests_total[$__interval])`.
This automatic interval is calculated based on the width of the graph. If the user zooms out a lot then the interval becomes greater, resulting in a more coarse grained aggregation whereas if the user zooms in then the interval decreases resulting in a more fine grained aggregation.
@@ -97,16 +93,16 @@ Panel data source query options:
For more information, refer to [Global variables]({{< relref "../variables/variable-types/global-variables.md" >}}).
- **Relative time -** You can override the relative time range for individual panels, causing them to be different than what is selected in the dashboard time picker in the top right corner of the dashboard. This allows you to show metrics from different time periods or days on the same dashboard.
- **Time shift -** The time shift function is another way to override the time range for individual panels. It only works with relative time ranges and allows you to adjust the time range.
For example, you could shift the time range for the panel to be two hours earlier than the dashboard time picker. For more information, refer to [Time range controls]({{< relref "../dashboards/time-range-controls.md" >}}).
- **Cache timeout -** (This field is only visible if available in your data source.) If your time series store has a query cache, then this option can override the default cache timeout. Specified as a numeric value in seconds.
### Query inspector button
You can click **Query inspector** to open the Query tab of the panel inspector where you can see the query request sent by the panel and the response.
You can click **Query inspector** to open the Query tab of the panel inspector where you can see the query request sent by the panel and the response.
Click **Refresh** to see the full text of the request sent by this panel to the server.
@@ -116,7 +112,7 @@ For more information about the panel inspector, refer to [Inspect a panel]({{< r
### Query editor list
In the UI, queries are organized in collapsible query rows. Each query row contains a query editor and is identified with a letter (A, B, C, and so on).
In the UI, queries are organized in collapsible query rows. Each query row contains a query editor and is identified with a letter (A, B, C, and so on).
You can:
@@ -1,9 +1,5 @@
+++
title = "Share query results"
type = "docs"
[menu.docs]
identifier = "share-query-results"
parent = "panels"
weight = 310
+++
+2 -6
View File
@@ -1,9 +1,5 @@
+++
title = "Thresholds"
type = "docs"
[menu.docs]
identifier = "thresholds"
parent = "panels"
weight = 300
+++
@@ -36,11 +32,11 @@ 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 from highest value to lowest.
> **Note:** These instructions apply only to the Stat, Gauge, Bar gauge, and Table visualizations.
> **Note:** These instructions apply only to the Stat, Gauge, Bar gauge, and Table visualizations.
1. Navigate to the panel you want to add a threshold to.
1. Click the **Field** tab.
1. Click **Add threshold**.
1. Click **Add threshold**.
1. Grafana adds a threshold with suggested numerical and color values.
1. Accept the recommendations or edit the new threshold.
- **Edit color:** Click the color dot you wish to change and then select a new color.
-4
View File
@@ -1,9 +1,5 @@
+++
title = "Transformations"
type = "docs"
[menu.docs]
identifier = "transformations"
parent = "panels"
weight = 300
+++
@@ -1,9 +1,5 @@
+++
title = "Overview"
type = "docs"
[menu.docs]
identifier = "overview"
parent = "transformations"
weight = 300
+++
@@ -28,7 +24,7 @@ The order in which transformations are applied can make a huge difference in how
Before you can configure and apply transformations:
- You must have entered a query and returned data from a data source. For more information on queries, refer to [Queries]({{< relref "../queries.md" >}}).
- You must have chosen a visualization that supports your query result and chosen transforms. Different transformations can result in a data structure that only some visualizations can render. For example, Graph visualization cannot show reduced data (that results from the Reduce transform). If your current visualization does not show you what you expect after applying a transform, switch to the Table visualization to check the result. For more information on the different types of visualizations, refer to:
- [Bar gauge]({{< relref "../visualizations/bar-gauge-panel.md" >}})
- [Gauge]({{< relref "../visualizations/gauge-panel.md" >}})
@@ -1,9 +1,5 @@
+++
title = "Apply a transformation"
type = "docs"
[menu.docs]
identifier = "apply-transformation"
parent = "transformations"
weight = 300
+++
@@ -1,9 +1,5 @@
+++
title = "Transformation types and options"
type = "docs"
[menu.docs]
identifier = "transformation_types_and_options"
parent = "transformations"
weight = 300
+++
+1 -4
View File
@@ -1,8 +1,5 @@
+++
title = "Visualizations"
type = "docs"
[menu.docs]
identifier = "visualizations"
weight = 600
+++
@@ -10,6 +7,6 @@ weight = 600
Grafana offers a variety of visualizations to suit different use cases. This section of the documentation lists the different visualizations available in Grafana and their unique display settings.
The default options and their unique display options are described in the pages in this section.
The default options and their unique display options are described in the pages in this section.
You can add more panel types with [plugins]({{< relref "../../plugins/_index.md" >}}).
@@ -1,11 +1,7 @@
+++
title = "Alert list panel"
keywords = ["grafana", "alert list", "documentation", "panel", "alertlist"]
type = "docs"
aliases = ["/docs/grafana/latest/reference/alertlist/", "/docs/grafana/latest/features/panels/alertlist/"]
[menu.docs]
name = "alert-list-panel"
parent = "visualizations"
weight = 100
+++
@@ -2,7 +2,6 @@
title = "Bar gauge panel"
description = "Bar gauge panel docs"
keywords = ["grafana", "bar", "bar gauge"]
type = "docs"
aliases =["/docs/grafana/latest/features/panels/bar_gauge/"]
weight = 200
+++
@@ -1,11 +1,7 @@
+++
title = "Dashboard list panel"
keywords = ["grafana", "dashboard list", "documentation", "panel", "dashlist"]
type = "docs"
aliases = ["/docs/grafana/latest/reference/dashlist/", "/docs/grafana/latest/features/panels/dashlist/"]
[menu.docs]
name = "Dashboard list"
parent = "visualizations"
weight = 300
+++
@@ -2,7 +2,6 @@
title = "Gauge panel"
description = "Gauge panel docs"
keywords = ["grafana", "gauge", "gauge panel"]
type = "docs"
aliases = ["/docs/grafana/latest/features/panels/gauge/"]
weight = 400
+++
@@ -1,10 +1,7 @@
+++
title = "Graph panel"
keywords = ["grafana", "graph panel", "documentation", "guide", "graph"]
type = "docs"
aliases = ["/docs/grafana/latest/reference/graph/", "/docs/grafana/latest/features/panels/graph/"]
[menu.docs]
parent = "visualizations"
weight = 500
+++
@@ -68,7 +65,7 @@ You can add multiple series overrides.
1. Click **Add series override**.
1. In **Alias or regex** Type or select a series. Click in the field to see a list of available series.
**Example:** `/Network.*/` would match two series named `Network out` and `Network in`.
1. Click **+** and then select a style to apply to the series. You can add multiple styles to each entry.
@@ -121,13 +118,13 @@ Options are identical for both Y-axes.
- **Time -** (default) The X-axis represents time and that the data is grouped by time (for example, by hour, or by minute).
- **Series -** The data is grouped by series and not by time. The Y-axis still represents the value.
- **Value -** The aggregation type to use for the values. The default is total (summing the values together).
- **Histogram -** Converts the graph into a histogram. A histogram is a kind of bar chart that groups numbers into ranges, often called buckets or bins. Taller bars show that more data falls in that range.
- **Histogram -** Converts the graph into a histogram. A histogram is a kind of bar chart that groups numbers into ranges, often called buckets or bins. Taller bars show that more data falls in that range.
For more information about histograms, refer to [Introduction to histograms and heatmaps]({{< relref "../../getting-started/intro-histograms.md" >}}).
- **Buckets -** The number of buckets to group the values by. If left empty, then Grafana tries to calculate a suitable number of buckets.
- **X-Min -** Filters out values from the histogram that are under this minimum limit.
- **X-Max -** Filters out values that are greater than this maximum limit.
## Legend
Use these settings to refine how the legend appears in your visualization.
@@ -150,7 +147,7 @@ Additional values can be shown along-side the legend names:
- **Total -** Sum of all values returned from the metric query.
- **Decimals -** Controls how many decimals are displayed for legend values and graph hover tooltips.
The legend values are calculated on the client side by Grafana and depend on what type of aggregation or point consolidation your metric query is using. All the above legend values cannot be correct at the same time.
The legend values are calculated on the client side by Grafana and depend on what type of aggregation or point consolidation your metric query is using. All the above legend values cannot be correct at the same time.
For example, if you plot a rate like requests/second, this is probably using average as an aggregator, then the Total in the legend will not represent the total number of requests. It is just the sum of all data points received by Grafana.
@@ -159,7 +156,7 @@ For example, if you plot a rate like requests/second, this is probably using ave
Hide series when all values of a series from a metric query are of a specific value.
- **With only nulls -** Value=null (default unchecked)
- **With only zeroes -** Value=zero (default unchecked)
- **With only zeroes -** Value=zero (default unchecked)
### Time regions
@@ -2,11 +2,7 @@
title = "Heatmap"
description = "Heatmap visualization documentation"
keywords = ["grafana", "heatmap", "panel", "documentation"]
type = "docs"
aliases =["/docs/grafana/latest/features/panels/heatmap/"]
[menu.docs]
name = "Heatmap"
parent = "visualizations"
weight = 600
+++
@@ -1,11 +1,7 @@
+++
title = "Logs panel"
keywords = ["grafana", "dashboard", "documentation", "panels", "logs panel"]
type = "docs"
aliases = ["/docs/grafana/latest/reference/logs/", "/docs/grafana/latest/features/panels/logs/",]
[menu.docs]
name = "Logs panel"
parent = "visualizations"
weight = 700
+++
@@ -1,10 +1,6 @@
+++
title = "News panel"
keywords = ["grafana", "news", "documentation", "panels", "news panel"]
type = "docs"
[menu.docs]
name = "news-panel"
parent = "visualizations"
weight = 800
+++
@@ -2,7 +2,6 @@
title = "Stat panel"
description = "Stat panel documentation"
keywords = ["grafana", "docs", "stat panel"]
type = "docs"
aliases = ["/docs/grafana/latest/features/panels/stat/", "/docs/grafana/latest/features/panels/singlestat/", "/docs/grafana/latest/reference/singlestat/"]
weight = 900
+++
@@ -1,11 +1,7 @@
+++
title = "Table panel"
keywords = ["grafana", "dashboard", "documentation", "panels", "table panel"]
type = "docs"
aliases = ["/docs/grafana/latest/reference/table/", "/docs/grafana/latest/features/panels/table_panel/"]
[menu.docs]
name = "Table panel"
parent = "visualizations"
weight = 1000
+++
@@ -29,9 +25,9 @@ Table visualizations allow you to apply:
- **Show header -** Show or hide column names imported from your data source.
- **Sort ascending/descending -** Click a column title to change the sort order from default to descending to ascending. Each time you click, the sort order changes to the next option in the cycle. You can only sort by one column at a time.
![Sort descending](/img/docs/tables/sort-descending.png "Sort descending")
- [Table field options]({{< relref "table-field-options.md" >}}) allow you to change [field options]({{< relref "../../field-options/_index.md" >}}) such as column width, alignment, and cell display mode.
- [Filter table columns]({{< relref "filter-table-columns.md" >}}) - You can temporarily change how column data is displayed. For example, you can order values from highest to lowest or hide specific values.
@@ -1,7 +1,6 @@
+++
title = "Filter table columns"
keywords = ["grafana", "table options", "documentation", "format tables", "table filter", "filter columns"]
type = "docs"
weight = 600
+++
@@ -1,7 +1,6 @@
+++
title = "Table field options"
keywords = ["grafana", "table options", "documentation", "format tables"]
type = "docs"
weight = 500
+++
@@ -77,5 +76,5 @@ If you have a field value that is an image URL or a base64 encoded image you can
## Column filter
> **Note:** This feature is available in Grafana 7.2+.
>
>
Turn this on to enable table field filters. For more information, refer to [Filter table columns]({{< relref "filter-table-columns.md" >}}).
@@ -1,16 +1,12 @@
+++
title = "Text panel"
keywords = ["grafana", "text", "documentation", "panel"]
type = "docs"
aliases = ["/docs/grafana/latest/reference/alertlist/", "/docs/grafana/latest/features/panels/text/"]
[menu.docs]
name = "text-panel"
parent = "visualizations"
weight = 1100
+++
# Text panel
The text panel lets you make information and description panels for your dashboards.
The text panel lets you make information and description panels for your dashboards.
In **Mode**, select whether you want to use markdown or HTML to style your text, then enter content in the box below. Grafana includes a title and paragraph to help you get started, or you can paste content in from another editor.