From 30447a4aeecf6b2540af000a29cd8888b803e24c Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Thu, 23 May 2024 09:28:17 -0400 Subject: [PATCH] [v10.4.x] Docs: Add thresholds shared content (#88224) Docs: Add thresholds shared content (#87009) * Added thresholds shared files * Added shared files to visualizations and updated shared files * Removed future tense * Fixed prettier (cherry picked from commit 406fe8c85a5722c5f405d745f018a6ca820d9caf) --- .../visualizations/bar-chart/index.md | 4 ++++ .../visualizations/bar-gauge/index.md | 4 ++++ .../visualizations/candlestick/index.md | 4 ++++ .../visualizations/canvas/index.md | 4 ++++ .../visualizations/gauge/index.md | 4 ++++ .../visualizations/geomap/index.md | 4 ++++ .../visualizations/histogram/index.md | 4 ++++ .../visualizations/stat/index.md | 4 ++++ .../visualizations/state-timeline/index.md | 4 ++++ .../visualizations/status-history/index.md | 4 ++++ .../visualizations/table/index.md | 4 ++++ .../visualizations/time-series/index.md | 4 ++++ .../visualizations/trend/index.md | 4 ++++ .../visualizations/thresholds-options-1.md | 19 +++++++++++++++++++ .../visualizations/thresholds-options-2.md | 18 ++++++++++++++++++ 15 files changed, 89 insertions(+) create mode 100644 docs/sources/shared/visualizations/thresholds-options-1.md create mode 100644 docs/sources/shared/visualizations/thresholds-options-2.md diff --git a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md index f2af82434bd..3a6ea730693 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md @@ -207,6 +207,10 @@ You can set standard min/max options to define hard limits of the Y-axis. For mo {{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-1.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md index ac5ccdd4b44..3fc5fdded64 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md @@ -136,6 +136,10 @@ Automatically show y-axis scrollbar when there's a large amount of data. This option only applies when bar size is set to manual. {{% /admonition %}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/candlestick/index.md b/docs/sources/panels-visualizations/visualizations/candlestick/index.md index e5bb50eac5b..4e20bcb09d5 100644 --- a/docs/sources/panels-visualizations/visualizations/candlestick/index.md +++ b/docs/sources/panels-visualizations/visualizations/candlestick/index.md @@ -128,6 +128,10 @@ The candlestick visualization is based on the time series visualization. It can {{< docs/shared lookup="visualizations/tooltip-options-2.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-1.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/canvas/index.md b/docs/sources/panels-visualizations/visualizations/canvas/index.md index c11424c76ca..96d917c40f6 100644 --- a/docs/sources/panels-visualizations/visualizations/canvas/index.md +++ b/docs/sources/panels-visualizations/visualizations/canvas/index.md @@ -161,6 +161,10 @@ If multiple elements use the same field name, and you want to control which elem {{< video-embed src="/media/docs/grafana/canvas-data-links-9-4-0.mp4" max-width="750px" caption="Data links demo" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/gauge/index.md b/docs/sources/panels-visualizations/visualizations/gauge/index.md index bdb62f9f5a8..130105527d0 100644 --- a/docs/sources/panels-visualizations/visualizations/gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/gauge/index.md @@ -111,6 +111,10 @@ 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. +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/geomap/index.md b/docs/sources/panels-visualizations/visualizations/geomap/index.md index 394c67f34fc..ebaf1ca13fb 100644 --- a/docs/sources/panels-visualizations/visualizations/geomap/index.md +++ b/docs/sources/panels-visualizations/visualizations/geomap/index.md @@ -614,6 +614,10 @@ Displays debug information in the upper right corner. This can be useful for deb - **None** displays tooltips only when a data point is clicked. - **Details** displays tooltips when a mouse pointer hovers over a data point. +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/histogram/index.md b/docs/sources/panels-visualizations/visualizations/histogram/index.md index 511f9692f03..65b244be503 100644 --- a/docs/sources/panels-visualizations/visualizations/histogram/index.md +++ b/docs/sources/panels-visualizations/visualizations/histogram/index.md @@ -141,3 +141,7 @@ Gradient color is generated based on the hue of the line color. ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} + +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/stat/index.md b/docs/sources/panels-visualizations/visualizations/stat/index.md index 977fa6f8308..86eea1c6727 100644 --- a/docs/sources/panels-visualizations/visualizations/stat/index.md +++ b/docs/sources/panels-visualizations/visualizations/stat/index.md @@ -195,6 +195,10 @@ 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. +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md index 45cd77f24cd..89f49dffde8 100644 --- a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md +++ b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md @@ -149,6 +149,10 @@ The visualization can be used with time series data as well. In this case, the t {{< docs/shared lookup="visualizations/tooltip-options-1.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/status-history/index.md b/docs/sources/panels-visualizations/visualizations/status-history/index.md index 2c663cb03d4..5938476e44c 100644 --- a/docs/sources/panels-visualizations/visualizations/status-history/index.md +++ b/docs/sources/panels-visualizations/visualizations/status-history/index.md @@ -129,6 +129,10 @@ To assign colors to boolean or string values, use the [Value mappings](ref:value {{< docs/shared lookup="visualizations/tooltip-options-1.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/table/index.md b/docs/sources/panels-visualizations/visualizations/table/index.md index 8a4de7f6d31..c6d940f416f 100644 --- a/docs/sources/panels-visualizations/visualizations/table/index.md +++ b/docs/sources/panels-visualizations/visualizations/table/index.md @@ -248,6 +248,10 @@ The system applies the calculation to all numeric fields if you do not select a If you want to show the number of rows in the dataset instead of the number of values in the selected fields, select the **Count** calculation and enable **Count rows**. +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/time-series/index.md b/docs/sources/panels-visualizations/visualizations/time-series/index.md index 09ac7ca8df7..a76e1265f60 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -326,6 +326,10 @@ The following image shows a bar chart with the **Green-Yellow-Red (by value)** c {{< figure src="/static/img/docs/time-series-panel/gradient_mode_scheme_bars.png" max-width="1200px" caption="Color scheme: Green-Yellow-Red" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-1.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/trend/index.md b/docs/sources/panels-visualizations/visualizations/trend/index.md index 1ccd821ebc1..ad0a0c9aea2 100644 --- a/docs/sources/panels-visualizations/visualizations/trend/index.md +++ b/docs/sources/panels-visualizations/visualizations/trend/index.md @@ -52,6 +52,10 @@ For example, you could represent engine power and torque versus speed where spee {{< docs/shared lookup="visualizations/tooltip-options-2.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-1.md" source="grafana" version="" >}} + ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/shared/visualizations/thresholds-options-1.md b/docs/sources/shared/visualizations/thresholds-options-1.md new file mode 100644 index 00000000000..72327be25a7 --- /dev/null +++ b/docs/sources/shared/visualizations/thresholds-options-1.md @@ -0,0 +1,19 @@ +--- +title: Thresholds options +comments: | + There are two thresholds shared files, thresholds-options-1.md and thresholds-options-2.md, to cover the most common combinations of options. + Using two shared files ensures that content remains consistent across visualizations that share the same options and users don't have to figure out which options apply to a specific visualization when reading that content. + This file is used in the following visualizations: bar chart, candlestick, time series, trend +--- + +A threshold is a value or limit you set for a metric that’s reflected visually when it’s met or exceeded. Thresholds are one way you can conditionally style and color your visualizations based on query results. + +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. + +To learn more, refer to [Configure thresholds](../../configure-thresholds/). diff --git a/docs/sources/shared/visualizations/thresholds-options-2.md b/docs/sources/shared/visualizations/thresholds-options-2.md new file mode 100644 index 00000000000..d2ea9c2a44a --- /dev/null +++ b/docs/sources/shared/visualizations/thresholds-options-2.md @@ -0,0 +1,18 @@ +--- +title: Thresholds options +comments: | + There are two thresholds shared files, thresholds-options-1.md and thresholds-options-2.md, to cover the most common combinations of options. + Using two shared files ensures that content remains consistent across visualizations that share the same options and users don't have to figure out which options apply to a specific visualization when reading that content. + This file is used in the following visualizations: bar gauge, canvas, gauge, geomap, histogram, stat, state timeline, status history, table +--- + +A threshold is a value or limit you set for a metric that’s reflected visually when it’s met or exceeded. Thresholds are one way you can conditionally style and color your visualizations based on query results. + +Set the following options: + +- **Value** - Set the value for each threshold. +- **Thresholds mode** - Choose from: + - **Absolute** + - **Percentage** + +To learn more, refer to [Configure thresholds](../../configure-thresholds/).