Docs: Refactor time series page - part 1 (#90098)

Co-authored-by: nmarrs <nathanielmarrs@gmail.com>
This commit is contained in:
Isabel Matwawana
2024-07-18 13:19:06 -04:00
committed by GitHub
co-authored by nmarrs
parent 4de007d7b8
commit e3150b4eb8
10 changed files with 200 additions and 257 deletions
@@ -6,8 +6,6 @@ title: Connect null values
Choose how null values, which are gaps in the data, appear on the graph. Null values can be connected to form a continuous line or set to a threshold above which gaps in the data are no longer connected.
![Connect null values option](/static/img/docs/time-series-panel/connect-null-values-option-v9.png)
- **Never:** Time series data points with gaps in the data are never connected.
- **Always:** Time series data points with gaps in the data are always connected.
- **Threshold:** Specify a threshold above which gaps in the data are no longer connected. This can be useful when the connected gaps in the data are of a known size and/or within a known range, and gaps outside this range should no longer be connected.
@@ -6,7 +6,5 @@ title: Disconnect values
Choose whether to set a threshold above which values in the data should be disconnected.
{{< figure src="/media/docs/grafana/screenshot-grafana-10-1-disconnect-values.png" max-width="750px" alt="Disconnect values options" >}}
- **Never:** Time series data points in the data are never disconnected.
- **Threshold:** Specify a threshold above which values in the data are disconnected. This can be useful when desired values in the data are of a known size and/or within a known range, and values outside this range should no longer be connected.
@@ -8,28 +8,10 @@ comments: |
Legend options control the series names and statistics that appear under or to the right of the graph. For more information about the legend, refer to [Configure a legend](../configure-legend/).
### Visibility
Toggle the switch to turn the legend on or off.
### Mode
Use these settings to define how the legend appears in your visualization.
- **List -** Displays the legend as a list. This is a default display mode of the legend.
- **Table -** Displays the legend as a table.
### Placement
Choose where to display the legend.
- **Bottom -** Below the graph.
- **Right -** To the right of the graph.
#### Width
Control how wide the legend is when placed on the right side of the visualization. This option is only displayed if you set the legend placement to **Right**.
### Values
Choose which of the [standard calculations](../../query-transform-data/calculation-types/) to show in the legend. You can have more than one.
| Option | Description |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Visibility | Toggle the switch to turn the legend on or off. |
| Mode | Use these settings to define how the legend appears in your visualization. **List** displays the legend as a list. This is a default display mode of the legend. **Table** displays the legend as a table. |
| Placement | Choose where to display the legend. **Bottom -** Below the graph. **Right -** To the right of the graph. |
| Width | Control how wide the legend is when placed on the right side of the visualization. This option is only displayed if you set the legend placement to **Right**. |
| Values | Choose which of the [standard calculations](../../query-transform-data/calculation-types/) to show in the legend. You can have more than one. |
@@ -8,10 +8,12 @@ Overrides allow you to customize visualization settings for specific fields or s
Choose from one the following override options:
- **Fields with name** - Select a field from the list of all available fields.
- **Fields with name matching regex** - Specify fields to override with a regular expression.
- **Fields with type** - Select fields by type, such as string, numeric, or time.
- **Fields returned by query** - Select all fields returned by a specific query, such as A, B, or C.
- **Fields with values** - Select all fields returned by your defined reducer condition, such as **Min**, **Max**, **Count**, **Total**.
| Option | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| Fields with name | Select a field from the list of all available fields. |
| Field with name matching regex | Specify fields to override with a regular expression. |
| Fields with type | Select fields by type, such as string, numeric, or time. |
| Fields returned by query | Select all fields returned by a specific query, such as A, B, or C. |
| Fields with values | Select all fields returned by your defined reducer condition, such as **Min**, **Max**, **Count**, **Total**. |
To learn more, refer to [Configure field overrides](../../configure-overrides/).
@@ -8,12 +8,14 @@ comments: |
You can customize the following standard options:
- **Unit** - Choose which unit a field should use.
- **Min**/**Max** - Set the minimum and maximum values used in percentage threshold calculations or leave these field empty for them to be calculated automatically.
- **Field min/max** - Enable **Field min/max** to have Grafana calculate the min or max of each field individually, based on the minimum or maximum value of the field.
- **Decimals** - Specify the number of decimals Grafana includes in the rendered value.
- **Display name** - Set the display title of all fields. You can use variables in the field title.
- **Color scheme** - Set single or multiple colors for your entire visualization.
- **No value** - Enter what Grafana should display if the field value is empty or null. The default value is a hyphen (-).
| Option | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| Unit | Choose which unit a field should use. |
| Min/Max | Set the minimum and maximum values used in percentage threshold calculations or leave these field empty for them to be calculated automatically. |
| Field min/max | Enable **Field min/max** to have Grafana calculate the min or max of each field individually, based on the minimum or maximum value of the field. |
| Decimals | Specify the number of decimals Grafana includes in the rendered value. |
| Display name | Set the display title of all fields. You can use variables in the field title. |
| Color scheme | Set single or multiple colors for your entire visualization. |
| No value | Enter what Grafana should display if the field value is empty or null. The default value is a hyphen (-). |
To learn more, refer to [Configure standard options](../../configure-standard-options/).
@@ -10,10 +10,10 @@ A threshold is a value or limit you set for a metric thats reflected visually
Set the following options:
- **Value** - Set the value for each threshold.
- **Thresholds mode** - Choose from:
- **Absolute**
- **Percentage**
- **Show thresholds** - Choose from a variety of display options including not displaying thresholds at all.
| Option | Description |
| --------------- | ------------------------------------------------------------------------------------ |
| Value | Set the value for each threshold. |
| Thresholds mode | Choose from **Absolute** and **Percentage**. |
| Show thresholds | Choose from a variety of display options including not displaying thresholds at all. |
To learn more, refer to [Configure thresholds](../../configure-thresholds/).
@@ -8,6 +8,14 @@ comments: |
Tooltip options control the information overlay that appears when you hover over data points in the visualization.
| Option | Description |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| [Tooltip mode](#tooltip-mode) | When you hover your cursor over the visualization, Grafana can display tooltips. Choose how tooltips behave. |
| [Values sort order](#values-sort-order) | This option controls the order in which values are listed in a tooltip. |
| [Hover proximity](#hover-proximity) | Set the hover proximity (in pixels) to control how close the cursor must be to a data point to trigger the tooltip to display. |
| Max width | Set the maximum width of the tooltip box. |
| Max height | Set the maximum height of the tooltip box. The default is 600 pixels. |
### Tooltip mode
When you hover your cursor over the visualization, Grafana can display tooltips. Choose how tooltips behave.
@@ -31,11 +39,3 @@ When you set the **Tooltip mode** to **All**, the **Values sort order** option i
Set the hover proximity (in pixels) to control how close the cursor must be to a data point to trigger the tooltip to display.
![Adding a hover proximity limit for tooltips](/media/docs/grafana/gif-grafana-10-4-hover-proximity.gif)
### Max width
Set the maximum width of the tooltip box.
### Max height
Set the maximum height of the tooltip box. The default is 600 pixels.