example.py

#!/usr/bin/env python
""" nagplug example plugin """

import nagplug


def main():

    # Create a new nagplug.Plugin instance
    sp = nagplug.Plugin(version='1.0')

    # Add some arguments to parse
    sp.add_arg('-w', '--warning', metavar="THRESHOLD", type=nagplug.Threshold,
               help='Warning Threshold, see https://monitoring-plugins.org'
                    '/doc/guidelines.html#THRESHOLDFORMAT')
    sp.add_arg('-c', '--critical', metavar="THRESHOLD", type=nagplug.Threshold,
               help='Warning Threshold, see https://monitoring-plugins.org'
                    '/doc/guidelines.html#THRESHOLDFORMAT')
    sp.add_arg('--value', required=True, metavar='VALUE', type=int)

    # Parse the arguments
    sp.parse_args()

    # Set plugin timeout
    sp.set_timeout()

    # Get values and thresholds from command line
    value = sp.args.value
    t_warn = sp.args.warning
    t_crit = sp.args.critical

    # Check value against thresholds
    code = sp.check_threshold(value, warning=t_warn, critical=t_crit)

    # Add result to the stack
    sp.add_result(code, 'value={0}'.format(value))

    # Add some performance data to the stack
    sp.add_perfdata('value', value, warning=t_warn, critical=t_crit,
                    minimum=0, maximum=100)

    # Add some extra data if needed
    if sp.args.verbose > 2:
        sp.add_extdata('value has been determined to be {0}'.format(value))

    # Exit printing the conclusions in a nagios-plugin compliant way
    sp.finish()


if __name__ == '__main__':
    main()