Readme
* Add the README.md * A way to generate the README.md from the help
This commit is contained in:
benoit
parent
db3f008b81
commit
4169766a2f
260
README.md
260
README.md
|
|
@ -0,0 +1,260 @@
|
|||
# check_patroni
|
||||
|
||||
```
|
||||
Usage: check_patroni [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Nagios plugin for patroni.
|
||||
|
||||
Options:
|
||||
--config FILE Read option defaults from the specified INI file
|
||||
[default: config.ini]
|
||||
-e, --endpoints TEXT API endpoint. Can be specified multiple times.
|
||||
--cert_file TEXT File with the client certificate.
|
||||
--key_file TEXT File with the client key.
|
||||
--ca_file TEXT The CA certificate.
|
||||
-v, --verbose Increase verbosity -v (info)/-vv (warning)/-vvv
|
||||
(debug) [x>=0]
|
||||
--version
|
||||
--timeout INTEGER Timeout in seconds for the API queries (0 to disable)
|
||||
--help Show this message and exit.
|
||||
|
||||
Commands:
|
||||
cluster_config_has_changed Check if the hash of the configuration has...
|
||||
cluster_has_leader Check if the cluster has a leader.
|
||||
cluster_has_replica Check if the cluster has replicas and their...
|
||||
cluster_is_in_maintenance Check if the cluster is in maintenance mode...
|
||||
cluster_node_count Count the number of nodes in the cluster.
|
||||
node_is_alive Check if the node is alive ie patroni is...
|
||||
node_is_pending_restart Check if the node is in pending restart state.
|
||||
node_is_primary Check if the node is the primary with the...
|
||||
node_is_replica Check if the node is a running replica with...
|
||||
node_patroni_version Check if the version is equal to the input
|
||||
node_tl_has_changed Check if the timeline has changed.
|
||||
```
|
||||
|
||||
## cluster services
|
||||
### cluster_config_has_changed
|
||||
|
||||
```
|
||||
Usage: check_patroni cluster_config_has_changed [OPTIONS]
|
||||
|
||||
Check if the hash of the configuration has changed.
|
||||
|
||||
Note: either a hash or a state file must be provided for this service to
|
||||
work.
|
||||
|
||||
Check:
|
||||
* `OK`: The hash didn't change
|
||||
* `CRITICAL`: The hash of the configuration has changed compared to the input (`--hash`) or last time (`--state_file`)
|
||||
|
||||
Perfdata :
|
||||
* `is_configuration_changed` is 1 if the configuration has changed
|
||||
|
||||
Options:
|
||||
--hash TEXT A hash to compare with.
|
||||
-s, --state-file TEXT A state file to store the tl number into.
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### cluster_has_leader
|
||||
|
||||
```
|
||||
Usage: check_patroni cluster_has_leader [OPTIONS]
|
||||
|
||||
Check if the cluster has a leader.
|
||||
|
||||
Check:
|
||||
* `OK`: if there is a leader node.
|
||||
* `CRITICAL`: otherwise
|
||||
|
||||
Perfdata : `has_leader` is 1 if there is a leader node, 0 otherwise
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### cluster_has_replica
|
||||
|
||||
```
|
||||
Usage: check_patroni cluster_has_replica [OPTIONS]
|
||||
|
||||
Check if the cluster has replicas and their lag.
|
||||
|
||||
Check:
|
||||
* `OK`: if the replica count and their lag are compatible with the replica count and lag thresholds.
|
||||
* `WARNING` / `CRITICAL`: otherwise
|
||||
|
||||
Perfdata :
|
||||
* replica count
|
||||
* the lag of each replica labelled with "member name"_lag
|
||||
|
||||
Options:
|
||||
-w, --warning TEXT Warning threshold for the number of nodes.
|
||||
-c, --critical TEXT Critical threshold for the number of replica nodes.
|
||||
--lag-warning TEXT Warning threshold for the lag.
|
||||
--lag-critical TEXT Critical threshold for the lag.
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### cluster_is_in_maintenance
|
||||
|
||||
```
|
||||
Usage: check_patroni cluster_is_in_maintenance [OPTIONS]
|
||||
|
||||
Check if the cluster is in maintenance mode ie paused.
|
||||
|
||||
Check:
|
||||
* `OK`: If the cluster is in maintenance mode.
|
||||
* `CRITICAL`: otherwise.
|
||||
|
||||
Perfdata :
|
||||
* `is_in_maintenance` is 1 the cluster is in maintenance mode, 0 otherwise
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### cluster_node_count
|
||||
|
||||
```
|
||||
Usage: check_patroni cluster_node_count [OPTIONS]
|
||||
|
||||
Count the number of nodes in the cluster.
|
||||
|
||||
Check:
|
||||
* Compares the number of nodes against the normal and running node warning and critical thresholds.
|
||||
* `OK`! If they are not provided.
|
||||
|
||||
Perfdata:
|
||||
* `members`: the member count.
|
||||
* all the roles of the nodes in the cluster with their number.
|
||||
* all the statuses of the nodes in the cluster with their number.
|
||||
|
||||
Options:
|
||||
-w, --warning TEXT Warning threshold for the number of nodes.
|
||||
-c, --critical TEXT Critical threshold for the nimber of nodes.
|
||||
--running-warning TEXT Warning threshold for the number of running nodes.
|
||||
--running-critical TEXT Critical threshold for the nimber of running nodes.
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
## node services
|
||||
### node_is_alive
|
||||
|
||||
```
|
||||
Usage: check_patroni node_is_alive [OPTIONS]
|
||||
|
||||
Check if the node is alive ie patroni is running.
|
||||
|
||||
Check:
|
||||
* `OK`: If patroni is running.
|
||||
* `CRITICAL`: otherwise.
|
||||
|
||||
Perfdata :
|
||||
* `is_running` is 1 if patroni is running, 0 otherwise
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### node_is_pending_restart
|
||||
|
||||
```
|
||||
Usage: check_patroni node_is_pending_restart [OPTIONS]
|
||||
|
||||
Check if the node is in pending restart state.
|
||||
|
||||
This situation can arise if the configuration has been modified but requiers
|
||||
a restart of PostgreSQL to take effect.
|
||||
|
||||
Check:
|
||||
* `OK`: if the node has pending restart tag.
|
||||
* `CRITICAL`: otherwise
|
||||
|
||||
Perfdata: `is_pending_restart` is 1 if the node has pending restart tag, 0
|
||||
otherwise.
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### node_is_primary
|
||||
|
||||
```
|
||||
Usage: check_patroni node_is_primary [OPTIONS]
|
||||
|
||||
Check if the node is the primary with the leader lock.
|
||||
|
||||
Check:
|
||||
* `OK`: if the node is a primary with the leader lock.
|
||||
* `CRITICAL:` otherwise
|
||||
|
||||
Perfdata: `is_primary` is 1 if the node is a primary with the leader lock, 0
|
||||
otherwise.
|
||||
|
||||
Options:
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### node_is_replica
|
||||
|
||||
```
|
||||
Usage: check_patroni node_is_replica [OPTIONS]
|
||||
|
||||
Check if the node is a running replica with no noloadbalance tag.
|
||||
|
||||
Check:
|
||||
* `OK`: if the node is a running replica with noloadbalance tag and the lag is under the maximum threshold.
|
||||
* `CRITICAL`: otherwise
|
||||
|
||||
Perfdata : `is_replica` is 1 if the node is a running replica with
|
||||
noloadbalance tag and the lag is under the maximum threshold, 0 otherwise.
|
||||
|
||||
Options:
|
||||
--lag TEXT maximum allowed lag
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### node_patroni_version
|
||||
|
||||
```
|
||||
Usage: check_patroni node_patroni_version [OPTIONS]
|
||||
|
||||
Check if the version is equal to the input
|
||||
|
||||
Check:
|
||||
* `OK`: The version is the same as the input `--patroni-version`
|
||||
* `CRITICAL`: otherwise.
|
||||
|
||||
Perfdata :
|
||||
* `is_version_ok` is 1 if version is ok, 0 otherwise
|
||||
|
||||
Options:
|
||||
--patroni-version TEXT Patroni version to compare to [required]
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
### node_tl_has_changed
|
||||
|
||||
```
|
||||
Usage: check_patroni node_tl_has_changed [OPTIONS]
|
||||
|
||||
Check if the timeline has changed.
|
||||
|
||||
Note: either a timeline or a state file must be provided for this service to
|
||||
work.
|
||||
|
||||
Check:
|
||||
* `OK`: The timeline is the same as last time (`--state_file`) or the inputed timeline (`--timeline`)
|
||||
* `CRITICAL`: The tl is not the same.
|
||||
|
||||
Perfdata :
|
||||
* `is_configuration_changed` is 1 if the configuration has changed, 0 otherwise
|
||||
|
||||
Options:
|
||||
--timeline TEXT A timeline number to compare with.
|
||||
-s, --state-file TEXT A state file to store the last tl number into.
|
||||
--help Show this message and exit.
|
||||
```
|
||||
|
||||
|
||||
46
doc/make_readme.sh
Executable file
46
doc/make_readme.sh
Executable file
|
|
@ -0,0 +1,46 @@
|
|||
#!/bin/bash
|
||||
|
||||
README="../README.md"
|
||||
function readme(){
|
||||
echo "$1" >> $README
|
||||
}
|
||||
|
||||
function helpme(){
|
||||
readme
|
||||
readme "\`\`\`"
|
||||
check_patroni $1 --help >> $README
|
||||
readme "\`\`\`"
|
||||
readme
|
||||
}
|
||||
|
||||
cat << _EOF_ > $README
|
||||
# check_patroni
|
||||
_EOF_
|
||||
helpme
|
||||
readme "## cluster services"
|
||||
readme "### cluster_config_has_changed"
|
||||
helpme cluster_config_has_changed
|
||||
readme "### cluster_has_leader"
|
||||
helpme cluster_has_leader
|
||||
readme "### cluster_has_replica"
|
||||
helpme cluster_has_replica
|
||||
readme "### cluster_is_in_maintenance"
|
||||
helpme cluster_is_in_maintenance
|
||||
readme "### cluster_node_count"
|
||||
helpme cluster_node_count
|
||||
readme "## node services"
|
||||
readme "### node_is_alive"
|
||||
helpme node_is_alive
|
||||
readme "### node_is_pending_restart"
|
||||
helpme node_is_pending_restart
|
||||
readme "### node_is_primary"
|
||||
helpme node_is_primary
|
||||
readme "### node_is_replica"
|
||||
helpme node_is_replica
|
||||
readme "### node_patroni_version"
|
||||
helpme node_patroni_version
|
||||
readme "### node_tl_has_changed"
|
||||
helpme node_tl_has_changed
|
||||
cat << _EOF_ >> $README
|
||||
|
||||
_EOF_
|
||||
Loading…
Reference in a new issue