Metadata-Version: 2.1
Name: django_informer
Version: 0.2.2
Summary: a pluggable app to monitoring your own infrastructure and third party services.
Home-page: https://github.com/rodrigobraga/informer
Author: Rodrigo Braga
Author-email: rodrigobraga@msn.com
License: MIT
Keywords: django monitoring reporting
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.4
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: check-manifest; extra == "dev"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"

Django Informer
==============

.. image:: https://img.shields.io/travis/rodrigobraga/informer.svg
    :alt: Travis CI Status
    :target: https://travis-ci.org/rodrigobraga/informer

.. image:: https://coveralls.io/repos/rodrigobraga/informer/badge.svg?branch=master&service=github
    :alt: Coverage status
    :target: https://coveralls.io/github/rodrigobraga/informer?branch=master

.. image:: https://img.shields.io/pypi/v/django-informer.svg
   :alt: PyPi page
   :target: https://pypi.python.org/pypi/django-informer

.. image:: https://img.shields.io/pypi/l/django-informer.svg
   :alt: License MIT
   :target: https://github.com/rodrigobraga/informer/blob/master/LICENSE

A pluggable app to monitoring your own infrastructure and third party services.

Quick Start
-----------------

Below a quick guide to install and run, more detailed documentation is in the `docs <docs>`_ directory.

Install Django Informer
-----------------

::

    pip install django_informer


Add to your INSTALLED_APPS
-----------------

::

    INSTALLED_APPS = (
      ...
      'informer',
    )


Set informers on settings
-----------------

::

    DJANGO_INFORMERS = (
        ('informer.checker.database', 'DatabaseInformer'),
        ('informer.checker.database', 'PostgresInformer'),
        ('informer.checker.storage', 'StorageInformer'),
        ('informer.checker.celery', 'CeleryInformer'),
        ('informer.checker.cache', 'CacheInformer'),
    )


Set interval (in minutes) between the saved results
-----------------

::

    DJANGO_INFORMER_PREVENT_SAVE_UNTIL = 5 # default is None


Include the URLconf in your project urls.py
-----------------

::

    url(r'^informer/', include('informer.urls')),


Run migrate to create the informer models
-----------------

::

    python manage.py makemigrations
    python manage.py migrate

Copy static presentation files
-----------------

::

    python manage.py collectstatic


Tests
-----------------

::

    py.test tests


Run
-----------------

Start the development server and visit http://server:port/informer/ to view monitoring results.


.. _doc: https://github.com/rodrigobraga/informer/tree/master/docs
