diff options
| author | Tristan Cacqueray <tdecacqu@redhat.com> | 2022-07-20 18:57:12 +0000 |
|---|---|---|
| committer | Tristan Cacqueray <tdecacqu@redhat.com> | 2022-08-02 14:50:59 +0000 |
| commit | c7bac0dc1ec98244b720bcb044135c55f4b358f8 (patch) | |
| tree | 9fd5e12ce8557f34d40d0710770e1c8ce5cf5a6e | |
| parent | de1e2a325e76b573544f5c1f4bf92e73c675e645 (diff) | |
| download | zuul-c7bac0dc1ec98244b720bcb044135c55f4b358f8.tar.gz | |
doc: fix liveness probes path rendering
This change removes the extra '/' from the documentation page.
Change-Id: I94eda49da7f88d339b645751d6f3d2973812af55
| -rw-r--r-- | doc/source/monitoring.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/monitoring.rst b/doc/source/monitoring.rst index 1cb61ee01..d15fae913 100644 --- a/doc/source/monitoring.rst +++ b/doc/source/monitoring.rst @@ -819,18 +819,18 @@ Liveness Probes The Prometheus server also supports liveness and ready probes at the following URIS: -.. path:: /health/live +.. path:: health/live Returns 200 as long as the process is running. -.. path:: /health/ready +.. path:: health/ready Returns 200 if the process is in `RUNNING` or `PAUSED` states. Otherwise, returns 503. Note that 503 is returned for `INITIALIZED`, so this may be used to determine when a component has completely finished loading configuration. -.. path:: /health/status +.. path:: health/status This always returns 200, but includes the component status as the text body of the response. |