https://github.com/sensu-plugins/sensu-plugin-python

A framework for writing Sensu plugins & handlers with Python.
https://github.com/sensu-plugins/sensu-plugin-python

library monitoring python sensu sensu-plugin

Last synced: about 7 hours ago
JSON representation

A framework for writing Sensu plugins & handlers with Python.

• Host: GitHub
• URL: https://github.com/sensu-plugins/sensu-plugin-python
• Owner: sensu-plugins
• License: mit
• Created: 2014-01-07T17:22:11.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T19:32:23.000Z (over 3 years ago)
• Last Synced: 2025-01-03T01:56:03.596Z (about 13 hours ago)
• Topics: library, monitoring, python, sensu, sensu-plugin
• Language: Python
• Homepage: http://sensu-plugins.io
• Size: 103 KB
• Stars: 64
• Watchers: 20
• Forks: 21
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![sensu](https://raw.github.com/sensu/sensu/master/sensu-logo.png)

# Python Sensu Plugin

This is a framework for writing your own [Sensu](https://github.com/sensu/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](https://travis-ci.org/sensu-plugins/sensu-plugin-python.png?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugin-python)

## Checks

To implement your own check, subclass SensuPluginCheck, like

this:

    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

        self.parser.add_argument(

          '-w',

          '--warning',

          required=True,

          type=int,

          help='Integer warning level to output'

        )

        self.parser.add_argument(

          '-m',

          '--message',

          default=None,

          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:

          self.ok(self.options.message)

        elif self.options.warning == 1:

          self.warning(self.options.message)

        elif self.options.warning == 2:

          self.critical(self.options.message)

        else:

          self.unknown(self.options.message)

    if __name__ == "__main__":

      f = MyCheck()

## Remote (JIT) Checks

To submit checks on behalf of another system, import push_event:

    from sensu_plugin.pushevent import push_event

Then use with:

    push_event(source="a_remote_host", check_name="MyCheckName", exit_code=2, message="My check has failed")

This will submit a check result (a failure) appearing to come from the remote host 'a_remote_host', for check 'MyCheckName'.

The default assumption is that there is a local sensu client running on port 3030, but you can override this by passing in sensu_client_host and sensu_client_port parameters.

The check submits the check in json format.  Arbitrary extra fields can be added, e.g.

    push_event(source="a_remote_host", check_name="MyCheckName", exit_code=2, message="My check has failed", team="MyTeam")

## Metrics

For a metric you can subclass one of the following;

* SensuPluginMetricGraphite

* SensuPluginMetricInfluxdb

* SensuPluginMetricJSON

* SensuPluginMetricStatsd

### Graphite

    from sensu_plugin import SensuPluginMetricGraphite

    class MyGraphiteMetric (SensuPluginMetricGraphite):

        def run(self):

            self.ok('sensu', 1)

    if __name__ == "__main__":

        metric = MyGraphiteMetric()

### Influxdb

    from sensu_plugin import SensuPluginMetricInfluxdb

    class MyInfluxdbMetric (SensuPluginMetricInfluxdb):

        def run(self):

            self.ok('sensu', 'baz=42', 'env=prod,location=us-midwest')

    if __name__ == "__main__":

        metric = MyInfluxdbMetric()

### JSON

    from sensu_plugin import SensuPluginMetricJSON

    class MyJSONMetric(OLDSensuPluginMetricJSON):

        def run(self):

            self.ok({'foo': 1, 'bar': 'anything'})

    if __name__ == "__main__":

        metric = MyJSONMetric()

### StatsD

    from sensu_plugin import SensuPluginMetricStatsd

    class MyStatsdMetric(SensuPluginMetricStatsd):

        def run(self):

            self.ok('sensu.baz', 42, 'g')

    if __name__ == "__main__":

        metric = MyStatsdMetric()

## License

* Based heavily on [sensu-plugin](https://github.com/sensu/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