Updating IRIS Alerter to use ElastAlert Alerter defaults #1532
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hey @malinkinsa - I'm just pinging you to see if you have any feedback for the reasoning behind statically setting the Alert Description and Alert Title. This PR aims to standardize the title and description using the built in functions from ElastAlert, but I think it might be a possible breaking change within the IRIS alert functionality? |
bvirgilioamnh
changed the title
|
Hello, @bvirgilioamnh I have no objections whatsoever. |
|
Will you please move the changelog entry up to the Breaking changes section? The PR shouldn't "break" most users, but it's possible someone could have some script programmatically checking an alert email or message for a specific string, and this change could impact that. So better to be cautious. |
Moving change log entry to breaking changes
jertel
approved these changes
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently the IRIS alert uses rule supplied values for the description and simply uses the rule title for the alert title. This significantly reduces the ability to dynamically create/repurpose alerts as the rule creator must tailor each individual alert with a custom description. Additionally this description field as it stands does not resolve any variable or template fields resulting in a static description for all alerts.
This PR aims to resolve this by using the built in create_alert_body() and create_title() functions within the Alerter class.
As this is possibly a breaking change I'm opening this PR as a draft for discussion.
Checklist
make test-dockerwith my changes.Questions or Comments
Do not merge this PR until discussed! :)I think this should be complete now. The defaults should be close enough to the current functionality and is more in line with expectations with the ElastAlert ecosystem.