-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Alerting] Update UI to reflect new terminology (#93597)
* Renaming alerts to rules * Updating formatted messages * Updating i18n labels * Completed renaming in UI * Updating client routes including redirect * wip docs update * Reverting title changes for now * Fixing types check * Fixing unit tests * Fixing functional test * Fixing functional test * docs wip * wip docs update * Finished first run through docs * docs docs docs * Fixing bad merge * Fixing functional test * Docs cleanup * Cleaning up i18n labels * Fixing functional test * Updating screenshots * Updating screenshots * Updating screenshots * Updating terminology in alerting examples * Updating terminology in alerting examples Co-authored-by: Kibana Machine <[email protected]>
- Loading branch information
1 parent
bd9170f
commit a7c9d3f
Showing
162 changed files
with
852 additions
and
966 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
30 changes: 0 additions & 30 deletions
30
docs/management/alerting/alerts-and-actions-intro.asciidoc
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-101 KB
docs/management/alerting/images/alerts-details-instances-inactive.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+42.8 KB
(200%)
docs/management/alerting/images/connector-filter-by-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+181 KB
(280%)
docs/management/alerting/images/connector-filter-by-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
[role="xpack"] | ||
[[rule-details]] | ||
=== Rule details | ||
|
||
|
||
The *Rule details* page tells you about the state of the rule and provides granular control over the actions it is taking. | ||
|
||
[role="screenshot"] | ||
image::images/rule-details-alerts-active.png[Rule details page with three alerts] | ||
|
||
In this example, the rule detects when a site serves more than a threshold number of bytes in a 24 hour period. Three sites are above the threshold. These are called alerts - occurrences of the condition being detected - and the alert name, status, time of detection, and duration of the condition are shown in this view. | ||
|
||
Upon detection, each alert can trigger one or more actions. If the condition persists, the same actions will trigger either on the next scheduled rule check, or (if defined) after the re-notify period on the rule has passed. To prevent re-notification, you can suppress future actions by clicking on the eye icon to mute an individual alert. Muting means that the rule checks continue to run on a schedule, but that alert will not trigger any action. | ||
|
||
[role="screenshot"] | ||
image::images/rule-details-alert-muting.png[Muting an alert] | ||
|
||
Alerts will come and go from the list depending on whether they meet the rule conditions or not - unless they are muted. If a muted instance no longer meets the rule conditions, it will appear as inactive in the list. This prevents an alert from triggering actions if it reappears in the future. | ||
|
||
[role="screenshot"] | ||
image::images/rule-details-alerts-inactive.png[Rule details page with three inactive alerts] | ||
|
||
If you want to suppress actions on all current and future alerts, you can mute the entire rule. Rule checks continue to run and the alert list will update as alerts activate or deactivate, but no actions will be triggered. | ||
|
||
[role="screenshot"] | ||
image::images/rule-details-muting.png[Use the mute toggle to suppress all actions on current and future alerts] | ||
|
||
You can also disable a rule altogether. When disabled, the rule stops running checks altogether and will clear any alerts it is tracking. You may want to disable rules that are not currently needed to reduce the load on {kib} and {es}. | ||
|
||
[role="screenshot"] | ||
image::images/rule-details-disabling.png[Use the disable toggle to turn off rule checks and clear alerts tracked] | ||
|
||
* For further information on alerting concepts and examples, see <<alerting-getting-started>>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
[role="xpack"] | ||
[[alert-management]] | ||
=== Managing Rules | ||
|
||
|
||
The *Rules* tab provides a cross-app view of alerting. Different {kib} apps like {observability-guide}/create-alerts.html[*Observability*], {security-guide}/prebuilt-rules.html[*Security*], <<geo-alerting, *Maps*>> and <<xpack-ml, *Machine Learning*>> can offer their own rules. The *Rules* tab provides a central place to: | ||
|
||
* <<create-edit-rules, Create and edit>> rules | ||
* <<controlling-rules, Control rules>> including enabling/disabling, muting/unmuting, and deleting | ||
* Drill-down to <<rule-details, rule details>> | ||
|
||
[role="screenshot"] | ||
image:management/alerting/images/rules-and-connectors-ui.png[Example rule listing in the Rules and Connectors UI] | ||
|
||
For more information on alerting concepts and the types of rules and connectors available, see <<alerting-getting-started>>. | ||
|
||
[float] | ||
==== Finding rules | ||
|
||
The *Rules* tab lists all rules in the current space, including summary information about their execution frequency, tags, and type. | ||
|
||
The *search bar* can be used to quickly find rules by name or tag. | ||
|
||
[role="screenshot"] | ||
image::images/rules-filter-by-search.png[Filtering the rules list using the search bar] | ||
|
||
The *type* dropdown lets you filter to a subset of rule types. | ||
|
||
[role="screenshot"] | ||
image::images/rules-filter-by-type.png[Filtering the rules list by types of rule] | ||
|
||
The *Action type* dropdown lets you filter by the type of action used in the rule. | ||
|
||
[role="screenshot"] | ||
image::images/rules-filter-by-action-type.png[Filtering the rule list by type of action] | ||
|
||
[float] | ||
[[create-edit-rules]] | ||
==== Creating and editing rules | ||
|
||
Many rules must be created within the context of a {kib} app like <<metrics-app, Metrics>>, <<xpack-apm, APM>>, or <<uptime-app, Uptime>>, but others are generic. Generic rule types can be created in the *Rules* management UI by clicking the *Create* button. This will launch a flyout that guides you through selecting a rule type and configuring its properties. Refer to <<rule-types>> for details on what types of rules are available and how to configure them. | ||
|
||
After a rule is created, you can re-open the flyout and change a rule's properties by clicking the *Edit* button shown on each row of the rule listing. | ||
|
||
|
||
[float] | ||
[[controlling-rules]] | ||
==== Controlling rules | ||
|
||
The rule listing allows you to quickly mute/unmute, disable/enable, and delete individual rules by clicking the action button. | ||
|
||
[role="screenshot"] | ||
image:management/alerting/images/individual-mute-disable.png[The actions button allows an individual rule to be muted, disabled, or deleted] | ||
|
||
These operations can also be performed in bulk by multi-selecting rules and clicking the *Manage rules* button: | ||
|
||
[role="screenshot"] | ||
image:management/alerting/images/bulk-mute-disable.png[The Manage rules button lets you mute/unmute, enable/disable, and delete in bulk] |
Oops, something went wrong.