[ML] Create the ML annotations index #36731
Conversation
The ML UI now provides the ability for users to annotate time periods with arbitrary text to add insight to what happened. This change makes the backend create the index for these annotations, together with read and write aliases to make future upgrades possible without adding complexity to the UI. It also adds read and write permission to the index for all ML users (not just admins). The spec for the index is in https://github.com/elastic/kibana/pull/26034/files#diff-c5c6ac3dbb0e7c91b6d127aa06121b2cR7 Relates elastic#33376 Relates elastic/kibana#26034
|
Pinging @elastic/ml-core |
|
run gradle build tests 1 |
| public static final ParseField ANNOTATION = new ParseField("annotation"); | ||
| public static final ParseField CREATE_TIME = new ParseField("create_time"); | ||
| public static final ParseField CREATE_USERNAME = new ParseField("create_username"); | ||
| public static final ParseField TIMESTAMP = new ParseField("timestamp"); |
There was a problem hiding this comment.
is timestamp the partner of end_timestamp? Should it be start_timestamp
There was a problem hiding this comment.
The reason timestamp was chosen is that originally we'd intended annotations to be stored in the results index. Then we decided to switch to a separate index, but didn't change the field names.
I think it's too late to change now as it's feature freeze day and
https://github.com/elastic/kibana/pull/26034/files#diff-c5c6ac3dbb0e7c91b6d127aa06121b2cR7 is already merged.
But one thing I just noticed is that end_timestamp is optional in the UI code, so actually that makes timestamp seem not as bad, as it could either be the start or the sole time. But I need to update this PR to account for end_timestamp being optional.
| new Date(randomNonNegativeLong()), | ||
| new Date(randomNonNegativeLong()), | ||
| randomBoolean() ? randomAlphaOfLengthBetween(10, 30) : null, | ||
| new Date(randomNonNegativeLong()), |
There was a problem hiding this comment.
This field and the next one can be null perhaps use randomBoolean() ? as above
| } | ||
|
|
||
| @Before | ||
| public void waitForMlTemplates() throws Exception { |
There was a problem hiding this comment.
This method is defined in MlSingleNodeTestCase
There was a problem hiding this comment.
Only on the jindex branches. I'll add a TODO to tidy up when both are merged.
The ML UI now provides the ability for users to annotate time periods with arbitrary text to add insight to what happened. This change makes the backend create the index for these annotations, together with read and write aliases to make future upgrades possible without adding complexity to the UI. It also adds read and write permission to the index for all ML users (not just admins). The spec for the index is in https://github.com/elastic/kibana/pull/26034/files#diff-c5c6ac3dbb0e7c91b6d127aa06121b2cR7 Relates #33376 Relates elastic/kibana#26034
| client.admin().indices()::aliases); | ||
| }, finalListener::onFailure); | ||
|
|
||
| // Only create the index or aliases if some other ML index exists - saves clutter if ML is never used. |
There was a problem hiding this comment.
nit: the method is called createAnnotationsIndex, it would be nice to reflect this, e.g. maybeCreate... or move the "maybe"-part out of createAnnotationsIndex
There was a problem hiding this comment.
This PR is already merged, but I'll add maybe if there's a followup PR for any reason
Fixes two minor problems reported after merge of elastic#36731: 1. Name the creation method to make clear it only creates if necessary 2. Avoid multiple simultaneous in-flight creation requests
Fixes two minor problems reported after merge of #36731: 1. Name the creation method to make clear it only creates if necessary 2. Avoid multiple simultaneous in-flight creation requests
Fixes two minor problems reported after merge of #36731: 1. Name the creation method to make clear it only creates if necessary 2. Avoid multiple simultaneous in-flight creation requests
Fixes two minor problems reported after merge of #36731: 1. Name the creation method to make clear it only creates if necessary 2. Avoid multiple simultaneous in-flight creation requests
The ML UI now provides the ability for users to annotate
time periods with arbitrary text to add insight to what
happened.
This change makes the backend create the index for these
annotations, together with read and write aliases to
make future upgrades possible without adding complexity
to the UI.
It also adds read and write permission to the index for
all ML users (not just admins).
The spec for the index is in
https://github.com/elastic/kibana/pull/26034/files#diff-c5c6ac3dbb0e7c91b6d127aa06121b2cR7
Relates #33376
Relates elastic/kibana#26034