A repository of plugins and extensions to monitor Pure Storage FlashArray and FlashBlade storage arrays with Nagios.
- check_purefa_alert.py Simple plugin for monitoring Pure Storage FlashArray alerts status.
- check_purefa_hw.py Simple plugin for monitoring Pure Storage FlashArray hardware components.
- check_purefa_space.py Simple plugin for monitoring Pure Storage FlashArray space metrics (global/per volume).
- check_purefa_perf.py Simple plugin for monitoring Pure Storage FlashArray performance metrics (global/per volume).
- check_purefa_pod.py Simple plugin for monitoring Pure Storage FlashArray pods status (global/per pod).
- check_purefb_alert.py Simple plugin for monitoring Pure Storage FlashBlade alerts status.
- check_purefb_hw.py Simple plugin for monitoring Pure Storage FlashBlade hardware components.
- check_purefb_space.py Simple plugin for monitoring Pure Storage FlashBlade space occupancy (global/object store/per shared filesystem).
- check_purefb_perf.py Simple plugin for monitoring Pure Storage FlashBlade performance metrics (global/per protocol).
The plugin scripts should be copied to the Nagios plugins directory on the machine hosting the Nagios server or the NRPE, for example the /usr/lib/nagios/plugins folder should be used for Nagios XI. Change the execution rights of the plugins to allow the execution to 'all' (usually chmod 0755). Plugins depend on
nagiosplugin helper Python class library for Nagios plugins
py-pure-client Pure Storage Python REST Client for FlashArray
pip install -r requirements.txtNagios plugin to retrieve the current status of open alert messages from a Pure Storage FlashArray. Alert messages states are collected from the target FA using the REST call.
*check_purefa_alert.py endpoint api_token
The plugin has two mandatory arguments: 'endpoint', which specifies the target FB and 'apitoken', which specifies the autentication token for the REST call session.
check_purefa_alert.py 10.225.112.102 b6ef8864-2324-b9d5-cbc3-01f5092105a1
PURE_FA_ALERT CRITICAL - FA_ALERTS is 1 (outside range @1:1) | FA_ALERTS=1;;@1:1
Nagios plugin to retrieve the current status of hardware components from a Pure Storage FlashArray. Hardware status indicators are collected from the target FA using the REST call.
check_purefa_hw.py endpoint api_token hw_component
The plugin has three mandatory arguments: 'endpoint', which specifies the target FA, 'apitoken', which specifies the autentication token for the REST call session and 'component', that is the name of the hardware component to be monitored. The component must be specified using the internal naming schema of the Pure FlashArray: i.e CH0 for the main chassis, CH1 for the secondary chassis (shelf 1), CT0 for controller 0,i CT1 for controller 1, CH0.NVB0 for the first NVRAM module, CH0.NVB1 for the second NVRAM module, CH0.BAY0 for the first flash module, CH0.BAY10 for the tenth flash module, CH1.BAY1, for the first flash module on the first additional shelf,...
check_purefa_hw.py 10.225.112.81 c4eb5b21-4122-b871-8b0f-684bf72b5283 CH0.BAY2
PURE_FA_CH0.BAY2 OK - CH0.BAY2 status is 0 | 'CH0.BAY2 status'=0;1;1
Nagios plugin to retrieve the overall occupancy from a Pure Storage FlashArray or from a single volume. Storage occupancy indicators are collected from the target FA using the REST call.
check_purefa_space.py endpoint api_token [--vol volname] [-w RANGE] [-c RANGE]
The plugin has two mandatory arguments: 'endpoint', which specifies the target FA and 'apitoken', which specifies the autentication token for the REST call session. A third optional parameter, 'volname' can be used to check a specific named value. The optional values for the warning and critical thresholds have different meausure units: they must be expressed as percentages in the case of checkig the whole flasharray occupancy, while they must be integer byte units if checking a single volume.
Check the whole FlashArray space usage:
check_purefa_space.py 10.225.112.81 c4eb5b21-4122-b871-8b0f-684bf72b5283
PURE_FA_SPACE OK - FA space is 66% | 'FA space'=66.0%;;;0;100
Check volume oracle-u04 occupancy
check_purefa_space.py 10.225.112.81 c4eb5b21-4122-b871-8b0f-684bf72b5283 --vol oracle1-u04
PURE_FA_VOL_SPACE OK - z-oracle1-u04 space is 52624121069B | 'oracle1-u04 space'=52624121069B;;;0
Nagios plugin to retrieve the six (6) basic KPIs from a Pure Storage FlashArray. Bandwidth counters (read/write), IOPs counters (read/write) and latency (read/write) are collected from the target FA using the REST call.
check_purefa_perf.py endpoint api_token [--vol volname][--tw RANGE[,RANGE,...]] [--tc RANGE[,RANGE,...]] [--t TIMEOUT]
The plugin has two mandatory arguments: 'endpoint', which specifies the target FA and 'apitoken', which specifies the autentication token for the REST call session. A third optional parameter, 'volname' can be used to check a specific named volume. In addition to these parameters, the plugin accepts multiple warning and critical threshold parameters in positional order:
- 1st threshold refers to write latency
- 2nd threshold refers to read latency
- 3rd threshold refers to write bandwidth
- 4th threshold refers to read bandwidth
- 5th threshold refers to write IOPS
- 6th threshold refers to read IOPS.
Abbreviations:
- rbw -> Read bandwidth (Byte/sec)
- riops -> Read IOPS
- rlat -> Read latency (microseconds)
- wbw -> Write bandwidth (Byte/sec)
- wiops -> Write IOPS
- wlat -> Write latency (microseconds)
Check the whole FlashArray performance indicators.
check_purefa_perf.py 10.225.112.81 c4eb5b21-4122-b871-8b0f-684bf72b5283
PURE_FA_PERF OK - 'FA wlat' is 237us | 'FA rbw'=328977030B/s;;;0 'FA riops'=80269rd/s;;;0 'FA rlat'=419us;;;0 'FA wbw'=110185869B/s;;;0 'FA wiops'=26798wr/s;;;0 'FA wlat'=237us;;;0
Check the volume oracle1-u04 performance indicators
check_purefa_perf.py 10.225.112.81 c4eb5b21-4122-b871-8b0f-684bf72b5283 --vol oracle1-u04
PURE_FA_VOL_PERF OK - oracle1-u04_wlat is 205us | 'oracle1-u04_rbw'=336190250B/s;;;0 'oracle1-u04_riops'=82078rd/s;;;0 'oracle1-u04_rlat'=370us;;;0 'oracle1-u04_wbw'=111469774B/s;;;0 'oracle1-u04_wiops'=27214wr/s;;;0 'oracle1-u04_wlat'=205us;;;0
Nagios plugin to retrieve the current status of open alert messages from a Pure Storage FlashBlade. Alert messages states are collected from the target FB using the REST call.
*check_purefb_alert.py endpoint api_token
The plugin has two mandatory arguments: 'endpoint', which specifies the target FB and 'apitoken', which specifies the autentication token for the REST call session.
check_purefb_alert.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece
PURE_FB_ALERTS CRITICAL - FB_ALERTS is 1 (outside range @1:1) | FB_ALERTS=1;;@1:1
Nagios plugin to retrieve the current status of hardware components from a Pure Storage FlashBlade. Hardware status indicators are collected from the target FB using the REST call.
check_purefb_hw.py endpoint api_token hw_component
The plugin has three mandatory arguments: 'endpoint', which specifies the target FB, 'apitoken', which specifies the autentication token for the REST call session and 'component', that is the name of the hardware component to be monitored. The component must be specified using the internal naming schema of the Pure FlashBlade: i.e CH1 for the main chassis, CH1.FM1 for the primary flash module, CH1.FM2 for the secondary, CH1.FB1 for the first blade of first chassis, CH1.FB2 for the secondary blade, CH2 for the second chained FlashBlade and so on.
check_purefb_hw.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece CH1.FM1
PURE_FB_CH1.FM1 OK - CH1.FM1 status is 0 | 'CH1.FM1 status'=0;1;1
Nagios plugin to retrieve the overall occupancy from a Pure Storage FlashBlade, or from a single volume, or from the object store. Storage occupancy indicators are collected from the target FB using the REST call.
check_purefb_space.py endpoint api_token [--fs [volume]| --s3 [bucket]] [-w RANGE] [-c RANGE]
The plugin has two mandatory arguments: 'endpoint', which specifies the target FB and 'apitoken', which specifies the autentication token for the REST call session. A third optional parameter, 'volname' or 'objectstore' can be used to check a specific named value or the objectstore occupancy. The optional values for the warning and critical thresholds have different meausure units: they must be expressed as percentages in the case of checkig the whole FlashBlade occupancy, while they must be integer byte units if checking a single volume.
Check the whole FlashBlade occupancy:
check_purefb_space.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece
PURE_FB_SPACE OK - FB space is 21% | 'FB space'=21.0%;;;0;100
Check volume oracle-u01 occupancy
./check_purefb_space.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece --fs oracle-u01
PURE_FB_SPACE OK - oracle-u01 space is 193883707392B | 'oracle-u01 space'=193883707392B;;;0
Check objectsore overall occupancy
check_purefb_space.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece --s3
PURE_FB_OBJSTORE_SPACE OK - FB space is 1% | 'FB space'=1.0%;;;0;100
Nagios plugin to retrieve the six (6) basic KPIs from a Pure Storage FlashBlade. Bandwidth counters (read/write), IOPs counters (read/write) and latency (read/write) are collected from the target FB using the REST call.
check_purefb_perf.py endpoint api_token [--proto nfs|http|s3][--tw RANGE[,RANGE,...]] [--tc RANGE[,RANGE,...]] [--t TIMEOUT]
The plugin has two mandatory arguments: 'endpoint', which specifies the target FA and 'apitoken', which specifies the autentication token for the REST call session. A third optional parameter, 'protocol' can be used to check a specific protocol. The plugin accepts multiple warning and critical threshold parameters in a positional fashion: 1st threshold refers to write latency 2nd threshold refers to read latency 3rd threshold refers to write bandwidth 4th threshold refers to read bandwidth 5th threshold refers to write IOPS 6th threshold refers to read IOPS
Check the whole FlashBlade performance indicators.
check_purefb_perf.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece
PURE_FB_PERF OK - FB_wlat is 0us | 'FB_rbw'=0B/s;;;0 'FB_riops'=0rd/s;;;0 'FB_rlat'=0us;;;0 'FB_wbw'=0B/s;;;0 'FB_wiops'=0wr/s;;;0 'FB_wlat'=0us;;;0
Check the NFS performance indicators.
check_purefb_perf.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece --proto nfs
PURE_FB_NFS_PERF OK - FB_wlat is 0us | 'FB_rbw'=0B/s;;;0 'FB_riops'=0rd/s;;;0 'FB_rlat'=0us;;;0 'FB_wbw'=0B/s;;;0 'FB_wiops'=0wr/s;;;0 'FB_wlat'=0us;;;0
Check the S3 performance indicators.
check_purefb_perf.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece --proto s3
PURE_FB_S3_PERF OK - FB_wlat is 0us | 'FB_rbw'=0B/s;;;0 'FB_riops'=0rd/s;;;0 'FB_rlat'=0us;;;0 'FB_wbw'=0B/s;;;0 'FB_+wiops'=0wr/s;;;0 'FB_wlat'=0us;;;0
Check the HTTP performance indicators.
check_purefb_perf.py 10.225.112.69 T-a1c1a9de-5d14-4f1d-9469-4e1853232ece --proto http
PURE_FB_HTTP_PERF OK - FB_wlat is 0us | 'FB_rbw'=0B/s;;;0 'FB_riops'=0rd/s;;;0 'FB_rlat'=0us;;;0 'FB_wbw'=0B/s;;;0 'FB_wiops'=0wr/s;;;0 'FB_wlat'=0us;;;