Skip to content

Commit bd1b033

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update description for notify_by monitor option (#877)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 754fce1 commit bd1b033

File tree

3 files changed

+17
-14
lines changed

3 files changed

+17
-14
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.4",
7-
"regenerated": "2022-10-14 07:44:07.160999",
8-
"spec_repo_commit": "13ac1a3a"
7+
"regenerated": "2022-10-14 14:06:55.801928",
8+
"spec_repo_commit": "7eb6ca7a"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2022-10-14 07:44:07.182199",
13-
"spec_repo_commit": "13ac1a3a"
12+
"regenerated": "2022-10-14 14:06:55.819509",
13+
"spec_repo_commit": "7eb6ca7a"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6280,18 +6280,20 @@ components:
62806280
type: boolean
62816281
notify_by:
62826282
description: 'Controls what granularity a monitor alerts on. Only available
6283-
for multi-alerts.
6283+
for monitors with groupings.
62846284

6285-
For instance, a monitor grouped by `cluster`, `namespace`, `pod` can be
6286-
configured to only notify on each
6285+
For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can
6286+
be configured to only notify on each
62876287

62886288
new `cluster` violating the alert conditions by setting `notify_by` to
62896289
`["cluster"]`. Tags mentioned
62906290

6291-
in `notify_by` have to be a subset of the grouping tags in the query.
6291+
in `notify_by` must be a subset of the grouping tags in the query.
62926292

6293-
For example, a query grouped by `cluster`, `namespace` cannot notify on
6294-
`region`.'
6293+
For example, a query grouped by `cluster` and `namespace` cannot notify
6294+
on `region`.
6295+
6296+
Setting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.'
62956297
items:
62966298
description: A grouping tag.
62976299
type: string

packages/datadog-api-client-v1/models/MonitorOptions.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,12 @@ export class MonitorOptions {
102102
*/
103103
"notifyAudit"?: boolean;
104104
/**
105-
* Controls what granularity a monitor alerts on. Only available for multi-alerts.
106-
* For instance, a monitor grouped by `cluster`, `namespace`, `pod` can be configured to only notify on each
105+
* Controls what granularity a monitor alerts on. Only available for monitors with groupings.
106+
* For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each
107107
* new `cluster` violating the alert conditions by setting `notify_by` to `["cluster"]`. Tags mentioned
108-
* in `notify_by` have to be a subset of the grouping tags in the query.
109-
* For example, a query grouped by `cluster`, `namespace` cannot notify on `region`.
108+
* in `notify_by` must be a subset of the grouping tags in the query.
109+
* For example, a query grouped by `cluster` and `namespace` cannot notify on `region`.
110+
* Setting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.
110111
*/
111112
"notifyBy"?: Array<string>;
112113
/**

0 commit comments

Comments
 (0)