[ML] Add new custom rule action to force time shift #188710
Merged
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
|
@elastic/ml-ui This works as far as validation in the Advanced Wizard goes, but I noticed that custom rule actions are wired in a few more places (Customer rule editor UI among other things). Could someone please pick this PR up and extend the missing places? |
|
@elasticmachine merge upstream |
|
@elastic/ml-ui Can someone please review my PR? |
valeriy42
added a commit
to elastic/elasticsearch
that referenced
this pull request
Jul 25, 2024
This PR extends the schema of the detection rule API by adding a new parametrizable action `force_time_shift` and a new property `params` to hold the parameter `total_shift_amount` as signed long in seconds to control the behavior of the time shift.
A valid schema looks like this:
```http
POST _ml/anomaly_detectors/my_job/_update
{
"detectors": {
"detector_index": 0,
"custom_rules": [
// update the detector with a custom rule that forces a time shift of 1 hour back starting now
{
"actions": [
"force_time_shift"
],
"params": {
"force_time_shift": {
"time_shift_amount": 3600}
}
},
"conditions": [{
"applies_to": "time",
"operator": "gt",
"value": "now"
},
{
"applies_to": "time",
"operator": "lt",
"value": "now+bucket_span"
},
]
},
...
```
Execution of the detection rule action `force_time_shift` will shift the time inside the anomaly detector by a specified amount. This is useful, e.g. to quickly adapt to the daylight saving time events that are known beforehand.
This PR is accompanied by changes in Kibana elastic/kibana#188710 and the native ml-cpp code elastic/ml-cpp#2690.
The integration tests between Java and C++ parts of the force-time shift action will be implemented in a separate PR.
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]Async chunks
History
To update your PR or re-run it, just comment with: cc @valeriy42 |
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.
This PR follows up elastic/elasticsearch#110974 and extends the schema for custom rules.
A valid schema looks like this: