Metadata-Version: 1.1
Name: supervisor-alert
Version: 0.4
Summary: Receive notifications for Supervisor process events.
Home-page: https://github.com/rahiel/supervisor-alert
Author: Rahiel Kasim
Author-email: rahielkasim@gmail.com
License: Apache-2.0
Description: supervisor-alert
        ================
        
        |Version| |pyversions| |License|
        
        Are you using `Supervisor <http://supervisord.org>`__ to manage
        processes on a server? With supervisor-alert you can receive messages
        when the state of your processes change. Be the first to know when your
        services die!
        
        With the default configuration supervisor-alert sends messages over
        Telegram. For this to work you need to install
        `telegram-send <https://github.com/rahiel/telegram-send>`__ system-wide
        first. You can also use any shell command to send the notifications.
        
        Installation
        ============
        
        Install supervisor-alert on your system:
        
        .. code:: shell
        
            sudo pip install supervisor-alert
        
        Then run:
        
        .. code:: shell
        
            sudo supervisor-alert --configure
        
        for the default configuration. This will send notifications over
        Telegram. Read the next section to customize or if you dislike automatic
        configurations.
        
        Manual Configuration
        ====================
        
        Create the file ``/etc/supervisor/conf.d/supervisor_alert.conf`` as
        root:
        
        .. code:: shell
        
            [eventlistener:supervisor_alert]
            command=supervisor-alert --telegram
            events=PROCESS_STATE_RUNNING,PROCESS_STATE_EXITED,PROCESS_STATE_FATAL
            autostart=true
            autorestart=true
            user=supervisor_alert
        
        This will send the notifications over Telegram, to use something else,
        for example `ntfy <https://github.com/dschep/ntfy>`__, pass in the
        command:
        
        .. code:: shell
        
            command=supervisor-alert -c 'ntfy send'
        
        This configuration will run the event listener as the user
        ``supervisor_alert``. It is a good practice to isolate services by
        running them as separate users (and avoiding running them as root). Add
        the user with:
        
        .. code:: shell
        
            sudo adduser supervisor_alert --system --no-create-home
        
        Optionally, you can also subscribe to different supervisor events, `look
        at the docs <http://supervisord.org/events.html#event-types>`__ to see
        on which ones you'd like to be notified.
        
        Finally, load the config and start the event listener:
        
        .. code:: shell
        
            sudo supervisorctl reread
            sudo supervisorctl update
        
        You should now receive your first alert, notifying you that
        ``supervisor_alert`` has started running.
        
        .. |Version| image:: https://img.shields.io/pypi/v/supervisor-alert.svg
           :target: https://pypi.python.org/pypi/supervisor-alert
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/supervisor-alert.svg
           :target: https://pypi.python.org/pypi/supervisor-alert
        .. |License| image:: https://img.shields.io/pypi/l/supervisor-alert.svg
           :target: https://github.com/rahiel/supervisor-alert/blob/master/LICENSE.txt
        
Keywords: supervisor alert event listener notify
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
