Skip to content

add example diagrams #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
remylouisew wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add example diagrams #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ba203e
add example diagrams
Nov 13, 2024
ec76244
changes to diagram tables
Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,37 @@ MegaMon provides granular merics about when a JobSet is Down. This allows for ca

![Downness Metrics](./diagrams/downness-metrics.excalidraw.png)

![Example 1 - Job completes](./diagrams/jobcomplete.excalidraw.png)

| Metric | Megamon Name | Calculation |
|-----------------------------------|-------------------------------------------------------------------------------|------------------|
| Jobset Up time | jobset_up_time_seconds_total | u0 + u1 + u2 |
| Jobset Interruption time | jobset_down_time_between_recovery_seconds | d1 + d2 |
| Down time | jobset_down_time_seconds | d0 + d1 + d2 |
| Time between/around interruptions | Jobset_up_time_between_interruption_seconds | u0 + u1 |
| Interruption count | jobset_interruption_count_total | count(d1,d2) = 2 |
| Provisioning time | jobset_down_time_intital_seconds | d0 |
| Recovery time | jobset_recovery_time_seconds | d1 + d2 |
| Recovery count | jobset_recovery_count_total | count(u1,u2) = 2 |
| Jobset MTTR | jobset_down_time_between_recovery_seconds / jobset_recovery_count_total | (d1 + d2) / 2 |
| Jobset MTBI | Jobset_up_time_between_interruption_seconds / jobset_interruption_count_total | (u0 + u1) / 2 |


![Example 2 - Job completes](./diagrams/job_incomplete.excalidraw.png)

| Metric | Megamon Name | Calculation |
|-----------------------------------|-------------------------------------------------------------------------------|---------------|
| Jobset Up time | jobset_up_time_seconds_total | u0 + u1 |
| Jobset Interruption time | jobset_down_time_between_recovery_seconds | d1 + d2 |
| Down time | jobset_down_time_seconds | d0 + d1 + d2 |
| Time between/around interruptions | Jobset_up_time_between_interruption_seconds | u0 + u1 |
| Interruption count | jobset_interruption_count_total | count(d1) = 1 |
| Provisioning time | jobset_down_time_intital_seconds | d0 |
| Recovery time | jobset_recovery_time_seconds | d1 |
| Recovery count | jobset_recovery_count_total | count(u1) = 2 |
| Jobset MTTR | jobset_down_time_between_recovery_seconds / jobset_recovery_count_total | d1 / 1 |
| Jobset MTBI | Jobset_up_time_between_interruption_seconds / jobset_interruption_count_total | (u0 + u1) / 2 |

## TODO

* Make sure to always emit the final summaries for a completed/failed jobset.
Expand Down
Binary file added docs/diagrams/job_incomplete.excalidraw.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/diagrams/jobcomplete.excalidraw copy.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/diagrams/jobcomplete.excalidraw.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.