Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update plugin usage and add check_ceph_osd_df in README #86

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update plugin usage and add check_ceph_osd_df in README #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 56 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,31 @@ Can be filtered to only look at certain [health checks](https://docs.ceph.com/en

### Usage

usage: check_ceph_health [-h] [-e EXE] [-c CONF] [-m MONADDRESS] [-n NAME] [-i ID] [-k KEYRING] [-w WHITELIST] [-d]
usage: check_ceph_health [-h] [-e EXE] [-A ADMEXE] [--cluster CLUSTER] [-c CONF] [-m MONADDRESS] [-i ID] [-n NAME] [-k KEYRING] [--check CHECK] [-w WHITELIST]
[-d] [-V] [-a] [-s]

'ceph health' nagios plugin.

optional arguments:
-h, --help show this help message and exit
-e EXE, --exe EXE ceph executable [/usr/bin/ceph]
-A ADMEXE, --admexe ADMEXE
cephadm executable [/usr/sbin/cephadm]
--cluster CLUSTER ceph cluster name
-c CONF, --conf CONF alternative ceph conf file
-m MONADDRESS, --monaddress MONADDRESS
ceph monitor address[:port]
-i ID, --id ID ceph client id
-n NAME, --name NAME ceph client name
-k KEYRING, --keyring KEYRING
ceph client keyring file
--check CHECK regexp of which check(s) to check (luminous+) Can be
inverted, e.g. '^((?!PG_DEGRADED|OBJECT_MISPLACED).)*$'
-w, --whitelist REGEXP
--check CHECK regexp of which check(s) to check (luminous+) Can be inverted, e.g. '^((?!(PG_DEGRADED|OBJECT_MISPLACED)$).)*$'
-w WHITELIST, --whitelist WHITELIST
whitelist regexp for ceph health warnings
-d, --detail exec 'ceph health detail'
-V, --version show version and exit
-a, --cephadm uses cephadm to execute the command
-s, --skip-muted skip muted checks

### Example

Expand All @@ -64,7 +69,6 @@ Can be filtered to only look at certain [health checks](https://docs.ceph.com/en
nagios$ ./check_ceph_health --id nagios --check '^((?!PG_DEGRADED|OBJECT_MISPLACED).)*$'
WARNING: MON_CLOCK_SKEW( clock skew detected on mon.a )


## check_ceph_mon

The `check_ceph_mon` nagios plugin monitors an individual mon daemon, reporting its status.
Expand Down Expand Up @@ -107,8 +111,7 @@ Possible result includes OK (up), WARN (down or missing).

### Usage

usage: check_ceph_osd [-h] [-e EXE] [-c CONF] [-m MONADDRESS] [-i ID]
[-k KEYRING] [-V] -H HOST [-I OSDID] [-o]
usage: check_ceph_osd [-h] [-e EXE] [-c CONF] [-m MONADDRESS] [-i ID] [-k KEYRING] [-V] -H HOST [-I OSDID] [-C CRIT] [-o]

'ceph osd' nagios plugin.

Expand All @@ -125,6 +128,7 @@ Possible result includes OK (up), WARN (down or missing).
-H HOST, --host HOST osd host
-I OSDID, --osdid OSDID
osd id
-C CRIT, --crit CRIT Number of failed OSDs to trigger critical (default=2)
-o, --out check osds that are set OUT

### Example
Expand Down Expand Up @@ -339,7 +343,6 @@ Possible result includes OK, WARN (laggy) and Error (not found).

The `check_ceph_mgr` nagios plugin monitors the mgr.


### Usage

usage: check_ceph_mgr [-h] [-e EXE] [-c CONF] [-m MONADDRESS] [-i ID]
Expand Down Expand Up @@ -369,5 +372,50 @@ The `check_ceph_mgr` nagios plugin monitors the mgr.
The `check_ceph_osd_db` checks the percentage usage of the BlueStore DB
for the OSD and reports it as critical if it's above the threshold.

### Usage

usage: check_ceph_osd_db [-h] [-e EXE] [-c CONF] [-m MONADDRESS] [-i ID] [-k KEYRING] -H HOST [-C CRITICAL]

'ceph osd' nagios plugin.

optional arguments:
-h, --help show this help message and exit
-e EXE, --exe EXE ceph executable [/usr/bin/ceph]
-c CONF, --conf CONF alternative ceph conf file
-m MONADDRESS, --monaddress MONADDRESS
ceph monitor address[:port]
-i ID, --id ID ceph client id
-k KEYRING, --keyring KEYRING
ceph client keyring file
-H HOST, --host HOST osd host
-C CRITICAL, --critical CRITICAL
critical threshold

## check_ceph_osd_df

The `check_ceph_osd_df` checks the percentage usage of the the OSDs and
reports if it's above the thresholds.

### Usage

usage: check_ceph_osd_df [-h] [-e EXE] [-c CONF] [-m MONADDRESS] [-i ID] [-n NAME] [-k KEYRING] [-W WARN] [-C CRITICAL] [-V]

'ceph osd df' nagios plugin.

optional arguments:
-h, --help show this help message and exit
-e EXE, --exe EXE ceph executable [/usr/bin/ceph]
-c CONF, --conf CONF alternative ceph conf file
-m MONADDRESS, --monaddress MONADDRESS
ceph monitor address[:port]
-i ID, --id ID ceph client id
-n NAME, --name NAME ceph client name
-k KEYRING, --keyring KEYRING
ceph client keyring file
-W WARN, --warn WARN warn above this percent USED
-C CRITICAL, --critical CRITICAL
critical alert above this percent USED
-V, --version show version and exit

[ceph]: http://www.ceph.com
[cephx]: http://ceph.com/docs/master/rados/operations/authentication/