diff --git a/docs/20_Checks/check_couchdb.md b/docs/20_Checks/check_couchdb.md index 8698c95db4c07b13181809f2a2c704fdbfe361dd..b5fd68875816e95d9b488820a55de1ac11f19043 100644 --- a/docs/20_Checks/check_couchdb.md +++ b/docs/20_Checks/check_couchdb.md @@ -6,6 +6,8 @@ Check couchdb status. ### Requirements +* curl +* jq * a running couchdb service * authentication (see section Installation below) @@ -16,7 +18,7 @@ Check couchdb status. ______________________________________________________________________ CHECK_COUCHDB -v0.2 +v0.3 (c) Institute for Medical Education - University of Bern Licence: GNU GPL 3 @@ -33,7 +35,12 @@ OPTIONS: -h or --help show this help. -c CFGFILE set a custom config file default: /etc/icingaclient/.couchdb - -m MODE test a value; for debugging purposes + -m MODE test a value; for debugging purposes the full json + response will be shown + + MODE is one of + up show general couchdb status + replication show last replication status EXAMPLE: check_couchdb -m up @@ -66,13 +73,17 @@ With the parameter ``-m METHOD`` you define what kind of check to perform. ### up Simple check if couchdb is up and running. + +From url ``/up`` it fetches the value status. +It switches to critical if one of the seeds is not "ok". + `check_couchdb -m up` returns ```txt OK: Couchdb status (value in /_up is 'ok') Reponse: { - "status": "ok", + "status": "ok", <<< checked value "seeds": { "couchdb@192.168.25.172": { "timestamp": "2023-08-28T07:27:54.938619Z", @@ -87,3 +98,30 @@ Reponse: } } ``` + +### replication + +From url ``/up`` it fetches seeds -> [node] -> last_replication_status. +It switches to critical if one of the seeds is not "ok". + +``check_couchdb -m replication`` returns + +```txt +OK: Couchdb replication +Reponse: +{ + "status": "ok", + "seeds": { + "couchdb@192.168.25.172": { + "timestamp": "2023-08-28T07:27:54.938619Z", + "last_replication_status": "ok", <<< checked value + "pending_updates": { + "_nodes": 0, + "_dbs": 0, + "_users": 0 + } + }, + "couchdb@192.168.25.61": {} + } +} +```