Skip to content

Commit

Permalink
Updating screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
ymao1 committed Mar 8, 2021
1 parent c5255de commit 4f976b7
Show file tree
Hide file tree
Showing 24 changed files with 10 additions and 12 deletions.
4 changes: 1 addition & 3 deletions docs/management/alerting/connector-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
[[connector-management]]
=== Managing Connectors

beta[]

Alerting uses *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 alerting rules, 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>>.

Expand Down
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.
10 changes: 5 additions & 5 deletions docs/management/alerting/rule-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,28 @@
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/alerts-details-instances-active.png[Rule details page with three alerts]
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/alerts-details-instance-muting.png[Muting an alert]
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/alerts-details-instances-inactive.png[Rule details page with three inactive alerts]
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/alerts-details-muting.png[Use the mute toggle to suppress all actions on current and future alerts]
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/alerts-details-disabling.png[Use the disable toggle to turn off rule checks and clear alerts tracked]
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>>.
6 changes: 3 additions & 3 deletions docs/management/alerting/rule-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ The *Rules* tab lists all rules in the current space, including summary informat
The *search bar* can be used to quickly find rules by name or tag.

[role="screenshot"]
image::images/alerts-filter-by-search.png[Filtering the rules list using the search bar]
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/alerts-filter-by-type.png[Filtering the rules list by types of rule]
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/alerts-filter-by-action-type.png[Filtering the rule list by type of action]
image::images/rules-filter-by-action-type.png[Filtering the rule list by type of action]

[float]
[[create-edit-rules]]
Expand Down
Binary file removed docs/user/images/alerts-and-actions.png
Binary file not shown.
Binary file added docs/user/images/rules-and-connectors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/user/introduction.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ to name a few.
A dedicated view for creating, searching, and editing rules is in <<alert-management,*Rules and Connectors*>>.

[role="screenshot"]
image::images/alerts-and-actions.png[Rules and Connectors view]
image::images/rules-and-connectors.png[Rules and Connectors view]


[float]
Expand Down

0 comments on commit 4f976b7

Please sign in to comment.