Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rahiel/supervisor-alert
Receive notifications for supervisor process events.
https://github.com/rahiel/supervisor-alert
event-listener notifications supervisor telegram
Last synced: 3 months ago
JSON representation
Receive notifications for supervisor process events.
- Host: GitHub
- URL: https://github.com/rahiel/supervisor-alert
- Owner: rahiel
- License: apache-2.0
- Created: 2016-04-23T12:31:53.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-07-21T22:30:22.000Z (over 2 years ago)
- Last Synced: 2024-11-02T21:49:44.807Z (3 months ago)
- Topics: event-listener, notifications, supervisor, telegram
- Language: Python
- Homepage: https://www.rahielkasim.com/supervisor-alert/
- Size: 13.7 KB
- Stars: 44
- Watchers: 4
- Forks: 14
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# supervisor-alert
[](https://pypi.org/project/supervisor-alert/)
[](https://pypi.org/project/supervisor-alert/)
[](https://www.cpu.re/static/supervisor-alert/downloads-by-python-version.txt)
[](https://github.com/rahiel/supervisor-alert/blob/master/LICENSE.txt)
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][] system-wide first. You
can also use any shell command to send the notifications.
[telegram-send]: https://github.com/rahiel/telegram-send
# Installation
Install supervisor-alert on your system:
``` shell
sudo pip install supervisor-alert
```
You must install it with Python 2 because Supervisor doesn't support Python 3
yet. For Supervisor 4+ you may have Python 3 support, if `python3 -c 'import
supervisor'` doesn't give an error, you should install supervisor-alert with
pip3/python3.
Then run:
``` 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:
``` shell
[eventlistener:supervisor_alert]
command=supervisor-alert --telegram
events=PROCESS_STATE_RUNNING,PROCESS_STATE_EXITED,PROCESS_STATE_FATAL
autostart=true
autorestart=true
stdout_logfile=NONE
user=supervisor_alert
```
This will send the notifications over Telegram, to use something else, for
example [ntfy][], pass in the command:
``` shell
command=supervisor-alert -c 'ntfy send'
```
By default the config file at `/etc/telegram-send.conf` is used for
telegram-send, to use a different config, or to pass any other options:
``` shell
command=supervisor-alert -c 'telegram-send --config /home/user/bunny.conf'
```
Optionally you can show the hostname before each message with the
`--show-hostname` option:
``` shell
command=supervisor-alert --telegram --show-hostname
```
The default 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:
``` shell
sudo adduser supervisor_alert --system --no-create-home
```
Optionally, you can also subscribe to different supervisor events,
[look at the docs][events] to see on which ones you'd like to be notified.
Finally, load the config and start the event listener:
``` shell
sudo supervisorctl reread
sudo supervisorctl update
```
You should now receive your first alert, notifying you that `supervisor_alert`
has started running.
[ntfy]: https://github.com/dschep/ntfy
[events]: http://supervisord.org/events.html#event-types