https://github.com/tuenti/pyflapjackevents

Pyflapjackevents is a small library that serializes Flapjack events for the Python language
https://github.com/tuenti/pyflapjackevents

Last synced: about 4 hours ago
JSON representation

Pyflapjackevents is a small library that serializes Flapjack events for the Python language

• Host: GitHub
• URL: https://github.com/tuenti/pyflapjackevents
• Owner: tuenti
• License: apache-2.0
• Created: 2015-01-05T17:01:56.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-03-04T20:10:48.000Z (over 6 years ago)
• Last Synced: 2024-11-10T20:23:31.675Z (9 days ago)
• Language: Python
• Size: 531 KB
• Stars: 7
• Watchers: 6
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
pyflapjackevents

================

==============  ===============  =========

VERSION         DOWNLOADS        TESTS

==============  ===============  =========

|pip version|   |pip downloads|  |travis|

==============  ===============  =========

pyflapjackevents is a small library that serializes `flapjack `_ events as described in it's own `Data structures `_. It's main intention is to allow sending monitor events to flapjack from python programs.

An example:

.. code-block:: python

    server = redis.Redis(host='localhost', port='6380')

    sink = FlapjackEventSink(server, 'events')

    event = FlapjackEvent(

        'test-entity',

        'test-check',

        FlapjackEvent.EVENT_SERVICE,

        FlapjackEvent.STATE_OK,

        summary = 'test-summary',

        details = 'test-details',

    )

    sink.send(event)

This would serialize the event and send it to the appropriate Redis channel for flapjack consumption.

Installation

------------

Just do::

    pip install pyflapjackevents 

or installing it from source::

    git clone https://github.com/tuenti/pyflapjackevents.git

    cd pyflapjackevents

    python setup.py install

Requirements

------------

There're no special requirements for this library.

Credits & Contact

-----------------

pyflapjackevents was created by Tuenti Technologies S.L.. You can follow Tuenti engineering team on Twitter `@tuentieng `_.

License

-------

pyflapjackevents is available under the Apache License, Version 2.0. See LICENSE file for more info.

.. |travis| image:: https://api.travis-ci.org/tuenti/pyflapjackevents.png

  :target: `Travis`_

  :alt: Travis results

.. |pip version| image:: https://pypip.in/v/pyflapjackevents/badge.png

    :target: https://pypi.python.org/pypi/pyflapjackevents

    :alt: Latest PyPI version

.. |pip downloads| image:: https://pypip.in/d/pyflapjackevents/badge.png

    :target: https://pypi.python.org/pypi/pyflapjackevents

    :alt: Number of PyPI downloads

.. _Travis: https://travis-ci.org/magmax/inception