-
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.
[DOCS] Update Rules and Connectors app label (#145500)
- Loading branch information
Showing
10 changed files
with
24 additions
and
30 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 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 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 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 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 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 |
---|---|---|
|
@@ -31,7 +31,7 @@ and Task Manager <<task-manager-diagnosing-root-cause,diagnostics endpoints>>. | |
[float] | ||
[[alerting-managment-detail]] | ||
=== Using rules and connectors list for the current state and finding issues | ||
*{rules-ui}* in *{stack-manage-app}* lists the rules and connectors available in the space you're currently in. When you click a rule name, you are navigated to the <<rule-details,details page>> for the rule, where you can see currently active alerts. | ||
*{rac-ui}* in *{stack-manage-app}* lists the rules and connectors available in the space you're currently in. When you click a rule name, you are navigated to the <<rule-details,details page>> for the rule, where you can see currently active alerts. | ||
The start date on this page indicates when a rule is triggered, and for what alerts. In addition, the duration of the condition indicates how long the instance is active. | ||
[role="screenshot"] | ||
image::images/rule-details-alerts-inactive.png[Alerting management details] | ||
|
@@ -64,7 +64,7 @@ curl -X POST -k \ | |
-d '{"params":{"subject":"hallo","message":"hallo!","to":["[email protected]"]}}' | ||
-------------------------------------------------- | ||
|
||
experimental[] In addition, there is a command-line client that uses legacy {rules-ui} APIs, which can be easier to use, but must be updated for the new APIs. | ||
experimental[] In addition, there is a command-line client that uses legacy rules APIs, which can be easier to use, but must be updated for the new APIs. | ||
CLI tools to list, create, edit, and delete alerts (rules) and actions (connectors) are available in https://github.com/pmuellr/kbn-action[kbn-action], which you can install as follows: | ||
[source, txt] | ||
-------------------------------------------------- | ||
|
@@ -83,7 +83,7 @@ The result of this HTTP request (and printed to stdout by https://github.com/pmu | |
[[alerting-error-banners]] | ||
=== Look for error banners | ||
|
||
The **{stack-manage-app}** > *{rules-ui}* page contains an error banner that | ||
The **{stack-manage-app}** > *{rac-ui}* page contains an error banner that | ||
helps to identify the errors for the rules: | ||
|
||
[role="screenshot"] | ||
|
@@ -93,8 +93,8 @@ image::images/rules-management-health.png[Rule management page with the errors b | |
[[task-manager-diagnostics]] | ||
=== Task Manager diagnostics | ||
|
||
Under the hood, {rules-ui} uses a plugin called Task Manager, which handles the scheduling, running, and error handling of the tasks. | ||
This means that failure cases in {rules-ui} will, at times, be revealed by the Task Manager mechanism, rather than the Rules mechanism. | ||
Under the hood, the {alert-features} use a plugin called Task Manager, which handles the scheduling, running, and error handling of the tasks. | ||
This means that failure cases in the {alert-features} will, at times, be revealed by the task manager mechanism, rather than the rules mechanism. | ||
|
||
Task Manager provides a visible status which can be used to diagnose issues and is very well documented <<task-manager-health-monitoring,health monitoring>> and <<task-manager-troubleshooting,troubleshooting>>. | ||
Task Manager uses the `.kibana_task_manager` index, an internal index that contains all the saved objects that represent the tasks in the system. | ||
|
@@ -204,7 +204,7 @@ the {kib} {alert-features}. | |
==== Alert visibility | ||
|
||
If you create a rule in the {observability} or {security-app}, its alerts are | ||
not visible in *{stack-manage-app} > {rules-ui}*. You can view them only in the | ||
not visible in *{stack-manage-app} > {rac-ui}*. You can view them only in the | ||
{kib} app where you created the rule. If you use the | ||
<<create-rule-api,create rule API>>, the visibility of the alerts is related to | ||
the `consumer` property. | ||
|
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 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 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
3 changes: 1 addition & 2 deletions
3
docs/user/alerting/troubleshooting/testing-connectors.asciidoc
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