Skip to content

Commit

Permalink
[8.1] [DOCS] Update Rules and Connectors app label (#145500) (#145648)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Nov 18, 2022
1 parent 44d73da commit b2cefba
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 19 deletions.
3 changes: 1 addition & 2 deletions docs/management/action-types.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[role="xpack"]
[[action-types]]
== Connectors

Expand Down Expand Up @@ -76,7 +75,7 @@ Rules use *Connectors* to route actions to different destinations like log files
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 Rules and Connectors UI]
image::images/connector-listing.png[Example connector listing in the {rac-ui} UI]

[float]
=== Required permissions
Expand Down
2 changes: 1 addition & 1 deletion docs/user/alerting/alerting-getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Alerting allows you to define *rules* to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with {observability-guide}/create-alerts.html[*Observability*], {security-guide}/prebuilt-rules.html[*Security*], <<geo-alerting,*Maps*>> and {ml-docs}/ml-configuring-alerts.html[*{ml-app}*], can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, connectors>> and <<stack-rules, rules>> (known as stack rules) for you to use.

image::images/alerting-overview.png[Rules and Connectors UI]
image::images/alerting-overview.png[{rac-ui} UI]

[IMPORTANT]
==============================================
Expand Down
1 change: 0 additions & 1 deletion docs/user/alerting/alerting-setup.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[role="xpack"]
[[alerting-setup]]
== Alerting set up
++++
Expand Down
11 changes: 6 additions & 5 deletions docs/user/alerting/alerting-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ 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 and Connectors* in *Stack Management* 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]
Expand Down Expand Up @@ -62,7 +63,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 and Connectors 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 and connectors 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]
--------------------------------------------------
Expand Down Expand Up @@ -92,8 +93,8 @@ image::images/rules-details-health.png[Rule details page with the errors banner]
[[task-manager-diagnostics]]
=== Task Manager diagnostics

Under the hood, *Rules and Connectors* uses a plugin called Task Manager, which handles the scheduling, execution, and error handling of the tasks.
This means that failure cases in Rules or Connectors will, at times, be revealed by the Task Manager mechanism, rather than the Rules mechanism.
Under the hood, *{rac-ui}* uses a plugin called Task Manager, which handles the scheduling, execution, and error handling of the tasks.
This means that failure cases in *{rac-ui}* 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.
Expand Down Expand Up @@ -203,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.
Expand Down
5 changes: 2 additions & 3 deletions docs/user/alerting/create-and-manage-rules.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[role="xpack"]
[[create-and-manage-rules]]
== Create and manage rules

Expand All @@ -9,7 +8,7 @@ The *Rules* UI provides a cross-app view of alerting. Different {kib} apps like
* Drill-down to <<rule-details, rule details>>

[role="screenshot"]
image:images/rules-and-connectors-ui.png[Example rule listing in the Rules and Connectors UI]
image:images/rules-and-connectors-ui.png[Example rule listing in {rac-ui}]

For more information on alerting concepts and the types of rules and connectors available, see <<alerting-getting-started>>.

Expand All @@ -22,7 +21,7 @@ Access to rules is granted based on your privileges to alerting-enabled features
[[create-edit-rules]]
=== Create and edit 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 conditions and action type. Refer to <<stack-rules, Stack rules>> for details on what types of rules are available and how to configure them.
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 conditions and action type. Refer to <<stack-rules,Stack rules>> 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.

Expand Down
9 changes: 4 additions & 5 deletions docs/user/alerting/rule-types.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
[role="xpack"]
[[rule-types]]
== Rule types

A rule is a set of <<alerting-concepts-conditions, conditions>>, <<alerting-concepts-scheduling, schedules>>, and <<alerting-concepts-actions, actions>> that enable notifications. {kib} provides rules built into the Elastic Stack and rules registered by one of the {kib} apps.
You can create most rules types in <<create-and-manage-rules,Stack Management > Rules and Connectors>>. For information on creating security rules, refer to {security-guide}/rules-ui-create.html[Create a detection rule].
A rule is a set of <<alerting-concepts-conditions,conditions>>, <<alerting-concepts-scheduling,schedules>>, and <<alerting-concepts-actions,actions>> that enable notifications. {kib} provides rules built into the Elastic Stack and rules registered by one of the {kib} apps.
You can create most rules types in <<create-and-manage-rules,{stack-manage-app} > {rac-ui}>>. For information on creating security rules, refer to {security-guide}/rules-ui-create.html[Create a detection rule].

[NOTE]
==============================================
Expand Down Expand Up @@ -44,7 +43,7 @@ Observability rules are categorized into APM and User Experience, Logs, Metrics,
[NOTE]
==============================================
If you create a rule in the {observability} app, its alerts are not visible in
*{stack-manage-app} > {rules-ui}*. They are visible only in the {observability} app.
*{stack-manage-app} > {rac-ui}*. They are visible only in the {observability} app.
==============================================

[cols="2*<"]
Expand Down Expand Up @@ -83,7 +82,7 @@ Security rules detect suspicious source events with pre-built or custom rules an
[NOTE]
==============================================
Alerts associated with security rules are visible only in the {security-app};
they are not visible in *{stack-manage-app} > {rules-ui}*.
they are not visible in *{stack-manage-app} > {rac-ui}*.
==============================================

include::rule-types/index-threshold.asciidoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[role="xpack"]
[[alerting-common-issues]]
=== Common Issues

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[role="xpack"]
[[testing-connectors]]
=== Test connectors

Expand Down

0 comments on commit b2cefba

Please sign in to comment.