-
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?
Conversation
Vale Linting ResultsSummary: 3 suggestions found 💡 Suggestions (3)
|
Co-authored-by: muthu-mps <[email protected]>
Co-authored-by: muthu-mps <[email protected]>
🔍 Preview links for changed docs |
…ontent into alerting-rule-templates
Remove optional step about connectors,
daniela-elastic
left a comment
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.
Made minor comments and also question on the correct stack version. Approving in principal but please review the comments.
tommyers-elastic
left a comment
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.
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. |
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.
- 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'.
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.
I defer to @muthu-mps here.
|
@tommyers-elastic @daniela-elastic |
|
@tommyers-elastic I added the following note as you suggested:
|
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
Cursor with gpt5