Skip to content

Update description for notify_by monitor option #1106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 14, 2022
Merged

Update description for notify_by monitor option #1106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ec7402
Regenerate client from commit 7eb6ca7a of spec repo
Oct 14, 2022
1ba262c
Merge branch 'master' into datadog-api-spec/generated/1905
api-clients-generation-pipeline[bot] Oct 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.4",
"regenerated": "2022-10-14 07:43:55.828324",
"spec_repo_commit": "13ac1a3a"
"regenerated": "2022-10-14 14:06:45.194856",
"spec_repo_commit": "7eb6ca7a"
},
"v2": {
"apigentools_version": "1.6.4",
"regenerated": "2022-10-14 07:43:55.842327",
"spec_repo_commit": "13ac1a3a"
"regenerated": "2022-10-14 14:06:45.212757",
"spec_repo_commit": "7eb6ca7a"
}
}
}
14 changes: 8 additions & 6 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6280,18 +6280,20 @@ components:
type: boolean
notify_by:
description: 'Controls what granularity a monitor alerts on. Only available
for multi-alerts.
for monitors with groupings.

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

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

in `notify_by` have to be a subset of the grouping tags in the query.
in `notify_by` must be a subset of the grouping tags in the query.

For example, a query grouped by `cluster`, `namespace` cannot notify on
`region`.'
For example, a query grouped by `cluster` and `namespace` cannot notify
on `region`.

Setting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.'
items:
description: A grouping tag.
type: string
Expand Down
9 changes: 5 additions & 4 deletions lib/datadog_api_client/v1/models/monitor_options.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,12 @@ class MonitorOptions
# A Boolean indicating whether tagged users is notified on changes to this monitor.
attr_accessor :notify_audit

# Controls what granularity a monitor alerts on. Only available for multi-alerts.
# For instance, a monitor grouped by `cluster`, `namespace`, `pod` can be configured to only notify on each
# Controls what granularity a monitor alerts on. Only available for monitors with groupings.
# For instance, a monitor grouped by `cluster`, `namespace`, and `pod` can be configured to only notify on each
# new `cluster` violating the alert conditions by setting `notify_by` to `["cluster"]`. Tags mentioned
# in `notify_by` have to be a subset of the grouping tags in the query.
# For example, a query grouped by `cluster`, `namespace` cannot notify on `region`.
# in `notify_by` must be a subset of the grouping tags in the query.
# For example, a query grouped by `cluster` and `namespace` cannot notify on `region`.
# Setting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.
attr_accessor :notify_by

# A Boolean indicating whether this monitor notifies when data stops reporting.
Expand Down