Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

A framework for writing Python sensu plugins.

Project Description

# Python Sensu Plugin

This is a framework for writing your own [Sensu]( plugins in Python.
It's not required to write a plugin (most Nagios plugins will work
without modification); it just makes it easier.

[![Build Status](](

## Checks

To implement your own check, subclass SensuPluginCheck, like

from sensu_plugin import SensuPluginCheck

class MyCheck(SensuPluginCheck):
def setup(self):
# Setup is called with self.parser set and is responsible for setting up
# self.options before the run method is called

help='Integer warning level to output'
help='Message to print'

def run(self):
# this method is called to perform the actual check

self.check_name('my_awesome_check') # defaults to class name

if self.options.warning == 0:
elif self.options.warning == 1:
elif self.options.warning == 2:

if __name__ == "__main__":
f = MyCheck()

## Metrics

### JSON

from sensu_plugin import SensuPluginMetricJSON

class FooBarBazMetricJSON(SensuPluginMetricJSON):
def run(self):
self.ok({'foo': 1, 'bar': { 'baz': 'stuff' } })

if __name__ == "__main__":
f = FooBarBazMetricJSON()

### Graphite

from sensu_plugin import SensuPluginMetricGraphite

class FooBarBazMetricGraphite(SensuPluginMetricGraphite):
def run(self):
self.output('a', 1)
self.output('b', 2)

if __name__ == "__main__":
f = FooBarBazMetricGraphite()

### StatsD

from sensu_plugin import SensuPluginMetricStatsd

class FooBarBazMetricStatsd(SensuPluginMetricStatsd):
def run(self):
self.output('a', 1, 'ms')
self.output('b.c.d', 15)

if __name__ == "__main__":
f = FooBarBazMetricStatsd()

## License

* Based heavily on [sensu-plugin]( Copyright 2011 Decklin Foster
* Python port Copyright 2014 S. Zachariah Sprackett

Released under the same terms as Sensu (the MIT license); see LICENSE
for details
Release History

Release History

This version
History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sensu_plugin26-0.2.0.tar.gz (4.2 kB) Copy SHA256 Checksum SHA256 Source Dec 11, 2014 (8.5 kB) Copy SHA256 Checksum SHA256 Source Dec 11, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting