github/sprockets.handlers.heartbeat
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.handlers.heartbeat.git synced 2024-11-28 11:19:50 +00:00
Code Issues Projects Releases Packages Wiki Activity
Expose a Tornado web application endpoint for reporting application health
2 commits 1 branch 1 tag 38 KiB
Python 100%
Find a file
johnb fe76c7f2ac Add HeartbeatHandler 
Add the `HeartbeatHandler` and associated `register_callback` function.
2014-10-13 13:36:19 -04:00
docs initial commit 2014-10-13 11:16:28 -04:00
sprockets Add HeartbeatHandler 2014-10-13 13:36:19 -04:00
.gitignore initial commit 2014-10-13 11:16:28 -04:00
.travis.yml initial commit 2014-10-13 11:16:28 -04:00
dev-requirements.txt initial commit 2014-10-13 11:16:28 -04:00
LICENSE initial commit 2014-10-13 11:16:28 -04:00
MANIFEST.in initial commit 2014-10-13 11:16:28 -04:00
README.rst Add HeartbeatHandler 2014-10-13 13:36:19 -04:00
requirements.txt initial commit 2014-10-13 11:16:28 -04:00
setup.cfg initial commit 2014-10-13 11:16:28 -04:00
setup.py initial commit 2014-10-13 11:16:28 -04:00
test-requirements.txt initial commit 2014-10-13 11:16:28 -04:00
tests.py Add HeartbeatHandler 2014-10-13 13:36:19 -04:00

README.rst 

sprockets.handlers.heartbeat
============================
A callback-based heartbeat handler

|Version| |Downloads| |Status| |Coverage| |License|

Installation
------------
``sprockets.handlers.heartbeat`` is available on the
`Python Package Index <https://pypi.python.org/pypi/sprockets.handlers.heartbeat>`_
and can be installed via ``pip`` or ``easy_install``:

.. code:: bash

  pip install sprockets.handlers.heartbeat

Documentation
-------------
https://sprocketshandlersheartbeat.readthedocs.org

Requirements
------------
-  `sprockets <https://github.com/sprockets/sprockets>`_

Example
-------
This examples demonstrates how to use ``sprockets.handlers.heartbeat`` by ...
.. code:: python

    from tornado import web

    from sprockets import handlers.heartbeat

    def check_database():
        # Verify connectivity to our database

    handlers.heartbeat.register_callback(check_database)

    app = web.Application([(r'/heartbeat', handlers.heartbeat.HeartbeatHandler)])

Version History
---------------
Available at https://sprocketshandlersheartbeat.readthedocs.org/en/latest/history.html

.. |Version| image:: https://badge.fury.io/py/sprockets.handlers.heartbeat.svg?
   :target: http://badge.fury.io/py/sprockets.handlers.heartbeat

.. |Status| image:: https://travis-ci.org/sprockets/sprockets.handlers.heartbeat.svg?branch=master
   :target: https://travis-ci.org/sprockets/sprockets.handlers.heartbeat

.. |Coverage| image:: https://img.shields.io/coveralls/sprockets/sprockets.handlers.heartbeat.svg?
   :target: https://coveralls.io/r/sprockets/sprockets.handlers.heartbeat

.. |Downloads| image:: https://pypip.in/d/sprockets.handlers.heartbeat/badge.svg?
   :target: https://pypi.python.org/pypi/sprockets.handlers.heartbeat

.. |License| image:: https://pypip.in/license/sprockets.handlers.heartbeat/badge.svg?
   :target: https://sprocketshandlersheartbeat.readthedocs.org