Skip to content

Commit ffee403

Browse files
estherk15Kaylyn
and
Kaylyn
authored
Add monitor terms to glossary (#21173)
* Add monitor terms to glossary * Apply suggestions from code review Co-authored-by: Kaylyn <[email protected]> * Update archetypes/glossary.md * Update content/en/glossary/terms/conditional_variables.md --------- Co-authored-by: Kaylyn <[email protected]>
1 parent 2c743b7 commit ffee403

11 files changed

+77
-1
lines changed

archetypes/glossary.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
# Glossary Term
33
title: {{ replace .Name "-" " " | title }}
44

5+
# (optional) Core products related to this term, allows top level filtering in UI.
6+
core_product:
7+
- core_product
8+
59
# (optional) Array of synonyms
610
synonyms:
711
- synonym1
@@ -12,4 +16,4 @@ related_terms:
1216
- related_term1
1317
- related_term2
1418
---
15-
Add glossary term definition and markdown here.
19+
Add glossary term definition and markdown here.
+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: alerting type
3+
core_product:
4+
- alerts
5+
synonyms:
6+
- alert grouping
7+
related_terms:
8+
- simple alert
9+
- multi alert
10+
---
11+
Alerts are grouped automatically based on your selection of the `group by` aggregation step when defining your metric. Any added aggregations result in a "multi alert" type, and no aggregation is a "simple alert" type. For more information, <a href="/monitors/configuration/?tab=thresholdalert#alert-grouping">see the documentation</a>.

content/en/glossary/terms/anomaly.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: anomaly
3+
core_product:
4+
- alerts
5+
- metrics
6+
related_terms:
7+
- outlier
8+
---
9+
Anomaly detection is an algorithmic feature that identifies when a metric behaves differently than it has in the past. It takes into account trends, seasonal day-of-week, and time-of-day patterns. It is suited for metrics with strong trends and recurring patterns that are hard to monitor with threshold-based alerting. For more information, <a href="/monitors/types/anomaly/">see the documentation</a>.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: change alert
3+
core_product:
4+
- alerts
5+
related_terms:
6+
- threshold alert
7+
---
8+
A change alert compares the absolute or relative (%) change in value between N minutes ago and now against a given threshold. The compared data points aren't single points but are computed using the parameters in the alert conditions section. For more information, <a href="/monitors/types/metric/?tab=change#choose-the-detection-method">see the documentation</a>.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: conditional variables
3+
core_product:
4+
- alerts
5+
---
6+
Conditional variables use if-else logic to display a different message depending on the state of the monitor and the details of how it was triggered. For more information, <a href="/monitors/notify/variables/?tab=is_alert#conditional-variables">see the documentation</a>.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: evaluation frequency
3+
core_product:
4+
- alerts
5+
related_terms:
6+
- evaluation window
7+
---
8+
The evaluation frequency defines how often Datadog performs the monitor query. For most configurations, the evaluation frequency is 1 minute, which means that every minute, the monitor queries the selected data over the selected evaluation window and compares the aggregated value against the defined thresholds. For more information, <a href="/monitors/configuration/?tab=thresholdalert#evaluation-frequency">see the documentation</a>.

content/en/glossary/terms/evaluation_window.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: evaluation window
33
core_product:
44
- alerts
5+
related_terms:
6+
- evaluation window
57
---
68
The evaluation window is the look back timeframe of the data that the monitor aggregates and uses to compare against the defined thresholds.
79
For more information, <a href="/monitors/configuration/?tab=thresholdalert#evaluation-window">see the documentation</a>.

content/en/glossary/terms/multi-alert.md

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
title: multi alert
33
core_product:
44
- alerts
5+
related_terms:
6+
- simple alert
7+
- alerting type
58
---
69
A multi alert applies the alert to each source according to the monitor's group parameter. An alert notification is sent for each group that meets the set conditions.
710
For more information, <a href="/monitors/configuration/?tab=thresholdalert#alert-grouping">see the documentation</a>.

content/en/glossary/terms/outlier.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: outlier
3+
core_product:
4+
- alerts
5+
related_terms:
6+
- anomaly
7+
---
8+
Outlier detection is an algorithmic feature that allows you to detect when a specific metric group behaves differently than its peers. For more information, <a href="/monitors/types/outlier">see the documentation</a>.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: simple alert
3+
core_product:
4+
- alerts
5+
related_terms:
6+
- multi alert
7+
- alerting type
8+
---
9+
Monitor alerts that aggregate over all reporting sources. You receive one alert when the aggregated value meets the set conditions. For more information, <a href="/monitors/configuration/?tab=thresholdalert#alert-grouping">see the documentation</a>.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: threshold alert
3+
core_product:
4+
- alerts
5+
related_terms:
6+
- change alert
7+
---
8+
Monitor detection method that compares metric values to a static threshold. Threshold alerts are the default detection method for metric monitors. For more information, <a href="/monitors/types/metric/?tab=threshold#choose-the-detection-method">see the documentation</a>.

0 commit comments

Comments
 (0)