Skip to content

Commit

Permalink
[8.11] [DOCS] Add solution selection to maintenance windows (#169441) (
Browse files Browse the repository at this point in the history
…#170566)

# Backport

This will backport the following commits from `main` to `8.11`:
- [[DOCS] Add solution selection to maintenance windows
(#169441)](#169441)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-11-03T18:36:55Z","message":"[DOCS]
Add solution selection to maintenance windows
(#169441)","sha":"89dd69656cd82e67f653b2bd4adf5a83ae76bf0c","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:prev-minor","v8.11.0","v8.12.0"],"number":169441,"url":"https://github.com/elastic/kibana/pull/169441","mergeCommit":{"message":"[DOCS]
Add solution selection to maintenance windows
(#169441)","sha":"89dd69656cd82e67f653b2bd4adf5a83ae76bf0c"}},"sourceBranch":"main","suggestedTargetBranches":["8.11"],"targetPullRequestStates":[{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/169441","number":169441,"mergeCommit":{"message":"[DOCS]
Add solution selection to maintenance windows
(#169441)","sha":"89dd69656cd82e67f653b2bd4adf5a83ae76bf0c"}}]}]
BACKPORT-->

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
  • Loading branch information
kibanamachine and lcawl authored Nov 3, 2023
1 parent 14d021f commit f2ea0c4
Show file tree
Hide file tree
Showing 7 changed files with 810 additions and 133 deletions.
37 changes: 35 additions & 2 deletions docs/api/alerting/list_rule_types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,14 @@ context and state in action parameter templates, and a short human readable
description. When you create a rule in {kib}, it uses this information to prompt
you for these variables in action parameter editors.

// `alerts`:: TBD

`authorized_consumers`::
(object) The list of the plugins IDs that have access to the rule type.

`category`::
(string) The rule category, which is used by features such as category-specific maintenance windows.

`default_action_group_id`::
(string) The default ID for the rule type group.

Expand All @@ -77,6 +82,10 @@ action.
(boolean) Indicates whether the rule type is enabled or disabled based on the
subscription.

// `has_alerts_mappings`:: TBD

// `has_fields_for_a_a_d`:: TBD

`id`::
(string) The unique identifier for the rule type.

Expand Down Expand Up @@ -121,7 +130,28 @@ the API returns the following:
{
"id":"logs.alert.document.count",
"name":"Log threshold",
"category": "observability",
"producer":"logs",
"alerts": {
"context": "observability.logs",
"mappings": {
"fieldMap": {
"kibana.alert.evaluation.threshold": {
"type": "scaled_float",
"scaling_factor": 100,
"required": false
},
"kibana.alert.evaluation.value": {
"type": "scaled_float",
"scaling_factor": 100,
"required": false
},
...
}
},
"useEcs": true,
"useLegacyAlerts": true
},
"enabled_in_license":true,
"recovery_action_group":{
"id":"recovered",
Expand Down Expand Up @@ -164,7 +194,10 @@ the API returns the following:
"logs":{"read":true,"all":false},
"alerts":{"read":true,"all":false}
},
"does_set_recovery_context":true
}
"does_set_recovery_context":true,
"has_alerts_mappings": true,
"has_fields_for_a_a_d": true
},
....
]
--------------------------------------------------
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ preview::[]
You can schedule single or recurring maintenance windows to temporarily reduce rule notifications.
For example, a maintenance window prevents false alarms during planned outages.

Maintenance windows affect all rules in all {kib} apps and spaces.
By default, maintenance windows affect all rules in all {kib} apps and spaces.
Alerts continue to be generated, however notifications are suppressed as follows:

- When an alert occurs during a maintenance window, there are no notifications.
Expand Down Expand Up @@ -42,6 +42,10 @@ You can optionally configure it to repeat daily, monthly, yearly, or on a custom
image::images/create-maintenance-window.png[The Create Maintenance Window user interface in {kib}]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

By default, maintenance windows affect all categories of rules.
The category-specific maintenance window options alter this behavior.
For the definitive list of rule types in each category, refer to the <<list-rule-types-api,get rule types API>>.

A maintenance window can have any one of the following statuses:

- `Upcoming`: It will run at the scheduled date and time.
Expand Down
Loading

0 comments on commit f2ea0c4

Please sign in to comment.