Skip to content

Conversation

@alaudazzi
Copy link
Contributor

@alaudazzi alaudazzi commented Nov 25, 2025

Summary

This PR proposes an initial draft of the 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 should be changed to make it more visible.

Relates to #3678 (comment).

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No

Cursor with gpt5

@alaudazzi alaudazzi requested a review from muthu-mps November 25, 2025 10:12
@alaudazzi alaudazzi self-assigned this Nov 25, 2025
@alaudazzi alaudazzi added the documentation Improvements or additions to documentation label Nov 25, 2025
@alaudazzi alaudazzi changed the title Draft alerting rule template common page Draft Alerting Rule Template common page Nov 25, 2025
@alaudazzi alaudazzi changed the title Draft Alerting Rule Template common page [Integrations] Draft Alerting Rule Template common page Nov 25, 2025
@github-actions
Copy link

github-actions bot commented Nov 25, 2025

Vale Linting Results

Summary: 3 suggestions found

💡 Suggestions (3)
File Line Rule Message
reference/fleet/alerting-rule-templates.md 11 Elastic.Capitalization 'Alerting Rule Templates [alerting-rule-templates]' should use sentence-style capitalization.
reference/fleet/alerting-rule-templates.md 20 Elastic.WordChoice Consider using 'can, might' instead of 'may', unless the term is in the UI.
reference/fleet/alerting-rule-templates.md 20 Elastic.Wordiness Consider using 'too many' instead of 'excessive number'.

@github-actions
Copy link

github-actions bot commented Nov 25, 2025

🔍 Preview links for changed docs

Remove optional step about connectors,
Copy link

@daniela-elastic daniela-elastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made minor comments and also question on the correct stack version. Approving in principal but please review the comments.

Copy link

@tommyers-elastic tommyers-elastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this is a good start, but i think it could be a little better organised.

currently there's information about what the templates are and how to use them kinda sprinkled throughout. e.g. "open a prefilled rule creation form you can adjust and enable", and later, "When you click a template, you get a prefilled ..." etc.

i think it could be useful to split the information into sections targeted to specific things users might want to know/do

e.g. "what is an alert rule template?", "where do i find the templates"?, "how do i use the templates?", "how do i know when a rule was created from a template?", "how do i update a rule created from a template?" etc etc

i think we should also make it really clear that the whilst the alerts can be used without modification, thresholds should always be considered in the context of your own environment. the consquence of blindly installing alerts with the predefined thresholds could be many many alerts firing at ocne which would consitute a bad UX.

## 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Ensure the relevant data stream is enabled and ingesting data for the template you plan to use.

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'.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I defer to @muthu-mps here.

@alaudazzi
Copy link
Contributor Author

@tommyers-elastic @daniela-elastic
Your comments have been addressed. Please have a final review before I can merge.

@alaudazzi
Copy link
Contributor Author

@tommyers-elastic I added the following note as you suggested:

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants