Docs: Yet more panel updates (#35213)

* Update stat-panel.md

* Update stat-panel.md

* Update whats-new-in-v8-0.md

* Update state-timeline.md

* fixed links

* Update news-panel.md
This commit is contained in:
Diana Payton 2021-06-03 13:02:47 -07:00 committed by GitHub
parent 692568520f
commit 1c37fc1a6f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 88 additions and 57 deletions

View File

@ -20,9 +20,9 @@ Alerts have four main components:
You can perform the following tasks for alerts:
- [Create a Grafana managed alert rule]({{< relref "./create-grafana-managed-rule.md" >}})
- [Create a Cortex or Loki managed alert rule]({{< relref "./create-cortex-loki-managed-rule.md" >}})
- [View existing alert rules and their current state]({{< relref "./rule-list.md" >}})
- [Create a Grafana managed alert rule]({{< relref "alerting-rules/create-grafana-managed-rule.md" >}})
- [Create a Cortex or Loki managed alert rule]({{< relref "alerting-rules/create-cortex-loki-managed-rule.md" >}})
- [View existing alert rules and their current state]({{< relref "alerting-rules/rule-list.md" >}})
- [Test alert rules and troubleshoot]({{< relref "./troubleshoot-alerts.md" >}})
- [Add or edit an alert contact point]({{< relref "./contact-points.md" >}})
- [Add or edit notification policies]({{< relref "./notification-policies.md" >}})
@ -30,7 +30,7 @@ You can perform the following tasks for alerts:
## Clustering
Currently alerting supports a limited form of high availability. Since v4.2.0 of Grafana, alert notifications are deduped when running multiple servers. This means all alerts are executed on every server but no duplicate alert notifications are sent due to the deduping logic. Proper load balancing of alerts will be introduced in the future.
Currently alerting supports a limited form of high availability. Alert notifications are deduped when running multiple servers. This means all alerts are executed on every server but no duplicate alert notifications are sent due to the deduping logic. Proper load balancing of alerts will be introduced in the future.
## Alert evaluation
@ -56,4 +56,4 @@ Metric Name | Type | Description
`alerting.rule_group_rules` | gauge | The number of rules
- [View alert rules and their current state]({{< relref "./rule-list.md" >}})
- [View alert rules and their current state]({{< relref "alerting-rules/rule-list.md" >}})

View File

@ -58,7 +58,7 @@ So, as you can see from the above scenario Grafana will not send out notificatio
You can use reduce and math expressions to create a rule that will create an alert per series returned by the query.
1. Add one or more queries
2. Add a `reduce` expression for each query to aggregate values in the selected time range into a single value. With some data sources this is not needed for [rules using numeric data]({{< relref "./grafana-managed-numeric-rule.md" >}}).
2. Add a `reduce` expression for each query to aggregate values in the selected time range into a single value. With some data sources this is not needed for [rules using numeric data]({{< relref "../grafana-managed-numeric-rule.md" >}}).
3. Add a `math` expressions with the condition for the rule. Not needed in case a query or a reduce expression already returns 0 if rule should not be firing, or > 0 if it should be firing. Some examples: `$B > 70` if it should fire in case value of B query/expression is more than 70. `$B < $C * 100` in case it should fire if value of B is less than value of C multiplied by 100. If queries being compared have multiple series in their results, series from different queries are matched if they have the same labels or one is a subset of the other.
See or [expressions documentation]({{< relref "../../../panels/expressions.md" >}}) for in depth explanation of `math` and `reduce` expressions.

View File

@ -1,14 +1,14 @@
+++
title = "Stat panel"
title = "Stat"
description = "Stat panel documentation"
keywords = ["grafana", "docs", "stat panel"]
aliases = ["/docs/grafana/latest/features/panels/stat/", "/docs/grafana/latest/features/panels/singlestat/", "/docs/grafana/latest/reference/singlestat/"]
weight = 900
+++
# Stat panel
# Stat
The Stat panel shows a one large stat value with an optional graph sparkline. You can control the background or value color using thresholds.
The Stat panel visualization shows a one large stat value with an optional graph sparkline. You can control the background or value color using thresholds.
{{< figure src="/static/img/docs/v66/stat_panel_dark3.png" max-width="1025px" caption="Stat panel" >}}
@ -25,45 +25,78 @@ Example screenshot:
{{< figure src="/static/img/docs/v71/stat-panel-text-modes.png" max-width="1025px" caption="Stat panel" >}}
## Data and field options
Stat visualizations allow you to apply:
- [Data transformations]({{< relref "../transformations/_index.md" >}})
- [Field overrides]({{< relref "../field-overrides.md" >}})
- [Thresholds]({{< relref "../thresholds.md" >}})
## Automatic layout adjustment
The panel automatically adjusts the layout depending on available width and height in the dashboard. It automatically hides the graph (sparkline) if the panel becomes too small.
## Display options
## Value options
Use the following options to refine your visualization:
Use the following options to refine how your visualization displays the value:
- **Show -** Choose how Grafana displays your data.
- **Calculate -** Show a calculated value based on all rows.
- **Calculation -** Select a calculation to apply. For information about available calculations, refer to the [Calculation list]({{< relref "../calculations-list.md" >}}).
- **All values -** Show a separate stat for every row.
- **Limit -** The maximum number of rows to display.
- **Fields -** Select a field name or field type (including **All fields** or **Numeric fields**) to include in this panel.
- **Value -** Select a reducer function that Grafana will use to reduce many fields to a single value. Click the **Value** list to see functions and brief descriptions.
- **Orientation -** Choose a stacking direction.
- **Auto -** Grafana selects what it thinks is the best orientation.
- **Horizontal -** Bars stretch horizontally, left to right.
- **Vertical -** Bars stretch vertically, top to bottom.
- **Text mode -** (Only available in Grafana 7.1+.) You can use the Text mode option to control what text the panel renders. If the value is not important, only the name and color is, then change the **Text mode** to **Name**. The value will still be used to determine color and is displayed in a tooltip.
- **Auto -** If the data contains multiple series or fields, show both name and value.
- **Value -** Show only value, never name. Name is displayed in the hover tooltip instead.
- **Value and name -** Always show value and name.
- **Name -** Show name instead of value. Value is displayed in the hover tooltip.
- **None -** Show nothing (empty). Name and value are displayed in the hover tooltip.
- **Color mode**
- **Value -** Colors only the value and graph area.
- **Background -** Colors the background as well.
- **Graph mode**
- **None -** Hides the graph and only shows the value.
- **Area -** Shows the area graph below the value. This requires that your query returns a time column.
- **Alignment mode -** Choose an alignment mode.
- **Auto -** If only a single value is shown (no repeat), then the value is centered. If multiple series or rows are shown, then the value is left-aligned.
- **Center -** Stat value is centered.
### Show
Choose how Grafana displays your data.
#### Calculate
Show a calculated value based on all rows.
- **Calculation -** Select a reducer function that Grafana will use to reduce many fields to a single value. For a list of available calculations, refer to [List of calculations]({{< relref "../calculations-list.md" >}}).
- **Fields -** Select the fields display in the panel.
#### All values
Show a separate stat for every row. If you select this option, then you can also limit the number of rows to display.
- **Limit -** The maximum number of rows to display. Default is 5,000.
- **Fields -** Select the fields display in the panel.
## Stat styles
Style your visualization.
### Orientation
Choose a stacking direction.
- **Auto -** Grafana selects what it thinks is the best orientation.
- **Horizontal -** Bars stretch horizontally, left to right.
- **Vertical -** Bars stretch vertically, top to bottom.
### Text mode
You can use the Text mode option to control what text the panel renders. If the value is not important, only the name and color is, then change the **Text mode** to **Name**. The value will still be used to determine color and is displayed in a tooltip.
- **Auto -** If the data contains multiple series or fields, show both name and value.
- **Value -** Show only value, never name. Name is displayed in the hover tooltip instead.
- **Value and name -** Always show value and name.
- **Name -** Show name instead of value. Value is displayed in the hover tooltip.
- **None -** Show nothing (empty). Name and value are displayed in the hover tooltip.
### Color mode
Select a color mode.
- **Value -** Colors only the value and graph area.
- **Background -** Colors the background as well.
### Graph mode
Select a graph and splarkline mode.
- **None -** Hides the graph and only shows the value.
- **Area -** Shows the area graph below the value. This requires that your query returns a time column.
### Text alignment
Choose an alignment mode.
- **Auto -** If only a single value is shown (no repeat), then the value is centered. If multiple series or rows are shown, then the value is left-aligned.
- **Center -** Stat value is centered.
## Text size
Adjust the sizes of the gauge text.
- **Title -** Enter a numeric value for the gauge title size.
- **Value -** Enter a numeric value for the gauge value size.

View File

@ -5,23 +5,19 @@ keywords = ["grafana", "docs", "state timeline", "panel"]
weight = 900
+++
# State timeline visualization
# State timeline
The state timeline visualization shows discrete state changes over time. Each field or series is rendered as its unique horizontal band. State regions can either be rendered with or without values. This panel works well with string or boolean states but can also be used with time series. When used with time series, the thresholds are used to turn the numerical values into discrete state regions.
The state timeline panel visualization shows discrete state changes over time. Each field or series is rendered as its unique horizontal band. State regions can either be rendered with or without values. This panel works well with string or boolean states but can also be used with time series. When used with time series, the thresholds are used to turn the numerical values into discrete state regions.
{{< figure src="/static/img/docs/v8/state_timeline_strings.png" max-width="1025px" caption="state timeline with string states" >}}
## Shared options
## State timeline options
The following shared options are available:
Use these options to refine the visualization.
- [Standard options]({{< relref "../standard-options.md" >}}) (Unit, min, max, decimals, color)
- [Thresholds]({{< relref "../thresholds.md" >}})
- [Value mappings]({{< relref "../value-mappings.md" >}})
### Merge equal consecutive values
You can also use [field overrides]({{< relref "../field-overrides.md" >}}) to specify options per field or series.
## Display options
Controls whether Grafana merges identical values if they are next to each other.
### Show values
@ -58,3 +54,5 @@ The panel can be with time series data as well. In this case, the thresholds are
## Legend options
When the legend option is enabled it can show either the value mappings or the threshold brackets. To show the value mappings in the legend, it's important that the `Color scheme` option under [Standard options]({{< relref "../standard-options.md" >}}) is set to `Single color` or `Classic palette`. To see the threshold brackets in the legend set the `Color scheme` to `From thresholds`.
{{< docs/shared "visualizations/legend-mode.md" >}}

View File

@ -65,9 +65,9 @@ With time series data and thresholds:
For more information, refer to [State timeline visualization]({{< relref "../panels/visualizations/state-timeline.md" >}}).
### Status grid visualization (beta)
### Status history visualization (beta)
A sister panel to the state timeline is the new Status grid panel visualization. It can display periodic state in a grid. Works with both numerical, string or boolean state.
A sister panel to the state timeline is the new Status history panel visualization. It can display periodic state in a grid. Works with both numerical, string or boolean state.
![Status grid visualization](/static/img/docs/status-grid/status-grid-8-0.png)