Improve Description of unwind_ratio #628

Ericsson · Dec 20, 2023 · af9a265 · af9a265
1 parent 287f3c1
commit af9a265
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -3,6 +3,7 @@
 ## Version 5.0.1 (Not yet released)
 
 * Improve hang preventing task - Issue #544
+* Improve Description of unwind_ratio - Issue #628  
 
 ## Version 5.0.0 (Not yet released)
 

diff --git a/application/src/main/resources/ecc.yml b/application/src/main/resources/ecc.yml
@@ -138,6 +138,23 @@ repair:
   ## This value is a ratio between 0 -> 100% of the execution time of a repair session.
   ##
   ## 100% means that the executor will wait to run the next session for as long time as the previous session took.
+  ## The 'unwind_ratio' setting configures the wait time between repair tasks as a proportion of the previous task's execution time.
+  ##
+  ## Examples:
+  ## - unwind_ratio: 0
+  ##   Explanation: No wait time between tasks. The next task starts immediately after the previous one finishes.
+  ##   Total Repair Time: T1 (10s) + T2 (20s) = 30 seconds.
+  ##
+  ## - unwind_ratio: 1.0 (100%)
+  ##   Explanation: The wait time after each task equals its duration.
+  ##   Total Repair Time: T1 (10s + 10s wait) + T2 (20s + 20s wait) = 60 seconds.
+  ##
+  ## - unwind_ratio: 0.5 (50%)
+  ##   Explanation: The wait time is half of the task's duration.
+  ##   Total Repair Time: T1 (10s + 5s wait) + T2 (20s + 10s wait) = 45 seconds.
+  ##
+  ##  A higher 'unwind_ratio' reduces system load by adding longer waits, but increases total repair time.
+  ##  A lower 'unwind_ratio' speeds up repairs but may increase system load.
   ##
   unwind_ratio: 0.0
   ##