Fix README.md
This commit is contained in:
parent
9735be6904
commit
14c7ae5267
22
README.md
22
README.md
|
@ -14,7 +14,7 @@ Options:
|
||||||
--key_file TEXT File with the client key.
|
--key_file TEXT File with the client key.
|
||||||
--ca_file TEXT The CA certificate.
|
--ca_file TEXT The CA certificate.
|
||||||
-v, --verbose Increase verbosity -v (info)/-vv (warning)/-vvv
|
-v, --verbose Increase verbosity -v (info)/-vv (warning)/-vvv
|
||||||
(debug) [x>=0]
|
(debug)
|
||||||
--version
|
--version
|
||||||
--timeout INTEGER Timeout in seconds for the API queries (0 to disable)
|
--timeout INTEGER Timeout in seconds for the API queries (0 to disable)
|
||||||
[default: 2]
|
[default: 2]
|
||||||
|
@ -73,8 +73,8 @@ All global and service specific parameters can be specified via a config file ha
|
||||||
```
|
```
|
||||||
[options]
|
[options]
|
||||||
endpoints = https://10.20.199.3:8008, https://10.20.199.4:8008,https://10.20.199.5:8008
|
endpoints = https://10.20.199.3:8008, https://10.20.199.4:8008,https://10.20.199.5:8008
|
||||||
cert_file = ./ssl/benoit-dalibo-cert.pem
|
cert_file = ./ssl/my-cert.pem
|
||||||
key_file = ./ssl/benoit-dalibo-key.pem
|
key_file = ./ssl/my-key.pem
|
||||||
ca_file = ./ssl/CA-cert.pem
|
ca_file = ./ssl/CA-cert.pem
|
||||||
timeout = 0
|
timeout = 0
|
||||||
|
|
||||||
|
@ -83,16 +83,16 @@ lag=100
|
||||||
```
|
```
|
||||||
## Thresholds
|
## Thresholds
|
||||||
|
|
||||||
The format for the threshold parameters is "[@][start:][end]".
|
The format for the threshold parameters is `[@][start:][end]`.
|
||||||
|
|
||||||
* "start:" may be omitted if start==0
|
* `start:` may be omitted if `start == 0`
|
||||||
* "~:" means that start is negative infinity
|
* `~:` means that start is negative infinity
|
||||||
* If `end` is omitted, infinity is assumed
|
* If `end` is omitted, infinity is assumed
|
||||||
* To invert the match condition, prefix the range expression with "@".
|
* To invert the match condition, prefix the range expression with `@`.
|
||||||
|
|
||||||
A match is found when: start <= VALUE <= end
|
A match is found when: `start <= VALUE <= end`.
|
||||||
|
|
||||||
For example, the followinf command will raise:
|
For example, the following command will raise:
|
||||||
|
|
||||||
* a warning if there is less than 1 nodes, wich can be translated to outside of range [2;+INF[
|
* 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, wich can be translated to outside of range [1;+INF[
|
* a critical if there are no nodes, wich can be translated to outside of range [1;+INF[
|
||||||
|
@ -347,3 +347,7 @@ A vagrant file is available to create a icinga / opm / grafana stack and
|
||||||
install check_patroni. You can then add a server to the supervision and
|
install check_patroni. You can then add a server to the supervision and
|
||||||
watch the graphs in grafana. It's in `./test/vagrant`.
|
watch the graphs in grafana. It's in `./test/vagrant`.
|
||||||
|
|
||||||
|
A vagrant file can be found in [this
|
||||||
|
repository](https://github.com/ioguix/vagrant-patroni to generate a
|
||||||
|
patroni/etcd setup.
|
||||||
|
|
||||||
|
|
|
@ -62,8 +62,8 @@ All global and service specific parameters can be specified via a config file ha
|
||||||
```
|
```
|
||||||
[options]
|
[options]
|
||||||
endpoints = https://10.20.199.3:8008, https://10.20.199.4:8008,https://10.20.199.5:8008
|
endpoints = https://10.20.199.3:8008, https://10.20.199.4:8008,https://10.20.199.5:8008
|
||||||
cert_file = ./ssl/benoit-dalibo-cert.pem
|
cert_file = ./ssl/my-cert.pem
|
||||||
key_file = ./ssl/benoit-dalibo-key.pem
|
key_file = ./ssl/my-key.pem
|
||||||
ca_file = ./ssl/CA-cert.pem
|
ca_file = ./ssl/CA-cert.pem
|
||||||
timeout = 0
|
timeout = 0
|
||||||
|
|
||||||
|
@ -72,16 +72,16 @@ lag=100
|
||||||
```
|
```
|
||||||
## Thresholds
|
## Thresholds
|
||||||
|
|
||||||
The format for the threshold parameters is "[@][start:][end]".
|
The format for the threshold parameters is `[@][start:][end]`.
|
||||||
|
|
||||||
* "start:" may be omitted if start==0
|
* `start:` may be omitted if `start == 0`
|
||||||
* "~:" means that start is negative infinity
|
* `~:` means that start is negative infinity
|
||||||
* If `end` is omitted, infinity is assumed
|
* If `end` is omitted, infinity is assumed
|
||||||
* To invert the match condition, prefix the range expression with "@".
|
* To invert the match condition, prefix the range expression with `@`.
|
||||||
|
|
||||||
A match is found when: start <= VALUE <= end
|
A match is found when: `start <= VALUE <= end`.
|
||||||
|
|
||||||
For example, the followinf command will raise:
|
For example, the following command will raise:
|
||||||
|
|
||||||
* a warning if there is less than 1 nodes, wich can be translated to outside of range [2;+INF[
|
* 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, wich can be translated to outside of range [1;+INF[
|
* a critical if there are no nodes, wich can be translated to outside of range [1;+INF[
|
||||||
|
@ -131,5 +131,9 @@ A vagrant file is available to create a icinga / opm / grafana stack and
|
||||||
install check_patroni. You can then add a server to the supervision and
|
install check_patroni. You can then add a server to the supervision and
|
||||||
watch the graphs in grafana. It's in `./test/vagrant`.
|
watch the graphs in grafana. It's in `./test/vagrant`.
|
||||||
|
|
||||||
|
A vagrant file can be found in [this
|
||||||
|
repository](https://github.com/ioguix/vagrant-patroni to generate a
|
||||||
|
patroni/etcd setup.
|
||||||
|
|
||||||
_EOF_
|
_EOF_
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue