Skip to main content

This is a client to interact with the Sensu API

Project description

https://badge.fury.io/py/pysensu-ng.svg https://travis-ci.org/sangoma/pysensu.png?branch=master https://pypip.in/d/pysensu-ng/badge.png

This is a client to interact with the Sensu API

Features

  • Includes methods for some entrypoints (clients, events, checks, stashes) of the Sensu API (0.24) IMPORTANT: from 0.6.0 release we are supporting Sensu API 0.24+ .. backward compatibility with previous versions of Sensu API might be broken.

  • Includes methods for handle subscriptions info (nodes subscribed to a specific channel)

Trivial Example

from pysensu.api import SensuAPI

url = 'http://localhost:4567'
my_sensu = SensuAPI(url, username=username, password=password)
print(my_sensu.get_info())

DEBUG

To enable debug import logging module and set the debug level

import logging
logging.getLogger('pysensu.api').setLevel(logging.DEBUG)

Exceptions

You can handle an exception using a code like this. Note: Sensu API give you a 404 code if a client does not exists.

import pysensu.api

url = 'http://localhost:4567'
my_sensu = pysensu.api.SensuAPI(url)
client = "testclient"

try:
    print(my_sensu.get_client_data(client))
except pysensu.api.SensuAPIException as e:
    if "404" in str(e):
        print("{} does not exists on sensu api".format(client))
    else:
        raise e

Documentation

The full documentation is at http://pysensu.rtfd.org.

History

0.13.0 (2019-07-23)

0.10.0 (2017-05-17)

  • Add support for results API

0.9.0 (2017-03-13)

  • Add support for silenced API

0.8.0 (2016-11-28)

  • Added operations for Aggregates and Status (Health/Info)

  • Added support for optional limit/offset parameters to get_clients

  • Modified post_check_request to work properly with subscribers.

0.7.0 (2016-08-17)

  • Fix adding stashes

0.6.0 (2016-08-02)

  • Fix calls to Sensu API entrypoints in order to make them compatible with lastest version of Sensu API (0.24) previous versions of Sensu API might not behave as expected.

0.1.0 (2015-12-15)

  • First release on PyPI.

Project details


Download files

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

Source Distribution

pysensu-ng-0.13.0.tar.gz (7.2 kB view hashes)

Uploaded source

Built Distribution

pysensu_ng-0.13.0-py2.py3-none-any.whl (6.1 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page