Onboard dashboard_telemetry task type to use stateSchemaByVersion for task state validation #161855
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
mikecote
added
release_note:skip
mikecote
added
the
Team:Presentation
|
Pinging @elastic/kibana-presentation (Team:Presentation) |
ThomThomson
approved these changes
Jul 18, 2023
| import { TASK_ID } from './dashboard_telemetry_collection_task'; | ||
| import { emptyState, type LatestTaskStateSchema } from './task_state'; | ||
|
|
||
| // TODO: Merge with LatestTaskStateSchema. Requires a refactor of collectPanelsByType() because |
There was a problem hiding this comment.
Is this TODO something that we should tackle on the Presentation team side? What is the priority?
There was a problem hiding this comment.
Correct, I don't foresee urgency on having this fixed, it's mainly if the presentation team would like to have a single source of type definitions after this PR merges. It can be considered technical debt, otherwise the engineer will have to add their new telemetry field in two places.
|
@elasticmachine merge upstream |
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: cc @mikecote |
dgieselaar
pushed a commit
to dgieselaar/kibana
that referenced
this pull request
Jul 23, 2023
… task state validation (elastic#161855) Part of elastic#159342. In this PR, I'm preparing the `dashboard_telemetry` for serverless by defining an explicit task state schema. This schema is used to validate the task's state before saving the task but also when reading the task. In the scenario an older Kibana node runs a task after a newer Kibana node has stored additional task state, the unknown state properties will be dropped. Additionally, this will prompt developers to be aware that adding required fields to the task state is a breaking change that must be handled with care. (see elastic#155764). For more information on how to use `stateSchemaByVersion`, see elastic#159048 and https://github.com/elastic/kibana/blob/main/x-pack/plugins/task_manager/README.md. --------- Co-authored-by: Kibana Machine <[email protected]>
ThomThomson
pushed a commit
to ThomThomson/kibana
that referenced
this pull request
Aug 1, 2023
… task state validation (elastic#161855) Part of elastic#159342. In this PR, I'm preparing the `dashboard_telemetry` for serverless by defining an explicit task state schema. This schema is used to validate the task's state before saving the task but also when reading the task. In the scenario an older Kibana node runs a task after a newer Kibana node has stored additional task state, the unknown state properties will be dropped. Additionally, this will prompt developers to be aware that adding required fields to the task state is a breaking change that must be handled with care. (see elastic#155764). For more information on how to use `stateSchemaByVersion`, see elastic#159048 and https://github.com/elastic/kibana/blob/main/x-pack/plugins/task_manager/README.md. --------- Co-authored-by: Kibana Machine <[email protected]>
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.
Part of #159342.
In this PR, I'm preparing the
dashboard_telemetryfor serverless by defining an explicit task state schema. This schema is used to validate the task's state before saving the task but also when reading the task. In the scenario an older Kibana node runs a task after a newer Kibana node has stored additional task state, the unknown state properties will be dropped. Additionally, this will prompt developers to be aware that adding required fields to the task state is a breaking change that must be handled with care. (see #155764).For more information on how to use
stateSchemaByVersion, see #159048 and https://github.com/elastic/kibana/blob/main/x-pack/plugins/task_manager/README.md.