-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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][Docs] Moving alerting setup to its own page #101323
Changes from 13 commits
d972a4c
2a93e6d
3ad835d
1712a65
7c8df3e
b6c5185
6485936
1a4efd6
0d1e22a
849d29d
74c50df
bdcdd62
076561e
76aba7b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,7 +11,7 @@ image::images/alerting-overview.png[Rules and Connectors UI] | |
|
||
[IMPORTANT] | ||
============================================== | ||
To make sure you can access alerting and actions, see the <<alerting-setup-prerequisites, setup and pre-requisites>> section. | ||
To make sure you can access alerting and actions, see the <<alerting-prerequisites, setup and pre-requisites>> section. | ||
============================================== | ||
|
||
[float] | ||
|
@@ -22,15 +22,18 @@ Actions typically involve interaction with {kib} services or third party integra | |
This section describes all of these elements and how they operate together. | ||
|
||
[float] | ||
=== What is a rule? | ||
=== Rules | ||
|
||
A rule specifies a background task that runs on the {kib} server to check for specific conditions. It consists of three main parts: | ||
|
||
* *Conditions*: what needs to be detected? | ||
* *Schedule*: when/how often should detection checks run? | ||
* *Actions*: what happens when a condition is detected? | ||
|
||
For example, when monitoring a set of servers, a rule might check for average CPU usage > 0.9 on each server for the last two minutes (condition), checked every minute (schedule), sending a warning email message via SMTP with subject `CPU on {{server}} is high` (action). | ||
For example, when monitoring a set of servers, a rule might: | ||
* Check for average CPU usage > 0.9 on each server for the last two minutes (condition). | ||
* Check every minute (schedule). | ||
* Send a warning email message via SMTP with subject `CPU on {{server}} is high` (action). | ||
|
||
image::images/what-is-a-rule.svg[Three components of a rule] | ||
|
||
|
@@ -40,7 +43,7 @@ The following sections describe each part of the rule in more detail. | |
[[alerting-concepts-conditions]] | ||
==== Conditions | ||
|
||
Under the hood, {kib} rules detect conditions by running a javascript function on the {kib} server, which gives it the flexibility to support a wide range of conditions, anything from the results of a simple {es} query to heavy computations involving data from multiple sources or external systems. | ||
Under the hood, {kib} rules detect conditions by running a Javascript function on the {kib} server, which gives it the flexibility to support a wide range of conditions, anything from the results of a simple {es} query to heavy computations involving data from multiple sources or external systems. | ||
|
||
These conditions are packaged and exposed as *rule types*. A rule type hides the underlying details of the condition, and exposes a set of parameters | ||
to control the details of the conditions to detect. | ||
|
@@ -68,22 +71,22 @@ Actions are invocations of connectors, which allow interaction with {kib} servic | |
|
||
When defining actions in a rule, you specify: | ||
|
||
* the *connector type*: the type of service or integration to use | ||
* the connection for that type by referencing a <<alerting-concepts-connectors, connector>> | ||
* a mapping of rule values to properties exposed for that type of action | ||
* The *connector type*: the type of service or integration to use | ||
* The connection for that type by referencing a <<alerting-concepts-connectors, connector>> | ||
* A mapping of rule values to properties exposed for that type of action | ||
|
||
The result is a template: all the parameters needed to invoke a service are supplied except for specific values that are only known at the time the rule condition is detected. | ||
|
||
In the server monitoring example, the `email` connector type is used, and `server` is mapped to the body of the email, using the template string `CPU on {{server}} is high`. | ||
|
||
When the rule detects the condition, it creates an <<alerting-concepts-alert-instances, alert>> containing the details of the condition, renders the template with these details such as server name, and executes the action on the {kib} server by invoking the `email` connector type. | ||
When the rule detects the condition, it creates an <<alerting-concepts-alerts, alert>> containing the details of the condition, renders the template with these details such as server name, and executes the action on the {kib} server by invoking the `email` connector type. | ||
|
||
image::images/what-is-an-action.svg[Actions are like templates that are rendered when an alert detects a condition] | ||
|
||
See <<action-types>> for details on the types of connectors provided by {kib}. | ||
|
||
[float] | ||
[[alerting-concepts-alert-instances]] | ||
[[alerting-concepts-alerts]] | ||
=== Alerts | ||
|
||
When checking for a condition, a rule might identify multiple occurrences of the condition. {kib} tracks each of these *alerts* separately and takes an action per alert. | ||
|
@@ -92,22 +95,6 @@ Using the server monitoring example, each server with average CPU > 0.9 is track | |
|
||
image::images/alerts.svg[{kib} tracks each detected condition as an alert and takes action on each alert] | ||
|
||
[float] | ||
[[alerting-concepts-suppressing-duplicate-notifications]] | ||
=== Suppressing duplicate notifications | ||
|
||
Since actions are executed per alert, a rule can end up generating a large number of actions. Take the following example where a rule is monitoring three servers every minute for CPU usage > 0.9: | ||
|
||
* Minute 1: server X123 > 0.9. *One email* is sent for server X123. | ||
* Minute 2: X123 and Y456 > 0.9. *Two emails* are sent, one for X123 and one for Y456. | ||
* Minute 3: X123, Y456, Z789 > 0.9. *Three emails* are sent, one for each of X123, Y456, Z789. | ||
|
||
In the above example, three emails are sent for server X123 in the span of 3 minutes for the same rule. Often it's desirable to suppress frequent re-notification. Operations like muting and throttling can be applied at the alert level. If we set the rule re-notify interval to 5 minutes, we reduce noise by only getting emails for new servers that exceed the threshold: | ||
|
||
* Minute 1: server X123 > 0.9. *One email* is sent for server X123. | ||
* Minute 2: X123 and Y456 > 0.9. *One email* is sent for Y456. | ||
* Minute 3: X123, Y456, Z789 > 0.9. *One email* is sent for Z789. | ||
|
||
[float] | ||
[[alerting-concepts-connectors]] | ||
=== Connectors | ||
|
@@ -120,7 +107,7 @@ Rather than repeatedly entering connection information and credentials for each | |
image::images/rule-concepts-connectors.svg[Connectors provide a central place to store service connection settings] | ||
|
||
[float] | ||
=== Summary | ||
== Putting it all together | ||
|
||
A *rule* consists of conditions, *actions*, and a schedule. When conditions are met, *alerts* are created that render *actions* and invoke them. To make action setup and update easier, actions use *connectors* that centralize the information used to connect with {kib} services and third-party integrations. The following example ties these concepts together: | ||
|
||
|
@@ -131,7 +118,6 @@ image::images/rule-concepts-summary.svg[Rules, connectors, alerts and actions wo | |
. {kib} invokes the actions, sending them to a third party *integration* like an email service. | ||
. If the third party integration has connection parameters or credentials, {kib} will fetch these from the *connector* referenced in the action. | ||
|
||
|
||
[float] | ||
[[alerting-concepts-differences]] | ||
== Differences from Watcher | ||
|
@@ -152,63 +138,7 @@ Pre-packaged *rule types* simplify setup and hide the details of complex, domain | |
|
||
[float] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Moved to its own page There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A few comments on Alerting overview page: This paragraph needs some work. The list needs to be written paralle. Can the condition and schedule have different times? For example, when monitoring a set of servers, a rule might check for average CPU usage > 0.9 on each server for the last two minutes (condition), checked every minute (schedule), sending a warning email message via SMTP with subject CPU on {{server}} is high (action). javascript function > Javascript function Items in a bulleted list should start with caps (for example, "The connector you type" Suggest removing the prequisites section at the end of the file. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @gchaps Addressed your comments in this commit: 74c50df I changed the paragraph to be a list...is that clearer? The condition and schedule can have different times. The Alerting prerequisites section is there temporarily for cross doc link compatibility. Once this PR is merged, I can make a PR to update the observability doc that links to the prerequisites section, and then I will do a cleanup PR here to remove it. |
||
[[alerting-setup-prerequisites]] | ||
== Setup and prerequisites | ||
|
||
If you are using an *on-premises* Elastic Stack deployment: | ||
|
||
* In the kibana.yml configuration file, add the <<general-alert-action-settings,`xpack.encryptedSavedObjects.encryptionKey`>> setting. | ||
* For emails to have a footer with a link back to {kib}, set the <<server-publicBaseUrl, `server.publicBaseUrl`>> configuration setting. | ||
|
||
If you are using an *on-premises* Elastic Stack deployment with <<using-kibana-with-security, *security*>>: | ||
|
||
* You must enable Transport Layer Security (TLS) for communication <<configuring-tls-kib-es, between {es} and {kib}>>. {kib} alerting uses <<api-keys, API keys>> to secure background rule checks and actions, and API keys require {ref}/configuring-tls.html#tls-http[TLS on the HTTP interface]. A proxy will not suffice. | ||
|
||
[float] | ||
[[alerting-setup-production]] | ||
== Production considerations and scaling guidance | ||
|
||
When relying on alerting and actions as mission critical services, make sure you follow the <<alerting-production-considerations,Alerting production considerations>>. | ||
|
||
See <<alerting-scaling-guidance>> for more information on the scalability of {kib} alerting. | ||
|
||
[float] | ||
[[alerting-security]] | ||
== Security | ||
== Prerequisites | ||
<<alerting-prerequisites, Alerting prerequisites>> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I had to leave this anchor link in here for now because there are observability docs that link to it. Once this PR is merged, I will create a PR to update the link in the Obs docs, and then create another PR in Kibaba to remove this link. Unfortunately @lcawl I wasn't able to just have an empty anchor link so I left in a header and a link to the new page. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yay! Looks like the docs build was successful:
|
||
|
||
To access alerting in a space, a user must have access to one of the following features: | ||
|
||
* Alerting | ||
* <<xpack-apm,*APM*>> | ||
* <<logs-app,*Logs*>> | ||
* <<xpack-ml,*{ml-cap}*>> | ||
* <<metrics-app,*Metrics*>> | ||
* <<xpack-siem,*Security*>> | ||
* <<uptime-app,*Uptime*>> | ||
|
||
See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to these features. | ||
Also note that a user will need +read+ privileges for the *Actions and Connectors* feature to attach actions to a rule or to edit a rule that has an action attached to it. | ||
|
||
[float] | ||
[[alerting-spaces]] | ||
=== Space isolation | ||
|
||
Rules and connectors are isolated to the {kib} space in which they were created. A rule or connector created in one space will not be visible in another. | ||
|
||
[float] | ||
[[alerting-authorization]] | ||
=== Authorization | ||
|
||
Rules, including all background detection and the actions they generate are authorized using an <<api-keys, API key>> associated with the last user to edit the rule. Upon creating or modifying a rule, an API key is generated for that user, capturing a snapshot of their privileges at that moment in time. The API key is then used to run all background tasks associated with the rule including detection checks and executing actions. | ||
|
||
[IMPORTANT] | ||
============================================== | ||
If a rule requires certain privileges to run, such as index privileges, keep in mind that if a user without those privileges updates the rule, the rule will no longer function. | ||
============================================== | ||
|
||
[float] | ||
[[alerting-restricting-actions]] | ||
=== Restricting actions | ||
|
||
For security reasons you may wish to limit the extent to which {kib} can connect to external services. <<action-settings>> allows you to disable certain <<action-types>> and allowlist the hostnames that {kib} can connect with. | ||
|
||
-- | ||
-- |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
[role="xpack"] | ||
[[alerting-setup]] | ||
== Alerting Setup | ||
++++ | ||
<titleabbrev>Setup</titleabbrev> | ||
++++ | ||
|
||
ymao1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
The Alerting feature is automatically enabled in {kib} but may require some additional configuration. | ||
ymao1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
[float] | ||
[[alerting-prerequisites]] | ||
=== Prerequisites | ||
If you are using an *on-premises* Elastic Stack deployment: | ||
|
||
* In the kibana.yml configuration file, add the <<general-alert-action-settings,`xpack.encryptedSavedObjects.encryptionKey`>> setting. | ||
* For emails to have a footer with a link back to {kib}, set the <<server-publicBaseUrl, `server.publicBaseUrl`>> configuration setting. | ||
|
||
If you are using an *on-premises* Elastic Stack deployment with <<using-kibana-with-security, *security*>>: | ||
|
||
* You must enable Transport Layer Security (TLS) for communication <<configuring-tls-kib-es, between {es} and {kib}>>. {kib} alerting uses <<api-keys, API keys>> to secure background rule checks and actions, and API keys require {ref}/configuring-tls.html#tls-http[TLS on the HTTP interface]. A proxy will not suffice. | ||
|
||
[float] | ||
[[alerting-setup-production]] | ||
=== Production considerations and scaling guidance | ||
|
||
When relying on alerting and actions as mission critical services, make sure you follow the <<alerting-production-considerations,Alerting production considerations>>. | ||
|
||
See <<alerting-scaling-guidance>> for more information on the scalability of {kib} alerting. | ||
|
||
[float] | ||
[[alerting-security]] | ||
=== Security | ||
|
||
To access alerting in a space, a user must have access to one of the following features: | ||
|
||
* Alerting | ||
* <<xpack-apm,*APM*>> | ||
* <<logs-app,*Logs*>> | ||
* <<xpack-ml,*{ml-cap}*>> | ||
* <<metrics-app,*Metrics*>> | ||
* <<xpack-siem,*Security*>> | ||
* <<uptime-app,*Uptime*>> | ||
|
||
See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to these features. | ||
Also note that a user will need +read+ privileges for the *Actions and Connectors* feature to attach actions to a rule or to edit a rule that has an action attached to it. | ||
|
||
[float] | ||
[[alerting-restricting-actions]] | ||
==== Restrict actions | ||
|
||
For security reasons you may wish to limit the extent to which {kib} can connect to external services. <<action-settings>> allows you to disable certain <<action-types>> and allowlist the hostnames that {kib} can connect with. | ||
|
||
[float] | ||
[[alerting-spaces]] | ||
=== Space isolation | ||
|
||
Rules and connectors are isolated to the {kib} space in which they were created. A rule or connector created in one space will not be visible in another. | ||
|
||
[float] | ||
[[alerting-authorization]] | ||
=== Authorization | ||
|
||
Rules, including all background detection and the actions they generate are authorized using an <<api-keys, API key>> associated with the last user to edit the rule. Upon creating or modifying a rule, an API key is generated for that user, capturing a snapshot of their privileges at that moment in time. The API key is then used to run all background tasks associated with the rule including detection checks and executing actions. | ||
|
||
[IMPORTANT] | ||
============================================== | ||
If a rule requires certain privileges to run, such as index privileges, keep in mind that if a user without those privileges updates the rule, the rule will no longer function. | ||
============================================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved to the
Defining rules
page, to be closer to where the setup for this concept is.