RFC: Add design for blueprint and phase progress calculation #1461
Conversation
|
Thanks for submitting this pull request 🎉. The team will review it soon and get back to you. If you haven't already, please take a moment to review our project contributing guideline and Code of Conduct document. |
ihcsim
force-pushed
the
design-progress
branch
2 times, most recently
from
a27cc0a
to
b1d710f
Compare
design/progress-tracking.md
Outdated
| completed phases against the total number of phases: | ||
|
|
||
| ``` | ||
| blueprint_progress_percent = num_completed_phases / total_num_phases * 100 |
There was a problem hiding this comment.
should this be action_progress_percent?
There was a problem hiding this comment.
Check with Yevgeny, he has a weighting system for phases.
There was a problem hiding this comment.
@viveksinghggits yes, good catch! To get the blueprint overall progress, we should be assessing the completed actions, not phases.
| Here's a sample log output of the Kopia create snapshot function: | ||
|
|
||
| ```sh | ||
| $ kopia snapshot create kanister |
There was a problem hiding this comment.
In both the examples (kopia and restic) we are just considering the utilities that are going to upload the data to object store but in some cases there are chances that there are some other commands that are taking some time.
- One example is the utility that we are using to take backup for example
mysqldump,esdumpetc. Should we consider these as well or just measuring upload time would be sufficient.
There was a problem hiding this comment.
Definitely if we can get progress from the tools we should expose that.
There was a problem hiding this comment.
@viveksinghggits Yes, the goal is that downstream users can add more custom progress trackers (at the code level) per their requirements, if the built-in ones don't work. We can consider adding a built-in generic tracker to output the 25%, 50%, 75% and 100% markers based on certain events in the logs.
design/progress-tracking.md
Outdated
| completed phases against the total number of phases: | ||
|
|
||
| ``` | ||
| blueprint_progress_percent = num_completed_phases / total_num_phases * 100 |
There was a problem hiding this comment.
Check with Yevgeny, he has a weighting system for phases.
| Here's a sample log output of the Kopia create snapshot function: | ||
|
|
||
| ```sh | ||
| $ kopia snapshot create kanister |
There was a problem hiding this comment.
Definitely if we can get progress from the tools we should expose that.
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Change Overview
This PR adds the design proposal for the blueprint and phase progress calculation. Welcome all comments and feedback.
Pull request type
Please check the type of change your PR introduces:
Issues