dprevot/check-patroni
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Fix doc layout and threshold doc

Browse source
This commit is contained in:
benoit 2021-12-31 11:30:17 +01:00
parent 86f8bdb395
commit 561c3ed9da
3 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -81,11 +81,11 @@ A match is found when : start <= VALUE <= end
For example, the followinf command will raise : For example, the followinf command will raise :
* a warning if there is less than 1 nodes * a warning if there is less than 1 nodes, wich can be translated to outside of range [2;+INF[
* a critical if there are no nodes * a critical if there are no nodes, wich can be translated to outside of range [1;+INF[
``` ```
check_patroni -e https://10.20.199.3:8008 cluster_has_replica --warning @1 --critical @0 check_patroni -e https://10.20.199.3:8008 cluster_has_replica --warning 2: --critical 1:
``` ```
## cluster services ## cluster services
@ -136,8 +136,10 @@ Usage: check_patroni cluster_has_replica [OPTIONS]
Check if the cluster has healthy replicates. Check if the cluster has healthy replicates.
A healthy replicate : * is in running state * has a replica role * has a lag A healthy replicate :
lower or equal to max_lag * is in running state
* has a replica role
* has a lag lower or equal to max_lag
Check: Check:
* `OK`: if the healthy_replica count and their lag are compatible with the replica count threshold. * `OK`: if the healthy_replica count and their lag are compatible with the replica count threshold.

1
check_patroni/cli.py
View file

@ -265,6 +265,7 @@ def cluster_has_replica(
) -> None: ) -> None:
"""Check if the cluster has healthy replicates. """Check if the cluster has healthy replicates.
\b
A healthy replicate : A healthy replicate :
* is in running state * is in running state
* has a replica role * has a replica role

6
doc/make_readme.sh
View file

@ -72,11 +72,11 @@ A match is found when : start <= VALUE <= end
For example, the followinf command will raise : For example, the followinf command will raise :
* a warning if there is less than 1 nodes * a warning if there is less than 1 nodes, wich can be translated to outside of range [2;+INF[
* a critical if there are no nodes * a critical if there are no nodes, wich can be translated to outside of range [1;+INF[
``` ```
check_patroni -e https://10.20.199.3:8008 cluster_has_replica --warning @1 --critical @0 check_patroni -e https://10.20.199.3:8008 cluster_has_replica --warning 2: --critical 1:
``` ```
_EOF_ _EOF_
readme readme