Skip to content

Commit

Permalink
[8.4] [DOCS] Update Rules and Connectors app label (#145500) (#145638)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `8.5` to `8.4`:
- [[DOCS] Update Rules and Connectors app label
(#145500)](#145500)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2022-11-17T17:51:10Z","message":"[DOCS]
Update Rules and Connectors app label
(#145500)","sha":"57a67de01e3d7d376ea9f75e5529e950d6e66528","branchLabelMapping":{"^v8.5.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","auto-backport","Feature:Alerting/RulesManagement","v8.0.2","v8.1.4","v8.2.4","v8.3.4","v8.4.4","v8.5.2"],"number":145500,"url":"https://github.com/elastic/kibana/pull/145500","mergeCommit":{"message":"[DOCS]
Update Rules and Connectors app label
(#145500)","sha":"57a67de01e3d7d376ea9f75e5529e950d6e66528"}},"sourceBranch":"8.5","suggestedTargetBranches":["8.0","8.1","8.2","8.3","8.4"],"targetPullRequestStates":[{"branch":"8.0","label":"v8.0.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.1","label":"v8.1.4","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.2","label":"v8.2.4","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.3","label":"v8.3.4","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.4","label":"v8.4.4","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.5","label":"v8.5.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/145500","number":145500,"mergeCommit":{"message":"[DOCS]
Update Rules and Connectors app label
(#145500)","sha":"57a67de01e3d7d376ea9f75e5529e950d6e66528"}}]}]
BACKPORT-->
  • Loading branch information
lcawl authored Nov 17, 2022
1 parent 8dbdf2f commit 95c6051
Show file tree
Hide file tree
Showing 11 changed files with 32 additions and 29 deletions.
6 changes: 3 additions & 3 deletions docs/CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Review the following information about the {kib} 8.4.0 release.
If you have alerting rules that have been snoozed, do not upgrade {kib} to 8.4.0. Upgrade to 8.4.1 instead.

To determine if you have snoozed alerting rules, open the main menu, then click
**{stack-manage-app}** -> **{rules-ui}**. Filter the rule list by selecting
**{stack-manage-app}** -> **{rac-ui}**. Filter the rule list by selecting
**View** -> **Snoozed**. If you must upgrade to 8.4.0, for each space, cancel
the snooze for all affected rules before you upgrade.

Expand Down Expand Up @@ -732,7 +732,7 @@ If you have upgraded to 8.3.0 or 8.3.1, and your alerting rules fail, reset the
To disable, then re-enable your alerting rules:
. Open the main menu, then click *{stack-manage-app} > {rules-ui}*.
. Open the main menu, then click *{stack-manage-app} > {rac-ui}*.
. Select the failed alerting rules.
Expand Down Expand Up @@ -797,7 +797,7 @@ Alerting users who are running 8.2 should not upgrade to either 8.3.0 or 8.3.1.
Both 8.3.0 and 8.3.1 have a bug where alerting rules that were created or edited
in 8.2 will stop running on upgrade. If you have upgraded to 8.3.0 or 8.3.1 and
your alerting rules have stopped running with an error similar to the following
example, you will need to go to *{stack-manage-app} > {rules-ui}*, multi-select
example, you will need to go to *{stack-manage-app} > {rac-ui}*, multi-select
the failed rules, click on **Manage rules > Disable** and then click on **Manage
rules > Enable**. Disabling and re-enabling the rule will generate a new API key
using the credentials of the user performing these actions and reset the rule
Expand Down
5 changes: 2 additions & 3 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 @@ -82,7 +81,7 @@ For a comparison of the Elastic subscription levels, go to
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.

[role="screenshot"]
image::images/connector-listing.png[Example connector listing in the {rules-ui} UI]
image::images/connector-listing.png[Example connector listing in the {rac-ui} UI]

[float]
=== Required permissions
Expand Down Expand Up @@ -142,7 +141,7 @@ To import and export connectors, use the
image::images/connectors-import-banner.png[Connectors import banner, width=50%]

If a connector is missing sensitive information after the import, a **Fix**
button appears in *{rules-ui}*.
button appears in *{rac-ui}*.

[role="screenshot"]
image::images/connectors-with-missing-secrets.png[Connectors with missing secrets]
Expand Down
2 changes: 1 addition & 1 deletion docs/management/cases/add-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ appropriate {kib} feature privileges. Refer to <<setup-cases>>.
[[create-case-connectors]]
== Create connectors

You can create connectors in *Management > {stack-manage-app} > {rules-ui}*, as
You can create connectors in *Management > {stack-manage-app} > {rac-ui}*, as
described in <<action-types>>. Alternatively, you can create them in
*Management > {stack-manage-app} > Cases*:

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 @@ -5,7 +5,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-ui} UI]
image::images/alerting-overview.png[{rac-ui} UI]

[IMPORTANT]
==============================================
Expand Down
5 changes: 2 additions & 3 deletions 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 Expand Up @@ -46,7 +45,7 @@ For more information on the scalability of {alert-features}, go to

If you want to use the {alert-features} in a {kib} app, you must have the
appropriate feature privileges. For example, to create rules in
*{stack-manage-app} > {rules-ui}*, you must have `all` privileges for the
*{stack-manage-app} > {rac-ui}*, you must have `all` privileges for the
*Management > Stack Rules* feature. To attach actions to the rule, you must also
have `read` privileges for the *{connectors-feature}* feature. For more
information on configuring roles that provide access to features, go to
Expand Down Expand Up @@ -88,7 +87,7 @@ example, in the case of imported rules), it generates a new key that has your
security privileges.

You can update an API key manually in
**{stack-manage-app} > {rules-ui}** or in the rule details page by selecting
**{stack-manage-app} > {rac-ui}** or in the rule details page by selecting
**Update API key** in the actions menu.

[IMPORTANT]
Expand Down
10 changes: 5 additions & 5 deletions docs/user/alerting/alerting-troubleshooting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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]
--------------------------------------------------
Expand Down Expand Up @@ -94,8 +94,8 @@ image::images/rules-details-health.png[Rule details page with the errors banner]
[[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.
Expand Down Expand Up @@ -205,7 +205,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
16 changes: 12 additions & 4 deletions docs/user/alerting/create-and-manage-rules.asciidoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
[role="xpack"]
[[create-and-manage-rules]]
== Create and manage rules

The *Rules* UI 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* UI provides a central place to:
The *{stack-manage-app}* > *{rac-ui}* UI 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,*{ml-app}*>> can offer their own rules. *{rac-ui}* provides a
central place to:

* <<create-edit-rules,Create and edit>> rules
* <<controlling-rules,Manage rules>> including enabling/disabling, muting/unmuting, and deleting
* 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 +25,12 @@ 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 *{rac-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. For details on what
types of rules are available and how to configure them, refer to <<stack-rules>>.

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
7 changes: 3 additions & 4 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 {stack} and rules registered by one of the {kib} apps.
You can create most rules types in <<create-and-manage-rules,{stack-manage-app} > {rules-ui}>>. For information on creating security rules, refer to {security-guide}/rules-ui-create.html[Create a detection rule].
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 @@ see {subscriptions}[the subscription page].
[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 Expand Up @@ -284,5 +283,5 @@ to 8.3.0 or 8.3.1. The following error occurs:
*Solution*:

Upgrade to 8.3.2 or later releases to avoid the problem. To fix failing rules,
go to *{stack-manage-app} > {rules-ui}* and generate new API keys by selecting **Update API key** from the actions menu. For more details about API key authorization, refer to <<alerting-authorization>>.
go to *{stack-manage-app} > {rac-ui}* and generate new API keys by selecting **Update API key** from the actions menu. For more details about API key authorization, refer to <<alerting-authorization>>.

Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
[role="xpack"]
[[testing-connectors]]
=== Test connectors


In *{stack-manage-app} > {rules-ui}*, you can test a newly created connector by navigating to the Test tab of Connector Edit flyout or by clicking "Save & test" button on Create flyout:
In *{stack-manage-app} > {rac-ui}*, you can test a newly created connector by navigating to the Test tab of Connector Edit flyout or by clicking "Save & test" button on Create flyout:
[role="screenshot"]
image::user/alerting/images/connector-save-and-test.png[Rule management page with the errors banner]

Expand Down
2 changes: 1 addition & 1 deletion docs/user/whats-new.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ for a specific duration. In 8.4, you can also schedule these single or recurring
downtimes to start and end at specific dates and times.

[role="screenshot"]
image::images/highlights-snooze-schedule.png[Snooze notifications for a rule in {stack-manage-app} > {rules-ui} ]
image::images/highlights-snooze-schedule.png[Snooze notifications for a rule in {stack-manage-app} > {rac-ui} ]

[discrete]
==== New metrics for rules and actions
Expand Down

0 comments on commit 95c6051

Please sign in to comment.