grafana/docs/sources/panels-visualizations/configure-thresholds/index.md
Jack Baldry 7ef7cedc11
Prepare dashboards, panels, and visualizations for Grafana Cloud mount (#73632)
* Update dashboards pages to use `docs/reference` shortcode

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Update panels-visualizations pages to use `docs/reference` shortcode

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Use raw Markdown admonitions for contextual links

See https://discourse.gohugo.io/t/markdown-reference-links-in-shortcodes/5770/3.
Should be resolved by https://docs.google.com/document/d/19xd4CD3IrAqQqNR3xQeLfuIV-u2iNSQSBEvPZE9J4qU/edit#heading=h.5sybau7waq2q.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prefer "Warning" over "Caution"

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix some links missing destinations

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix 'time range controls' link

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add missing 'HTTP APIs' link

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix dashboard links missing destinations

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix links missing destinations in panels and visualizations documentation

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix dud link

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-09-13 11:39:04 +02:00

5.9 KiB

aliases description labels menuTitle title weight
../panels/
../panels/configure-thresholds/
../panels/specify-thresholds/about-thresholds/
../panels/specify-thresholds/add-a-threshold/
../panels/specify-thresholds/add-threshold-to-graph/
../panels/specify-thresholds/delete-a-threshold/
../panels/thresholds/
This section includes information about using thresholds in your visualizations.
products
cloud
enterprise
oss
Configure thresholds Configure thresholds 300

Configure thresholds

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

A threshold is a value that you specify for a metric that is visually reflected in a dashboard when the threshold value is met or exceeded.

Thresholds provide one method for you to conditionally style and color your visualizations based on query results. You can apply thresholds to most, but not all, visualizations. For more information about visualizations, refer to [Visualization panels][].

You can use thresholds to:

  • Color grid lines or grid areas in the [Time-series visualization][]
  • Color lines in the [Time-series visualization][]
  • Color the background or value text in the [Stat visualization][]
  • Color the gauge and threshold markers in the [Gauge visualization][]
  • Color markers in the [Geomap visualization][]
  • Color cell text or background in the [Table visualization][]
  • Define regions and region colors in the [State timeline visualization][]

There are two types of thresholds:

  • Absolute thresholds are defined by a number. For example, 80 on a scale of 1 to 150.
  • Percentage thresholds are defined relative to minimum or maximum. For example, 80 percent.

Default thresholds

On visualizations that support it, Grafana sets default threshold values of:

  • 80 = red
  • Base = green
  • Mode = Absolute

The Base value represents minus infinity. It is generally the “good” color.

Add or delete a threshold

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 needed. When you delete a threshold, the system removes the threshold from all visualizations that include the threshold.

  1. To add a threshold:

    a. Edit the panel to which you want to add a threshold.

    b. In the options side pane, locate the Thresholds section and click + Add threshold.

    c. Select a threshold color, number, and mode. Threshold mode applies to all thresholds on this panel.

    d. For a time-series panel, select a Show thresholds option.

  2. 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.

Add a threshold to a legacy graph panel

In the Graph panel visualization, thresholds enable you to add lines or sections to a graph to make it easier to recognize when the graph crosses a threshold.

  1. Navigate to the graph panel to which you want to add a threshold.
  2. On the Panel tab, click Thresholds.
  3. Click Add threshold.
  4. Complete the following fields:
    • T1 - Both values are required to display a threshold.
      • lt or gt - Select lt for less than or gt for greater than to indicate what the threshold applies to.
      • Value - Enter a threshold value. Grafana draws a threshold line along the Y-axis at that value.
    • Color - Choose a condition that corresponds to a color, or define your own color.
      • custom - You define the fill color and line color.
      • critical - Fill and line color are red.
      • warning - Fill and line color are yellow.
      • ok - Fill and line color are green.
    • 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.
  5. Click Save to save the changes in the dashboard.

{{% docs/reference %}} [Table visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/table" [Table visualization]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/table"

[Stat visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/stat" [Stat visualization]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/stat"

[Time-series visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/time-series#from-thresholds" [Time-series visualization]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/time-series#from-thresholds"

[State timeline visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/state-timeline" [State timeline visualization]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/state-timeline"

[Gauge visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/gauge" [Gauge visualization]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/gauge"

[Visualization panels]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations" [Visualization panels]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations"

[Geomap visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/geomap" [Geomap visualization]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/visualizations/geomap" {{% /docs/reference %}}