Metadata-Version: 1.1
Name: grafana-alerts
Version: 1.0.0.dev5
Summary: Alerting Module to use with Grafana metrics.
Home-page: https://github.com/pabloa/grafana-alerts
Author: Pablo Alcaraz
Author-email: pabloa98@gmail.com
License: Apache License 2.0
Description: Grafana Alert Module
        ====================
        
        Collects stats from a grafana server based in information available
        in Grafana Dashboards, compare those values to an alert table and
        throws alert emails in case it is needed.
        
        Sites
        -----
        
        Installation package: https://pypi.python.org/pypi/grafana_alerts
        
        Project Home: https://github.com/pabloa/grafana-alerts
        
        Issues amd bugs: https://github.com/pabloa/grafana-alerts/issues
        
        
        Installation
        ------------
        ::
        
            sudo pip install grafana-alerts
        
        if you get an error, perhaps it is because the version available is a development
        version. In this case try with::
        
            sudo pip install --pre grafana-alerts
        
        
        
        Configuration
        -------------
        
        Create a file /etc/grafana_alerts/grafana_alerts.cfg
        with::
        
            #
            # Grafana alerts configuration file.
            #
        
            # The URL where grafana server is listening. It must finish with the character '/' (default value: http://localhost:3130)
            grafana_url = http://yourgrafanaserver.com/grafana/
        
            # Grafana token with viewer access (default value: empty string)
            grafana_token = qwertysDssdsfsfsdfSFsfsfEWrwrwERwrewrwrWeRwRwerWRwERwerWRwerweRwrEWrWErwerWeRwRwrewerr==
        
            # email to use as alert sender (default value: grafana-alert@localhost)
            email_from = alert@example.com
        
            # smtp server to use (default value: localhost)
            smtp_server = localhost
        
            # smtp server host to use (default value: 25)
            # if port is not 25, starts a tls session.
            smtp_port = 25
        
            # smtp server username to use if it is needed. Optional. Leave it commented if not used. (default value: no username)
            #smtp_username = my_smtp_username
        
            # smtp server password to use if it is needed. Optional. Leave it commented if not used. (default value: no password)
            #smtp_password = my_smtp_password
        
        
        Add a cron task to execute grafana_alerts for example each 3 minutes:::
        
            */3 * * * *     grafana_alerts
        
        
        Monitoring Dashboards
        ---------------------
        
        Dashboards to be monitored for alerts must be marked with the tag "monitored"
        
        In each monitored Dashboard, add a text panel with title 'alerts' and a description of your alerts. For example:::
        
            50<=x<=100; normal; server@example.com
        
            35<x<50; warning; server-mantainers@example.com
        
            x<=35; critical; server-mantainers@example.com, sysop@example.com
        
        
        Notes:
        
        * values depend of the graph in that dashboard.
        * x is mandatory.
        
        Here is an example: 
        
        https://drive.google.com/a/ailive.net/file/d/0B1LiPvzYYFN0TTlBRnFlTG5Ya1E/view?pli=1
        
        
        
        
Keywords: grafana alerts grafana_alerts grafana-alerts monitoring cluster
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Internet :: Log Analysis
Classifier: Topic :: System :: Clustering
Classifier: Topic :: System :: Monitoring
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: AIX
Classifier: Operating System :: POSIX :: BSD
Classifier: Operating System :: POSIX :: BSD :: BSD/OS
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Operating System :: POSIX :: BSD :: NetBSD
Classifier: Operating System :: POSIX :: BSD :: OpenBSD
Classifier: Operating System :: POSIX :: GNU Hurd
Classifier: Operating System :: POSIX :: HP-UX
Classifier: Operating System :: POSIX :: IRIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: Other
Classifier: Operating System :: POSIX :: SunOS/Solaris
Classifier: Operating System :: Unix
