[RAM] refactors RulesClient.update, by using new Task Manager API bulkUpdateSchedules #134027
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
…liidm/kibana into task-manager-bulk-schedules
…-ref HEAD~1..HEAD --fix'
1 task
vitaliidm
added a commit
that referenced
this pull request
Jun 13, 2022
Addresses: #124850 ## Summary - Adds new method Task Manager API `bulkUpdateSchedules` - Adds calling `taskManager.bulkUpdateSchedules` in rulesClient.bulkEdit to update tasks if updated rules have `scheduleTaskId` property - Enables the rest of operations for rulesClient.bulkEdit (set schedule, notifyWhen, throttle) - #### bulkUpdateSchedules Using `bulkUpdatesSchedules` you can instruct TaskManager to update interval of tasks that are in `idle` status. When interval updated, new `runAt` will be computed and task will be updated with that value ```js export class Plugin { constructor() { } public setup(core: CoreSetup, plugins: { taskManager }) { } public start(core: CoreStart, plugins: { taskManager }) { try { const bulkUpdateResults = await taskManager.bulkUpdateSchedule( ['97c2c4e7-d850-11ec-bf95-895ffd19f959', 'a5ee24d1-dce2-11ec-ab8d-cf74da82133d'], { interval: '10m' }, ); // If no error is thrown, the bulkUpdateSchedule has completed successfully. // But some updates of some tasks can be failed, due to OCC 409 conflict for example } catch(err: Error) { // if error is caught, means the whole method requested has failed and tasks weren't updated } } } ``` ### in follow-up PRs - use `taskManager.bulkUpdateSchedules` in rulesClient.update (#134027) - functional test for bulkEdit (#133635) ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### Release note Adds new method to Task Manager - bulkUpdatesSchedules, that allow bulk updates of scheduled tasks. Adds 3 new operations to rulesClient.bulkUpdate: update of schedule, notifyWhen, throttle.
…w-taks-manager-api
vitaliidm
changed the title
vitaliidm
commented
Jun 13, 2022
| }); | ||
|
|
||
| test('updating the alert should not wait for the rerun the task to complete', async () => { |
There was a problem hiding this comment.
I believe we don't need this test anymore: we not running task anymore right after rule's SO updated, only doing REST API calls.
So, once user updates rule's schedule, there will be no time expensive run of rule, only underlying task update.
In that case, we can wait to this update finished and we won't need to leave unfinished HTTP requests once return response of RulesClient.update
vitaliidm
added
technical debt
|
Pinging @elastic/response-ops (Team:ResponseOps) |
vitaliidm
changed the title
ymao1
approved these changes
Jun 14, 2022
| ); | ||
|
|
||
| this.logger.debug( | ||
| `Alert update has rescheduled the underlying task: ${updateResult.scheduledTaskId}` |
There was a problem hiding this comment.
Can we include the new runAt in the log message?
There was a problem hiding this comment.
Included, thanks for the suggestion
…w-taks-manager-api
Co-authored-by: Ying Mao <ying.mao@elastic.co>
Co-authored-by: Ying Mao <ying.mao@elastic.co>
…w-taks-manager-api
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: cc @vitaliidm |
vitaliidm
deleted the
repsponse-ops/rules-client-update-move-to-new-taks-manager-api
branch
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.
Summary
RulesClient.updatemethod TaskManager APIrunNowtobulkUpdateSchedulesWhen using runNow in scale, there can be situations, when TaskManager capacity is full, thus leading failure of
runNow.Instead, new API
bulkUpdateScheduleswill be used, which in case if rule schedule is getting updated: will update underlying task schedule and will calculate newrunAttime.More details on new TaskManager API: #132637, #124850
Checklist