check_purefa_space.py

#!/usr/bin/env python
# Copyright (c) 2018, 2019, 2020, 2022 Pure Storage, Inc.
#
# * Overview
#
# This simple Nagios/Icinga plugin code can be used to monitor Pure Storage FlashArrays.
# The Pure Storage Python REST Client is used to query the FlashArray space indicators.
#
# * Installation
#
# The script 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).
#

"""Pure Storage FlashArray space status

   Nagios plugin to retrieve the overall space utilization from a Pure Storage FlashArray or from a single volume.
   Storage utilization indicators are collected from the target FA using the REST call.
   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
   used space, while they must be integer byte units if checking a single volume. You can use the -p flag to
   switch to percentages for per volume checking.

"""

import sys

if not sys.warnoptions:
    import warnings
    warnings.simplefilter("ignore")

import argparse
import logging
import logging.handlers
import nagiosplugin
from pypureclient import flasharray, PureError

# Disable warnings using urllib3 embedded in requests or directly
try:
    import requests
    from requests.packages.urllib3.exceptions import InsecureRequestWarning
    requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
except:
    import urllib3
    urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)


class PureFAspace(nagiosplugin.Resource):
    """Pure Storage FlashArray used space

    Retrieve the overall FA storage used space or a single volume capacity.

    """

    def __init__(self, endpoint, apitoken, volname, percentage):
        self.endpoint = endpoint
        self.apitoken = apitoken
        self.volname = volname
        self.percentage = percentage
        self.logger = logging.getLogger(self.name)
        handler = logging.handlers.SysLogHandler(address = '/dev/log')
        handler.setLevel(logging.ERROR)
        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
        handler.setFormatter(formatter)
        self.logger.addHandler(handler)

    @property
    def name(self):
        if (self.volname is None):
            return 'PURE_FA_SPACE'
        else:
            return 'PURE_FA_VOL_SPACE'


    def get_space(self):
        """Get space counters from flasharray."""
        fainfo = {}
        try:
            client = flasharray.Client(target=self.endpoint,
                                   api_token=self.apitoken,
                                   user_agent='Pure_Nagios_plugin/0.2.0')
            if (self.volname is None):
                res = client.get_arrays()
            else:
                res = client.get_volumes_space(names=[self.volname])
            if isinstance(res, flasharray.ValidResponse):
                fainfo = res.items
        except Exception as e:
            raise nagiosplugin.CheckError('FA REST call returned "{}"'.format(e))
        return(fainfo.next())

    def probe(self):
        fainfo = self.get_space()
        if (self.volname is None):
            if self.percentage:
                space = round(float(fainfo.space.total_physical) / float(fainfo.capacity), 2) * 100
                metric = nagiosplugin.Metric('FA space', space, '%', min=0, max=100, context='space')
            else:
                space = int(fainfo.space.total_physical)
                metric = nagiosplugin.Metric('FA space', space, 'B', min=0, context='space')
        else:
            space = int(fainfo.space.total_physical)
            metric = nagiosplugin.Metric(self.volname + ' space', space, 'B', min=0, context='space')
        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('--vol', help="FA volume name. If omitted the whole FA used space is checked")
    
    argp.add_argument('-w', '--warning', metavar='RANGE', default='',
                      help='return warning if used space is outside RANGE. Value has to be expressed in percentage for the FA, while in bytes for the single volume')
    argp.add_argument('-c', '--critical', metavar='RANGE', default='',
                      help='return critical if used space is outside RANGE. Value has to be expressed in percentage for the FA, while in bytes for the single volume')
    argp.add_argument('-p', '--percentage', action='store_true',
                      help='Set this flag if you want to use percentages instead of bytes for array space usage. This flag does nothing when checking the whole array')
    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( PureFAspace(args.endpoint, args.apitoken, args.vol, args.percentage) )
    check.add(nagiosplugin.ScalarContext('space', args.warning, args.critical))
    check.main(args.verbose, args.timeout)

if __name__ == '__main__':
    main()