Skip to content

Commit 346138d

Browse files
authored
Merge pull request DataDog#16026 from DataDog/jorie/DOCS-4389
(DOCS-4389) Update instances of multi-alert to multi alert
2 parents 483e6cc + f75a021 commit 346138d

File tree

20 files changed

+75
-74
lines changed

20 files changed

+75
-74
lines changed

.github/styles/Datadog/words.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,4 @@ swap:
2929
'via': with|through
3030
'webserver': 'web server'
3131
'web site': website
32+
'multi-alert': 'multi alert'

content/en/dashboards/functions/interpolation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The `default_zero()` function fills empty time intervals using the value 0 or, i
3636
The `default_zero()` function is intended to address the following use cases (though it may also work for other use cases):
3737

3838
- Aligning gauges as 0 when performing arithmetic on sparse metrics (note: `COUNT` or `RATE` type metrics queried `as_count()` or `as_rate()` are _always_ aligned as 0, so using `default_zero()` does not change how they are aligned; it only affects `GAUGE` type metrics).
39-
- Resolving monitors from a no-data condition. This works for both simple and multi-alerts, but the value 0 must not cause the monitor to trigger. For example, this would not work for a monitor with the query `avg(last_10m):avg:system.cpu.idle{*} < 10` because this monitor triggers (instead of resolving) when it evaluates to 0. Avoid using this function for error rate monitors with `as_count()` queries. See the [as_count() in Monitor Evaluations guide][3] for more details.
39+
- Resolving monitors from a no-data condition. This works for both simple and multi alerts, but the value 0 must not cause the monitor to trigger. For example, this would not work for a monitor with the query `avg(last_10m):avg:system.cpu.idle{*} < 10` because this monitor triggers (instead of resolving) when it evaluates to 0. Avoid using this function for error rate monitors with `as_count()` queries. See the [as_count() in Monitor Evaluations guide][3] for more details.
4040
- Filling in empty intervals in sparse (but nonempty) series for visual reasons or to affect the min/max/average of a timeseries in a monitor evaluation. If the evaluation window doesn't contain any points of data, `default_zero()` has no effect.
4141
- Showing the value 0 on the timeseries widget when there is no data.
4242

content/en/dashboards/widgets/monitor_summary.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,22 @@ The monitor summary widget displays a summary view of all your Datadog monitors,
2222
### Configuration
2323

2424
1. Select one of the three summary types: `Monitor`, `Group` or `Combined`
25-
- The `Monitor` summary type lists statuses and names of monitors matching the [monitor query][1]. Multi-alert monitors have only one row in the results list and their status is the multi-alert monitor’s overall status. The Status Counts are the number of matching monitors with each status type.
25+
- The `Monitor` summary type lists statuses and names of monitors matching the [monitor query][1]. Multi alert monitors have only one row in the results list and their status is the multi alert monitor’s overall status. The Status Counts are the number of matching monitors with each status type.
2626

2727
{{< img src="dashboards/widgets/monitor_summary/monitor_summary_type.png" alt="monitor summary type" style="width:80%;">}}
2828

29-
- The `Group` summary type lists statuses, names, and groups of monitors matching the monitor query. Multi-alert monitors are broken into several rows in the results list and correspond to each group and that group’s specific status in the multi-alert monitor. The `Group` summary type also supports `group` and `group_status` facets in its monitor query similar to the [Triggered Monitors][2] page. The Status Counts are the number of matching monitor groups with each status type.
29+
- The `Group` summary type lists statuses, names, and groups of monitors matching the monitor query. Multi alert monitors are broken into several rows in the results list and correspond to each group and that group’s specific status in the multi alert monitor. The `Group` summary type also supports `group` and `group_status` facets in its monitor query similar to the [Triggered Monitors][2] page. The Status Counts are the number of matching monitor groups with each status type.
3030

3131
{{< img src="dashboards/widgets/monitor_summary/group_summary_type.png" alt="group summary type" style="width:80%;">}}
3232

33-
- The `Combined` summary type lists the number of group statuses and names of the monitors matching the monitor query. Multi-alert monitors have only one row in the results list like in the `Monitor` summary type but the groups column displays the number of groups in each status type instead of the monitor’s overall status. Similar to the `Group` summary type, the `Combined` summary type also supports the `group` and `group_status` facets in its monitor query. The Status Counts still show the count of overall monitor statuses like in the `Monitor` summary type.
33+
- The `Combined` summary type lists the number of group statuses and names of the monitors matching the monitor query. Multi alert monitors have only one row in the results list like in the `Monitor` summary type but the groups column displays the number of groups in each status type instead of the monitor’s overall status. Similar to the `Group` summary type, the `Combined` summary type also supports the `group` and `group_status` facets in its monitor query. The Status Counts still show the count of overall monitor statuses like in the `Monitor` summary type.
3434

3535
{{< img src="dashboards/widgets/monitor_summary/combined_summary_type.png" alt="combined summary type" style="width:80%;">}}
3636

3737
2. Enter a monitor query to display the monitor summary widget over a subset of your monitors.
3838

3939
**Note** In addition to the facets listed in the link above, the `Group` and `Combined` summary types also support the `group` and `group_status` facets for group-level searching, similar to the [Triggered Monitors][2] page.
40-
40+
4141
#### Template variables
4242

4343
To use template variables created in your dashboard in the monitor summary search query, follow the same query format as the Manage Monitor page.

content/en/getting_started/application/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ See [Host Map][9] for more details.
7070

7171
[The Event Explorer][10] displays the most recent events generated by your infrastructure and services.
7272

73-
Events can include the following:
73+
Events can include the following:
7474

7575
- Code deployments
7676
- Service health changes
@@ -103,7 +103,7 @@ In the Event Explorer, filter your events by facets or search queries. Group or
103103
[Monitors][16] provide alerts and notifications based on metric thresholds, integration availability, network endpoints, and more.
104104

105105
- Use any metric reporting to Datadog
106-
- Set up multi-alerts by device, host, and more
106+
- Set up multi alerts by device, host, and more
107107
- Use `@` in alert messages to direct notifications to the right people
108108
- Schedule downtimes to suppress notifications for system shutdowns, off-line maintenance, and more
109109

@@ -119,7 +119,7 @@ Datadog [Network Performance Monitoring][17] (NPM) gives you visibility into you
119119

120120
{{< img src="getting_started/rum.png" alt="RUM" >}}
121121

122-
Datadog [Real User Monitoring][18] (RUM) allows you to visualize and analyze real-time user activities and experiences. With [Session Replay][19], you can capture and view the web browsing sessions of your users to better understand their behavior. In the RUM Explorer, you can not only visualize load times, frontend errors, and page dependencies, but also you can correlate business and application metrics to troubleshoot issues with application, infrastructure, and business metrics in one dashboard.
122+
Datadog [Real User Monitoring][18] (RUM) allows you to visualize and analyze real-time user activities and experiences. With [Session Replay][19], you can capture and view the web browsing sessions of your users to better understand their behavior. In the RUM Explorer, you can not only visualize load times, frontend errors, and page dependencies, but also you can correlate business and application metrics to troubleshoot issues with application, infrastructure, and business metrics in one dashboard.
123123

124124
## Serverless
125125

@@ -135,7 +135,7 @@ Datadog [Cloud SIEM][21] (Security Information and Event Management) automatical
135135

136136
{{< img src="getting_started/synthetics.png" alt="Synthetics" >}}
137137

138-
Datadog [Synthetic Monitoring][22] allow you to create and run API and browser tests that proactively simulate user transactions on your applications and monitor all internal and external network endpoints across your system's layers. You can detect errors, identify regressions, and automate rollbacks to prevent issues from surfacing in production.
138+
Datadog [Synthetic Monitoring][22] allow you to create and run API and browser tests that proactively simulate user transactions on your applications and monitor all internal and external network endpoints across your system's layers. You can detect errors, identify regressions, and automate rollbacks to prevent issues from surfacing in production.
139139

140140
## Datadog on Mobile
141141

content/en/getting_started/tagging/using_tags.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ further_reading:
1818

1919
## Overview
2020

21-
After [assigning tags][1], start using them to filter and group your data in your Datadog platform. Tags can be used to include or exclude data.
21+
After [assigning tags][1], start using them to filter and group your data in your Datadog platform. Tags can be used to include or exclude data.
2222

2323
When including or excluding multiple tags:
2424

@@ -135,7 +135,7 @@ Here are the filter and group by text boxes on the Live Processes page:
135135
{{< tabs >}}
136136
{{% tab "Manage Monitors" %}}
137137

138-
To filter monitors by [assigned tags][1], use the search bar or facet checkboxes. The search bar format is `tag:<KEY>:<VALUE>`, for example: `tag:service:coffee-house`. To exclude monitors with a specific tag from your search, use `-`, for example: `tag:-service:coffee-house`.
138+
To filter monitors by [assigned tags][1], use the search bar or facet checkboxes. The search bar format is `tag:<KEY>:<VALUE>`, for example: `tag:service:coffee-house`. To exclude monitors with a specific tag from your search, use `-`, for example: `tag:-service:coffee-house`.
139139

140140
{{< img src="tagging/using_tags/managemonitorstags.png" alt="Manage Monitors Tags" style="width:80%;">}}
141141

@@ -152,7 +152,7 @@ When creating a [monitor][1], use metric tags in the:
152152

153153
* **excluding** text box to remove the corresponding metrics from the monitor scope.
154154

155-
* **avg by** text box to transform the monitor into a multi-alert monitor on each tag value.
155+
* **avg by** text box to transform the monitor into a multi alert monitor on each tag value.
156156

157157
[1]: /monitors/create/#monitor-types
158158
{{% /tab %}}
@@ -304,7 +304,7 @@ Additionally, tags are used to filter a logs [Pipeline][14]. In the example belo
304304

305305
## RUM & Session Replay
306306

307-
The [RUM Explorer][15] visualizes events from your environment over a specified time period.
307+
The [RUM Explorer][15] visualizes events from your environment over a specified time period.
308308

309309
To filter RUM event data by tags, use the search bar or facet checkboxes. The search bar format is `<KEY>:<VALUE>`, for example: `service:shopist`. For advanced search, see [Search RUM Events][16].
310310

@@ -315,7 +315,7 @@ To filter RUM event data by tags, use the search bar or facet checkboxes. The se
315315
{{< tabs >}}
316316
{{% tab "Synthetic Tests" %}}
317317

318-
The [Synthetic Tests][1] page lists your Synthetic tests.
318+
The [Synthetic Tests][1] page lists your Synthetic tests.
319319

320320
To filter tests by tags, use the search bar or facet checkboxes. The search bar format is `<KEY>:<VALUE>`. For example: `tag:mini-website`. For advanced search, see [Search and Manage Synthetic Tests][2].
321321

@@ -327,7 +327,7 @@ To filter tests by tags, use the search bar or facet checkboxes. The search bar
327327
{{% /tab %}}
328328
{{% tab "CI Results Explorer" %}}
329329

330-
The [CI Results Explorer][1] displays your browser test results running in a [CI pipeline][2].
330+
The [CI Results Explorer][1] displays your browser test results running in a [CI pipeline][2].
331331

332332
To filter test runs by tags, use the search bar or facet checkboxes. The search bar format is `<KEY>:<VALUE>`. For example: `@ci.provider.name:github`. For advanced search, see [Search and Manage Synthetic Tests][3].
333333

@@ -345,7 +345,7 @@ To filter test runs by tags, use the search bar or facet checkboxes. The search
345345
{{< tabs >}}
346346
{{% tab "Manage SLOs" %}}
347347

348-
To filter SLOs by [assigned tags][1], use the search bar or facet checkboxes. The search bar format is `<KEY>:<VALUE>`, for example: `journey:add_item`. To exclude SLOs with a specific tag from your search, use `-`, for example: `-journey:add_item`.
348+
To filter SLOs by [assigned tags][1], use the search bar or facet checkboxes. The search bar format is `<KEY>:<VALUE>`, for example: `journey:add_item`. To exclude SLOs with a specific tag from your search, use `-`, for example: `-journey:add_item`.
349349

350350
{{< img src="tagging/using_tags/manage_slo_tags.png" alt="SLO Tags" style="width:80%;">}}
351351

@@ -378,7 +378,7 @@ When creating a [monitor-based SLO][1] using a single [grouped monitor][2], use
378378

379379
## Developers
380380

381-
Tags can be used in various ways with the [API][17].
381+
Tags can be used in various ways with the [API][17].
382382

383383
See this list for links to respective sections:
384384

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: multi-alert
2+
title: multi alert
33
---
4-
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.
5-
For more information, <a href="https://docs.datadoghq.com/monitors/create/configuration/?tab=thresholdalert#alert-grouping">see the documentation</a>.
4+
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.
5+
For more information, <a href="https://docs.datadoghq.com/monitors/create/configuration/?tab=thresholdalert#alert-grouping">see the documentation</a>.

content/en/logs/guide/logs-monitors-on-volumes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ An event is generated when the daily quota is reached. Set up a monitor to be no
8181

8282
{{< img src="logs/guide/daily_quota_event_monitor.png" alt="Configuration page of event monitor with Source:datadog in query and datadog_index selected in the group by section" style="width:70%;">}}
8383

84-
Events generated when the daily quota is reached have the `datadog_index` tag by default, displaying the index name. You can optionally [create a facet][9] on the `datadog_index` tag, enabling its use in the `group by` step for [multi-alerts][10], as shown in the screenshot above.
84+
Events generated when the daily quota is reached have the `datadog_index` tag by default, displaying the index name. You can optionally [create a facet][9] on the `datadog_index` tag, enabling its use in the `group by` step for [multi alerts][10], as shown in the screenshot above.
8585

8686
Here is an example of what the notification would look like in Slack:
8787

content/en/monitors/create/configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Alerts are grouped automatically based on your selection of the `group by` step
2828
`Simple Alert` mode aggregate over all reporting sources. You receive **one alert** when the aggregated value meets the set conditions.
2929

3030
`Multi Alert` mode apply the alert to each source according to your group parameters. You receive **an alert for each group** that meets the set conditions. For example, you could group a query looking at a capacity metric by `host` and `device` to receive a separate alert for each host device that is running out of space.
31-
Note that if your metric is only reporting by `host` with no `device` tag, it would not be detected by a monitor group by both `host` and `device`. [Tag Variables][2] are available for every group evaluated in the multi-alert to dynamically fill in notifications with useful context.
31+
Note that if your metric is only reporting by `host` with no `device` tag, it would not be detected by a monitor group by both `host` and `device`. [Tag Variables][2] are available for every group evaluated in the multi alert to dynamically fill in notifications with useful context.
3232

3333
| Group by | Simple alert mode | Multi alert mode |
3434
|-------------------------------------|------------------------|-----------------------|
@@ -61,7 +61,7 @@ The query returns a series of points, but a single value is needed to compare to
6161

6262
### Evaluation window
6363

64-
A monitor can be evaluated using cumulative time windows or rolling time windows. Cumulative time windows are best suited for questions that require historical context, such as "What's the sum of all the data available up to this point in time?" Rolling time windows are best suited for answering questions that do not require this context, such as "What's the average of the last _N_ data points?"
64+
A monitor can be evaluated using cumulative time windows or rolling time windows. Cumulative time windows are best suited for questions that require historical context, such as "What's the sum of all the data available up to this point in time?" Rolling time windows are best suited for answering questions that do not require this context, such as "What's the average of the last _N_ data points?"
6565

6666
The figure below illustrates the difference between cumulative and rolling time windows.
6767

@@ -170,7 +170,7 @@ In this case, you should not enable notifications for missing data. This option
170170

171171
##### Simple Alert
172172

173-
For a monitor that does not notify on missing data, the monitor skips evaluations and stays green until data returns that would change the status from OK.
173+
For a monitor that does not notify on missing data, the monitor skips evaluations and stays green until data returns that would change the status from OK.
174174

175175
##### Multi Alert
176176

@@ -230,7 +230,7 @@ Some use cases to define a group retention time include:
230230
- When you would like to drop the group immediately or shortly after data stops reporting
231231
- When you would like to keep the group in the status for as long as you usually take for troubleshooting
232232

233-
**Note**: The group retention time option requires a multi-alert monitor that supports the [`On missing data`][5] option. These monitor types are APM Trace Analytics, Audit Logs, CI Pipelines, Error Tracking, Events, Logs, and RUM monitors.
233+
**Note**: The group retention time option requires a multi alert monitor that supports the [`On missing data`][5] option. These monitor types are APM Trace Analytics, Audit Logs, CI Pipelines, Error Tracking, Events, Logs, and RUM monitors.
234234

235235
#### New group delay
236236

@@ -240,7 +240,7 @@ The time (in seconds) to wait before starting alerting, to allow newly created g
240240

241241
For example, if you are using containerized architecture, setting a group delay prevents monitor groups scoped on containers from triggering due to high resource usage or high latency when a new container is created. The delay is applied to every new group (which has not been seen in the last 24 hours) and defaults to `60` seconds.
242242

243-
The option is available with multi-alert mode.
243+
The option is available with multi alert mode.
244244

245245
#### Evaluation delay
246246

content/en/monitors/create/types/apm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ For detailed instructions on the advanced alert options (no data, evaluation del
7373
{{% /tab %}}
7474
{{% tab "Trace Analytics" %}}
7575

76-
<div class="alert alert-info"><strong>Note</strong>: There is a default limit of 1000 Trace Analytics monitors per account. If you are encountering this limit, consider using <a href="/monitors/create/configuration/?tab=thresholdalert#alert-grouping">multi-alerts</a>, or <a href="/help/">Contact Support</a>.</div>
76+
<div class="alert alert-info"><strong>Note</strong>: There is a default limit of 1000 Trace Analytics monitors per account. If you are encountering this limit, consider using <a href="/monitors/create/configuration/?tab=thresholdalert#alert-grouping">multi alerts</a>, or <a href="/help/">Contact Support</a>.</div>
7777

7878
### Define the search query
7979

0 commit comments

Comments
 (0)