-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[Alerting] Update UI to reflect new terminology #93597
Merged
Merged
Changes from all commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
ab63e5f
Renaming alerts to rules
ymao1 13331bf
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 200c2df
Updating formatted messages
ymao1 b3992b8
Updating i18n labels
ymao1 0bbde1a
Completed renaming in UI
ymao1 bad4432
Updating client routes including redirect
ymao1 551c00d
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 d007cad
wip docs update
ymao1 48e3b1e
Reverting title changes for now
ymao1 02493a4
Fixing types check
ymao1 4ee19eb
Fixing unit tests
ymao1 f403960
Fixing functional test
ymao1 c7bcede
Fixing functional test
ymao1 5967eb6
docs wip
ymao1 4c64785
Merging in master
ymao1 04b020e
wip docs update
ymao1 1f989fd
Finished first run through docs
ymao1 1272436
docs docs docs
ymao1 cdc58ff
Fixing bad merge
ymao1 c59e12a
Merging in master
ymao1 e18b02e
Fixing functional test
ymao1 d1ec60a
Docs cleanup
ymao1 92e6def
Cleaning up i18n labels
ymao1 b6914c8
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 2af1eb8
Fixing functional test
ymao1 c5255de
Merging in master
ymao1 4f976b7
Updating screenshots
ymao1 ac977cb
Updating screenshots
ymao1 0a525a8
Updating screenshots
ymao1 d7c6c91
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 58aca0d
Merging in master
ymao1 7c407bd
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 222bed4
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 28fc765
Updating terminology in alerting examples
ymao1 73f2c4c
Updating terminology in alerting examples
ymao1 ebe293c
Merge branch 'master' into alerting/rename-ui
kibanamachine File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we be referring to these as "Alerting Rules" here? 🤔
I'm not 100% sure when we should use the whole term rather than just "Rules"...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is under the
Rules and Connectors
page and there's a sibling page calledManaging Connectors
, I thinkManaging Rules
is ok here? I'll let @gchaps be the final judge :)