Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gpulido/SwarmAlert
Monitor docker Swarm services and sends a pushover notification if anyone is down
https://github.com/gpulido/SwarmAlert
devops docker monitoring pushover-notifications python swarm-mode
Last synced: about 2 months ago
JSON representation
Monitor docker Swarm services and sends a pushover notification if anyone is down
- Host: GitHub
- URL: https://github.com/gpulido/SwarmAlert
- Owner: gpulido
- License: other
- Created: 2019-03-06T22:54:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-27T12:17:14.000Z (about 5 years ago)
- Last Synced: 2024-07-31T21:55:15.978Z (5 months ago)
- Topics: devops, docker, monitoring, pushover-notifications, python, swarm-mode
- Language: Python
- Size: 35.2 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-docker - SwarmAlert - Monitors a Docker Swarm and sends Pushover alerts when it finds a container with no healthy service task running. (Container Operations / Monitoring)
- awesome-docker - SwarmAlert - Monitors a Docker Swarm and sends Pushover alerts when it finds a container with no healthy service task running. (Container Operations / Monitoring)
README
[](https://cloud.docker.com/u/gpulidodt/repository/docker/gpulidodt/swarm-alert)
[](https://996.icu/#/en_US)
[](https://github.com/gpulido/SwarmAlert/blob/master/LICENSE)
[](https://github.com/996icu/996.ICU/blob/master/LICENSE)
# Introduction
The SwarmAlert app monitors the availability of services running in a Docker Swarm environment.
It offers an optional WHITELIST of services to monitor. If a WHITELIST is not defined, ALL services in the Swarm are monitored by default.
An optional BLACKLIST is also configurable, and takes precedence over the whitelist and defaults. This is to allow you to use the BLACKLIST to avoid receiving alerts while doing planned maintenance. The app checks every CHECK_INTERVAL seconds. Upon checking, if a specified service has no running task, the app generates a Notification that is send to the services configured on the config.yml file.
More information about the config.yml format is available on the apprise repository: [apprise config yaml file reference](https://github.com/caronc/apprise/wiki/config_yaml)
The Msg_Prefix is used to customize the message send to the notification providers.
Note: This project is based on [monitor-docker-slack](https://github.com/DennyZhang/monitor-docker-slack)
# General Idea
1. Run one or more services in Docker Swarm mode.
2. Start this service to monitor the availability of other services.
3. Monitor services each CHECK_INTERVAL seconds for services with no running containers.
4. Send a pushover notifications containing the unavailable services.
# Usage: Docker-compose
```
version: '3'
services:
swarm-alert:
image: gpulidodt/swarm-alert:latest
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /path_to_config/config.yml:/src/config.yml
environment:
- PUSHOVER_USER_KEY: user_key_from_pushover
- PUSHOVER_API_TOKEN: your_app_token_from_pushover
- MSG_PREFIX: '$MSG_PREFIX'
- WHITE_LIST: ''traefik_traefik','plex_plex','test_service''
- BLACK_LIST: ''test_service''
- LOGGING_LEVEL: INFO | DEBUG
```
# Further customization
- Customize the message prefix for the Pushover Notification via the MSG_PREFIG variable:
```
- MSG_PREFIX="Swarm services"
```
- If defined, the services that are monitored are those on the WHITE_LISTE_LIST variable:
```
- WHITE_LIST="nodeexporter,ngin.*"
```
- If defined, the services defined on the BLACK_LIST are excluded from monitoring:
```
- BLACK_LIST="nodeexporter,ngin.*"
```
- Logging capabilities are included, it is set as INFO level by default, can be increased to DEBUG using the LOGGIN_LEVEL env variable.
Code is licensed under MIT license