chore: refactor according to review

canonical · Jan 24, 2025 · 52480d0 · 52480d0
1 parent 72aa931
commit 52480d0
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/how-to/run-services-reliably.md b/docs/how-to/run-services-reliably.md
@@ -23,6 +23,12 @@ checks:
       url: http://127.0.0.1:5000/health
 ```
 
+The configuration above contains three key options that we can tweak for each health check:
+
+- `period`: How often to run the check.
+- `timeout`: If the check hasn't responded before the timeout, consider the check an error.
+- `threshold`: After this many consecutive errors the check considered "down".
+
 If we're happy with the default values, a minimum check looks like the following:
 
 ```yaml