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

[Alerting] Update UI to reflect new terminology #93597

Merged
merged 36 commits into from
Mar 15, 2021
Merged
Show file tree
Hide file tree
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 Mar 2, 2021
13331bf
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 Mar 3, 2021
200c2df
Updating formatted messages
ymao1 Mar 3, 2021
b3992b8
Updating i18n labels
ymao1 Mar 3, 2021
0bbde1a
Completed renaming in UI
ymao1 Mar 3, 2021
bad4432
Updating client routes including redirect
ymao1 Mar 3, 2021
551c00d
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 Mar 4, 2021
d007cad
wip docs update
ymao1 Mar 4, 2021
48e3b1e
Reverting title changes for now
ymao1 Mar 4, 2021
02493a4
Fixing types check
ymao1 Mar 4, 2021
4ee19eb
Fixing unit tests
ymao1 Mar 4, 2021
f403960
Fixing functional test
ymao1 Mar 4, 2021
c7bcede
Fixing functional test
ymao1 Mar 4, 2021
5967eb6
docs wip
ymao1 Mar 4, 2021
4c64785
Merging in master
ymao1 Mar 4, 2021
04b020e
wip docs update
ymao1 Mar 4, 2021
1f989fd
Finished first run through docs
ymao1 Mar 4, 2021
1272436
docs docs docs
ymao1 Mar 4, 2021
cdc58ff
Fixing bad merge
ymao1 Mar 4, 2021
c59e12a
Merging in master
ymao1 Mar 5, 2021
e18b02e
Fixing functional test
ymao1 Mar 5, 2021
d1ec60a
Docs cleanup
ymao1 Mar 5, 2021
92e6def
Cleaning up i18n labels
ymao1 Mar 5, 2021
b6914c8
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 Mar 5, 2021
2af1eb8
Fixing functional test
ymao1 Mar 5, 2021
c5255de
Merging in master
ymao1 Mar 8, 2021
4f976b7
Updating screenshots
ymao1 Mar 8, 2021
ac977cb
Updating screenshots
ymao1 Mar 9, 2021
0a525a8
Updating screenshots
ymao1 Mar 9, 2021
d7c6c91
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 Mar 9, 2021
58aca0d
Merging in master
ymao1 Mar 9, 2021
7c407bd
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 Mar 9, 2021
222bed4
Merge branch 'master' of https://github.com/elastic/kibana into alert…
ymao1 Mar 10, 2021
28fc765
Updating terminology in alerting examples
ymao1 Mar 10, 2021
73f2c4c
Updating terminology in alerting examples
ymao1 Mar 10, 2021
ebe293c
Merge branch 'master' into alerting/rename-ui
kibanamachine Mar 15, 2021
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
20 changes: 9 additions & 11 deletions docs/action-type-template.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[<ACTION-TYPE>-action-type]]
=== <ACTION-TYPE> action
=== <ACTION-TYPE> connector and action
++++
<titleabbrev><ACTION-TYPE></titleabbrev>
++++

Include a short description of the action type.
Include a short description of the connector type.

[float]
[[<ACTION-TYPE>-connector-configuration]]
Expand All @@ -13,24 +13,24 @@ Include a short description of the action type.
<ACTION-TYPE> connectors have the following configuration properties.

////
List of user-facing connector configurations. This should align with the fields available in the Create connector flyout form for this action type.
List of user-facing connector configurations. This should align with the fields available in the Create connector flyout form for this connector type.
////

Property1:: A short description of this property.
Property2:: A short description of this property with format hints. This can be specified in `this specific format`.

[float]
[[Preconfigured-<ACTION-TYPE>-configuration]]
==== Preconfigured action type
==== Preconfigured connector type

////
Example preconfigured format for this action type
Example preconfigured format for this connector type
////

[source,text]
--
my-<ACTION-TYPE>:
name: preconfigured-<ACTION-TYPE>-action-type
name: preconfigured-<ACTION-TYPE>-connector-type
actionTypeId: .<ACTION-TYPE>
config:
property1: value1
Expand All @@ -39,25 +39,23 @@ Example preconfigured format for this action type
property3: value3
--

[float]
[[<ACTION-TYPE>-connector-config-properties]]
////
List of properties from the ConfigSchema and SecretsSchema for this action type.
////
Config defines information for the action type.
Config defines information for the connector type.

`property1`:: A short description of this property.
`property2`:: A short descriptionn of this property.

Secrets defines sensitive information for the action type.
Secrets defines sensitive information for the connector type.

`property3`:: A short descriptionn of this property.

[float]
[[<ACTION-TYPE>-action-configuration]]
==== Action configuration

<ACTION-TYPE> actions have the following configuration properties.
<ACTION-TYPE> actions have the following properties.

////
List of user-facing action configurations. This should align with the fields available in the Action section of the Create/Update alert flyout.
Expand Down
39 changes: 0 additions & 39 deletions docs/alert-type-template.asciidoc

This file was deleted.

33 changes: 0 additions & 33 deletions docs/management/alerting/alert-details.asciidoc

This file was deleted.

58 changes: 0 additions & 58 deletions docs/management/alerting/alert-management.asciidoc

This file was deleted.

30 changes: 0 additions & 30 deletions docs/management/alerting/alerts-and-actions-intro.asciidoc

This file was deleted.

17 changes: 5 additions & 12 deletions docs/management/alerting/connector-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@
[[connector-management]]
=== Managing Connectors

beta[]

Alerts use *Connectors* to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {kib} app can offer their own types of alerts, they typically share connectors. The *Connectors* tab offers a central place to view and manage all the connectors in the current space.
Rules use *Connectors* to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {kib} app can offer their own types of rules, they typically share connectors. The *Connectors* tab offers a central place to view and manage all the connectors in the current space.

For more information on connectors and the types of actions available see <<action-types>>.

[role="screenshot"]
image::images/connector-listing.png[Example connector listing in the Alerts and Actions UI]
image::images/connector-listing.png[Example connector listing in the Rules and Connectors UI]


[float]
Expand All @@ -21,15 +19,10 @@ The *Connectors* tab lists all connectors in the current space. The *search bar*
image::images/connector-filter-by-search.png[Filtering the connector list using the search bar]


The *type* dropdown also lets you filter to a subset of action types.

[role="screenshot"]
image::images/connector-filter-by-type.png[Filtering the connector list by types of actions]

The *Actions* column indicates the number of actions that reference the connector. This count helps you confirm a connector is unused before you delete it, and tells you how many actions will be affected when a connector is modified.
The *type* dropdown also lets you filter to a subset of connector types.

[role="screenshot"]
image::images/connector-action-count.png[Filtering the connector list by types of actions]
image::images/connector-filter-by-type.png[Filtering the connector list by types of connectors]

You can delete individual connectors using the trash icon. Connectors can also be deleted in bulk by multi-selecting them and clicking the *Delete* button to the left of the search box.

Expand All @@ -44,4 +37,4 @@ When this happens the action will fail to execute, and appear as errors in the {

==== Creating a new connector

New connectors can be created by clicking the *Create connector* button, which will guide you to select the type of connector and configure it's properties. Refer to <<action-types>> for the types of connectors available and how to configure them. Once you create a connector it will be made available to you anytime you set up an action in the current space.
New connectors can be created by clicking the *Create connector* button, which will guide you to select the type of connector and configure its properties. Refer to <<action-types>> for the types of connectors available and how to configure them. Once you create a connector it will be made available to you anytime you set up an action in the current space.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/management/alerting/images/bulk-mute-disable.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 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 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.
Binary file modified docs/management/alerting/images/connector-listing.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 docs/management/alerting/images/individual-mute-disable.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.
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.
33 changes: 33 additions & 0 deletions docs/management/alerting/rule-details.asciidoc
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>>.
58 changes: 58 additions & 0 deletions docs/management/alerting/rule-management.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
[role="xpack"]
[[alert-management]]
=== Managing Rules
Copy link
Contributor

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"...

Copy link
Contributor Author

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 called Managing Connectors, I think Managing Rules is ok here? I'll let @gchaps be the final judge :)



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]
Loading