Skip to content
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.

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

[DOCS] Maintenance windows #157806

Merged
merged 9 commits into from
May 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions docs/management/maintenance-windows/maintenance-windows.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
[[maintenance-windows]]
== Maintenance windows
:description: Maintenance windows enable you to suppress rule notifications.
:tags-products: [kibana, alerting]
:tags-content-type: [overview]
:tags-user-goals: [manage]

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.
Alerts continue to be generated, however notifications are suppressed as follows:

- When an alert occurs during a maintenance window, there are no notifications.
When the alert recovers, there are no notifications--even if the recovery occurs after the maintenance window ends.
- When an alert occurs before a maintenance window and recovers during or after the maintenance window, notifications are sent as usual.

[discrete]
[[setup-maintenance-windows]]
== Configure access to maintenance windows

To use maintenance windows, you must have the appropriate {subscriptions}[subscription] and {kib} feature privileges.

- To have full access to maintenance windows, you must have `All` privileges for the *Management > Maintenance Windows* feature.
- To have view-only access to maintenance windows, you must have `Read` privileges for the **Management > Maintenance Windows* feature.

For more details, refer to <<kibana-privileges>>.

[discrete]
[[manage-maintenance-windows]]
== Create and manange maintenance windows

In *Management > {stack-manage-app} > Maintenance Windows*, you can create, edit, and archive maintenance windows.

When you create a maintenance window, you must provide a name and a schedule.
You can optionally configure it to repeat daily, monthly, yearly, or on a custom interval.

[role="screenshot"]
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.

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

- `Upcoming`: It will run at the scheduled date and time.
- `Running`: It is running.
- `Finished`: It ended and does not have a repeat schedule.
- `Archived`: It is archived. In a future release, archived maintenance windows will be queued for deletion.
1 change: 1 addition & 0 deletions docs/user/alerting/create-and-manage-rules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ image:images/snooze-panel.png[Snooze notifications for a rule]
When a rule is in a snoozed state, you can cancel or change the duration of
this state.

preview:[] To temporarily suppress notifications for _all_ rules, create a <<maintenance-windows,maintenance window>>.

[float]
[[importing-and-exporting-rules]]
Expand Down
5 changes: 5 additions & 0 deletions docs/user/management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ Viewer or Anomaly Explorer to see your {anomaly-detect} results.
For example, you might create an alert when the maximum total CPU usage on a machine goes
above a certain percentage.

| <<maintenance-windows,Maintenance windows>>
| Suppress rule notifications for scheduled periods of time.

|===

[float]
Expand Down Expand Up @@ -184,6 +187,8 @@ include::{kib-repo-dir}/management/action-types.asciidoc[]

include::{kib-repo-dir}/management/managing-licenses.asciidoc[]

include::{kib-repo-dir}/management/maintenance-windows/maintenance-windows.asciidoc[]

include::{kib-repo-dir}/management/manage-data-views.asciidoc[]

include::{kib-repo-dir}/management/numeral.asciidoc[]
Expand Down
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/get_doc_links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -511,6 +511,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => {
indexAction: `${KIBANA_DOCS}index-action-type.html`,
esQuery: `${KIBANA_DOCS}rule-type-es-query.html`,
indexThreshold: `${KIBANA_DOCS}rule-type-index-threshold.html`,
maintenanceWindows: `${KIBANA_DOCS}maintenance-windows.html`,
pagerDutyAction: `${KIBANA_DOCS}pagerduty-action-type.html`,
preconfiguredConnectors: `${KIBANA_DOCS}pre-configured-connectors.html`,
preconfiguredAlertHistoryConnector: `${KIBANA_DOCS}index-action-type.html#preconfigured-connector-alert-history`,
Expand Down
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,7 @@ export interface DocLinks {
indexAction: string;
esQuery: string;
indexThreshold: string;
maintenanceWindows: string;
pagerDutyAction: string;
preconfiguredConnectors: string;
preconfiguredAlertHistoryConnector: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export const EmptyPrompt = React.memo<EmptyPromptProps>(
<EuiButtonEmpty
key="documentation-button"
target="_blank"
href={docLinks.alerting.guide}
href={docLinks.alerting.maintenanceWindows}
iconType="help"
>
{i18n.EMPTY_PROMPT_DOCUMENTATION}
Expand Down