-
Notifications
You must be signed in to change notification settings - Fork 181
[Integrations] Draft Alerting Rule Template common page #4072
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
base: main
Are you sure you want to change the base?
Changes from all commits
ede1a45
aa3713b
a3be59b
7d70156
b9ca1a4
7d05cd0
d36a84c
a31c4f7
39cafa3
71ff713
bf9447c
e3c54d2
21cd69f
15cb57e
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 |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| applies_to: | ||
| stack: ga 9.2.1 | ||
| serverless: ga | ||
| products: | ||
| - id: fleet | ||
| - id: elastic-agent | ||
| navigation_title: Alerting rule templates | ||
| --- | ||
|
|
||
| # Alerting rule templates [alerting-rule-templates] | ||
|
|
||
| Alerting rule templates are out-of-the-box alert definitions that come bundled with [Elastic integrations](integration-docs://reference/index.md)), enabling users to quickly set up monitoring without writing queries from scratch. | ||
|
|
||
| Templates help you start monitoring in minutes by providing curated {{esql}} queries and recommended thresholds tailored to each integration. | ||
|
|
||
| Once the integration is installed, these templates are automatically available in Kibana's alerting interface with a prefilled rule creation form that you can tailor to your needs. | ||
|
|
||
| Although these templates are managed by Elastic, any alert created from them is owned by the customer and will not be modified by Elastic, even if the templates change. | ||
|
|
||
| :::{important} | ||
| Although the alerts can be used as provided, threshold values should always be evaluated in the context of your specific environment. Applying the predefined thresholds without adjustment may result in an excessive number of alerts. | ||
|
Check notice on line 22 in reference/fleet/alerting-rule-templates.md
|
||
|
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. Depending on how you adjust the thresholds, you may have too many alerts or your alerts may not trigger when you would expect them to trigger |
||
| ::: | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Install or upgrade to the latest version of the integration that includes alerting rule templates. | ||
| - Ensure the relevant data stream is enabled and ingesting data for the template you plan to use. | ||
|
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 think our naming conventions for the template names makes it fairly clear which data the rule is targeting, but there's no well defined way to find the 'relevant data stream'.
Contributor
Author
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 defer to @muthu-mps here. 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. Instead of using the data stream mention, we could modify this to.
|
||
| - {{stack}} 9.2.1 or later. | ||
| - Appropriate {{kib}} role privileges to create and manage rules. | ||
|
|
||
| ## How to use the Alerting rule templates | ||
|
|
||
| Alerting rule templates come with recommended, pre-populated values. To use them: | ||
alaudazzi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 1. In {{kib}}, go to **{{manage-app}}** > **{{integrations}}**. | ||
| 1. Find and open the integration. | ||
| 1. On the integration page, open the **Assets** tab and expand **Alerting rule templates** to view all available templates for that integration. | ||
|
|
||
| :::{note} | ||
| You can find the Alerting rule template option only when the integration adds template support for alerting rules. | ||
| ::: | ||
|
|
||
| 1. Select a template to open a prefilled **Create rule** form. | ||
|
|
||
| You can use the template to create your own custom alerting rule by adjusting values, setting up connectors, and defining rule actions. | ||
|
|
||
| 1. Review and (optionally) customize the prefilled settings, then save and enable the rule. | ||
|
|
||
| The rule created from the template gets listed in the **Observability** → **Alerts** → **Manage Rules** page. | ||
|
|
||
| To update the rule you have created from the template, go to **Observability** → **Alerts** → **Manage Rules**, select the rule and click **Actions**. | ||
|
|
||
| The preconfigured defaults include: | ||
|
|
||
| - **{{esql}} query** | ||
| : A curated, text-based query that evaluates your data and triggers when matches are found during the latest run. | ||
| - **Recommended threshold** | ||
| : A suggested threshold embedded in the {{esql}} `WHERE` clause. You can tune the threshold to fit your environment. | ||
| - **Time window (look-back)** | ||
| : The length of time the rule analyzes for data (for example, the last 5 minutes). | ||
| - **Rule schedule** | ||
| : How frequently the rule checks alert conditions (for example, every minute). | ||
| - **Alert delay (alert suppression)** | ||
| : The number of consecutive runs for which conditions must be met before an alert is created. | ||
|
|
||
| For details about fields in the Create rule form and how the rule evaluates data, refer to the [{{es}} query rule type](/explore-analyze/alerts-cases/alerts/rule-type-es-query.md). | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.