litmuschaos
/
litmus-docs
mirror of https://github.com/litmuschaos/litmus-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

type(docs): Adding Documentation for Resilience Score Calculation (#42) 

* Adding Documentation for Resilience Score Calculation

Signed-off-by: Sayan Mondal <sayan@chaosnative.com>
This commit is contained in:
Sayan Mondal 2021-06-21 17:32:14 +05:30 committed by GitHub
parent a6cbe1166f
commit 2fea2dbbc7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
website/docs/d0-observe.md
View File

@ -45,3 +45,44 @@ On hovering over the bar, the user can view the following information related to
- Failed Tests
On clicking the bar, a table is shown below the graph which displays all the experiments present in the workflow run and their individual result points. These result points are then used to calculate the **Resilience Score** of the workflow which is displayed at the end of the table.
### 2. Resilience Score Calculation
A Resilience Score is the measure of how resilient your workflow is considering all the chaos experiments and their individual result points. This calculation takes into account the individual experiment weights (from a range of 1-10) which are relative to each other.
#### **The Importance of Weights in experiments**
Giving a weightage to your experiment is a way of signifying/attaching the importance/priority of that experiment in your workflow. The higher the weight, the more importance it holds.
The weight priority is generally divided into three sections:
* **0-3:** Low Priority
* **4-6:** Medium Priority
* **7-10:** High Priority
#### **The Calculation**
Once a weight has been assigned to the experiment, we look for the [Probe Success Percentage](https://docs.litmuschaos.io/docs/litmus-probe/) for that experiment itself (Post Chaos) and calculate the total resilience result for that experiment as a multiplication of the weight given and the probe success percentage returned after the Chaos Run.
```doc
Total Resilience for one single experiment = (Weight Given to that experiment * Probe Success Percentage)
```
> If an experiment doesn't have a probe in it, the probe success percentage returned can either be 0 or 100 based on the experiment verdict. If the experiment passed then it returns 100 else 0.
The Final Resilience Score is calculated by dividing the total test result by the sum of all the weights of all the experiments combined in a single workflow.
For example, if we consider two experiments in a workflow, here is what the calculation would look like.
> Considering Probe Success Percentage is 100
| Experiment | Weight | Probe Success Percentage | Total Test Result |
| :------------- | :----------: | -----------: | -----------: |
| exp1 | 3 | 100 | (3 * 100) = 300 |
| exp2 | 9 | 100 | (9 * 100) = 900 |
| | Weight Sum = 3 + 9 = 12 | | Total Test Result = 300 + 900 = 1200 |
```
Resilience Score = Total Test Result / Weight Sum
= 1200 / 12
= 100%
```
<iframe width="560" height="315" src="https://www.youtube.com/embed/OuB3dS05DHU" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>