Create check_purefa_occpy.py

Author: genegr

check_purefa_occpy.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python
+# Copyright (c) 2018 Pure Storage, Inc.
+#
+## Overview
+#
+# This short Nagios/Icinga plugin code shows  how to build a simple plugin to monitor Pure Storage FlashArrays.
+# The Pure Storage Python REST Client is used to query the FlashArray occupancy indicators.
+# Plugin leverages the remarkably helpful nagiosplugin library by Christian Kauhaus.
+#
+## Installation
+#
+# The scripo 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.
+# Change the execution rights of the program to allow the execution to 'all' (usually chmod 0755).
+#
+## Dependencies
+#
+#  nagiosplugin      helper Python class library for Nagios plugins by Christian Kauhaus (http://pythonhosted.org/nagiosplugin)
+#  purestorage       Pure Storage Python REST Client (https://github.com/purestorage/rest-client)
+
+__author__ = "Eugenio Grosso"
+__copyright__ = "Copyright 2018, Pure Storage Inc."
+__credits__ = "Christian Kauhaus"
+__license__ = "Apache v2.0"
+__version__ = "1.0"
+__maintainer__ = "Eugenio Grosso"
+__email__ = "geneg@purestorage.com"
+__status__ = "Production"
+
+"""Pure Storage FlashArray occupancy status
+
+   Nagios plugin to retrieve the overall occupancy from a Pure Storage FlashArray.
+   Storage occupancy indicators are collected from the target FA using the REST call.
+
+"""
+
+import argparse
+import logging
+import nagiosplugin
+import purestorage
+import urllib3
+
+
+_log = logging.getLogger('nagiosplugin')
+
+class PureFAoccpy(nagiosplugin.Resource):
+    """Pure Storage FlashArray overall occupancy
+
+    Calculates the overall FA storage occupancy
+
+    """
+
+    def __init__(self, endpoint, apitoken):
+        self.endpoint = endpoint
+        self.apitoken = apitoken
+
+    def get_perf(self):
+        """Gets performance counters from flasharray."""
+        urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+        fa = purestorage.FlashArray(self.endpoint, api_token=self.apitoken)
+        fainfo = fa.get(space=True)[0]
+        fa.invalidate_cookie()
+        return(fainfo)
+
+    def probe(self):
+
+        fainfo = self.get_perf()
+        _log.debug('FA REST call returned "%s" ', fainfo)
+        occupancy = round(float(fainfo.get('total'))/float(fainfo.get('capacity')), 2) * 100
+        metric = nagiosplugin.Metric('occupancy', occupancy, '%', min=0),
+        return metric
+
+
+def parse_args():
+    argp = argparse.ArgumentParser()
+    argp.add_argument('endpoint', help="FA hostname or ip address")
+    argp.add_argument('apitoken', help="FA api_token")
+    argp.add_argument('-w', '--warning', metavar='RANGE', default='',
+                      help='return warning if occupancy is outside RANGE')
+    argp.add_argument('-c', '--critical', metavar='RANGE', default='',
+                      help='return critical if occupancy is outside RANGE')
+    argp.add_argument('-v', '--verbose', action='count', default=0,
+                      help='increase output verbosity (use up to 3 times)')
+    argp.add_argument('-t', '--timeout', default=30,
+                      help='abort execution after TIMEOUT seconds')
+    return argp.parse_args()
+
+
+@nagiosplugin.guarded
+def main():
+    args = parse_args()
+    check = nagiosplugin.Check( PureFAoccpy(args.endpoint, args.apitoken) )
+    check.add(nagiosplugin.ScalarContext('occupancy', args.warning, args.critical))
+    check.main(args.verbose, args.timeout)
+
+if __name__ == '__main__':
+    main()