Skip to content

Commit e087b29

Browse files
alaudazzimuthu-mpstheletterf
authored
[Integrations] Alerting Rule Template common page (#4072)
<!-- Thank you for contributing to the Elastic Docs! πŸŽ‰ Use this template to help us efficiently review your contribution. --> ## Summary This PR adds a new Alerting Rule Templates page that should serve as a centralized doc page with an explanation of what the alert rule templates are and how to use them. This page is going to be referenced from the individual integration pages. The current location of the page will be changed and made more visible in a further iteration. Relates to #3678 (comment). ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No Cursor with gpt5 --------- Co-authored-by: muthu-mps <[email protected]> Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
1 parent 6b5e33f commit e087b29

File tree

3 files changed

+71
-9
lines changed

3 files changed

+71
-9
lines changed

β€Žreference/fleet/alert-templates.mdβ€Ž

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ products:
88
navigation_title: Built-in alerts and templates
99
---
1010

11-
# Built-in alerts and templates [built-in-alerts]
11+
# Elastic Agent built-in alerts [built-in-alerts]
1212

1313
## {{agent}} out-of-the-box alert rules [ea-alert-rules]
1414

@@ -39,11 +39,3 @@ You can find these rules in **Stack Management** > **Alerts and Insights** > **R
3939

4040
**Connectors** are not added to rules automatically, but you can attach a connector to route alerts to your Slack, email, or other notification platforms.
4141
In addition, you can add filters for policies, tags, or hostnames to scope alerts to specific sets of agents.
42-
43-
## Alert template assets for integrations [alert-templates]
44-
45-
Some integration packages include alerting rule template assets that provide pre-made definitions of alerting rules. You can use the templates to create your own custom alerting rules that you can enable and fine-tune.
46-
47-
When you click a template, you get a pre-filled rule creation form. You can define and adjust values, set up connectors, and define rule actions to create your custom alerting rule.
48-
49-
You can see available templates in the **integrations/detail/<package>/assets** view.
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
applies_to:
3+
stack: ga 9.2.1
4+
serverless: ga
5+
products:
6+
- id: fleet
7+
- id: elastic-agent
8+
navigation_title: Alerting rule templates
9+
---
10+
11+
# Alerting rule templates [alerting-rule-templates]
12+
13+
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.
14+
15+
Templates help you start monitoring in minutes by providing curated {{esql}} queries and recommended thresholds tailored to each integration.
16+
17+
After the integration is installed, these templates are automatically available in Kibana's alerting interface with a prefilled rule creation form that you can adapt to your needs.
18+
19+
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.
20+
21+
:::{important}
22+
Although the alerts can be used as provided, threshold values should always be evaluated in the context of your specific environment. Depending on how you adjust the thresholds, you may either generate too many alerts or fail to trigger alerts when expected.
23+
:::
24+
25+
## Prerequisites
26+
27+
- Install or upgrade to the latest version of the integration that includes alerting rule templates.
28+
- Ensure the data collection is enabled for the metrics or events that you plan to use.
29+
- {{stack}} 9.2.1 or later.
30+
- Appropriate {{kib}} role privileges to create and manage rules.
31+
32+
## How to use the Alerting rule templates
33+
34+
Alerting rule templates come with recommended, pre-populated values. To use them:
35+
36+
1. In {{kib}}, go to **{{manage-app}}** > **{{integrations}}**.
37+
1. Find and open the integration.
38+
1. On the integration page, open the **Assets** tab and expand **Alerting rule templates** to view all available templates for that integration.
39+
40+
:::{note}
41+
You can find the Alerting rule template option only when the integration adds template support for alerting rules.
42+
:::
43+
44+
1. Select a template to open a prefilled **Create rule** form.
45+
46+
You can use the template to create your own custom alerting rule by adjusting values, setting up connectors, and defining rule actions.
47+
48+
1. Review and (optionally) customize the prefilled settings, then save and enable the rule.
49+
50+
The rule created from the template gets listed in the **Observability** β†’ **Alerts** β†’ **Manage Rules** page.
51+
52+
To update the rule you have created from the template, go to **Observability** β†’ **Alerts** β†’ **Manage Rules**, select the rule and click **Actions**.
53+
54+
The preconfigured defaults include:
55+
56+
- **{{esql}} query**
57+
: A curated, text-based query that evaluates your data and triggers when matches are found during the latest run.
58+
- **Recommended threshold**
59+
: A suggested threshold embedded in the {{esql}} `WHERE` clause. You can tune the threshold to fit your environment.
60+
- **Time window (look-back)**
61+
: The length of time the rule analyzes for data (for example, the last 5 minutes).
62+
- **Rule schedule**
63+
: How frequently the rule checks alert conditions (for example, every minute).
64+
- **Alert delay (alert suppression)**
65+
: The number of consecutive runs for which conditions must be met before an alert is created.
66+
67+
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).
68+
69+

β€Žreference/fleet/toc.ymlβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ toc:
150150
- file: data-streams-pipeline-tutorial.md
151151
- file: data-streams-advanced-features.md
152152
- file: alert-templates.md
153+
- file: alerting-rule-templates.md
153154
- file: agent-command-reference.md
154155
- file: providers.md
155156
children:

0 commit comments

Comments
Β (0)