Adds note on anomaly detection alert behaviour #126102
Merged
Conversation
This file contains hidden or 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
kosabogi
added
>docs
|
Documentation preview: |
|
Pinging @elastic/es-docs (Team:Docs) |
darnautov
reviewed
Apr 3, 2025
| alert status changes, or at a custom action interval). For {anomaly-detect} | ||
| alert status changes, or at a custom action interval). | ||
|
|
||
| When you use an email action with an {anomaly-detect} rule, the alert includes only the top three anomalous records or influencers detected during the check interval. This behavior ensures that the alert remains concise by highlighting the most significant anomalies based on their scores. |
There was a problem hiding this comment.
It is not specifically about email actions but rather about the overall alert context sent to any connector, as well as the document stored in the alert-as-data index.
I believe we should simply mention that topRecords and topInfluencers are limited to 3 documents.
szabosteve
approved these changes
Apr 7, 2025
This was referenced Apr 8, 2025
kosabogi
added a commit
to kosabogi/elasticsearch
that referenced
this pull request
Apr 8, 2025
* Adds note on anomaly detection alert behaviour * Fixes attribute * Relocating the addition * Fixes based on feedback
kosabogi
added a commit
to kosabogi/elasticsearch
that referenced
this pull request
Apr 8, 2025
* Adds note on anomaly detection alert behaviour * Fixes attribute * Relocating the addition * Fixes based on feedback
kosabogi
added a commit
to kosabogi/elasticsearch
that referenced
this pull request
Apr 8, 2025
* Adds note on anomaly detection alert behaviour * Fixes attribute * Relocating the addition * Fixes based on feedback
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 8, 2025
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 8, 2025
elasticsearchmachine
pushed a commit
that referenced
this pull request
Apr 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR updates the anomaly detection alerting documentation to clarify that email alerts include only the top three anomalous records or influencers.
Related issue: https://github.com/elastic/search-docs-team/issues/277