-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
Add scope-related fields to Annotation #56417
Conversation
590085f
to
b7c80be
Compare
Pinging @elastic/ml-core (:ml) |
Design comment: Is it possible to be more general with the change? Could we add two fields? |
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.
LGTM
b7c80be
to
ce18a78
Compare
I was thinking about an abstraction like this but then we loose the information which field was
Given that we are already using flat structure in |
This PR implements scoped annotations by adding 7 new fields to
Annotation
type:detector_index
,partition_field_name
,partition_field_value
,over_field_name
,over_field_value
,by_field_name
,by_field_value
.Rationale
Currently the user of Elastic ML has an ability to attach an annotation to a moment in time (or time range) when something interesting happens (e.g.: Black Friday sale causing a sudden bump in request rate). The scope of such an annotation is an ML job. So even if the user configures anomaly detection job with
partition_field_name
,over_field_name
orby_field_name
parameters, the annotation is unaware of them. This may cause usability issues for a number of reasons:Because of these reasons, we should implement scoped (or scope-aware) annotations that carry the relevant context information with them.
Relates #55781