Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PulseInnovations/prometheus-deadmansswitch
An AWS Lambda function to alert to Slack when Prometheus is offline
https://github.com/PulseInnovations/prometheus-deadmansswitch
Last synced: 3 months ago
JSON representation
An AWS Lambda function to alert to Slack when Prometheus is offline
- Host: GitHub
- URL: https://github.com/PulseInnovations/prometheus-deadmansswitch
- Owner: PulseInnovations
- License: mit
- Created: 2020-07-25T18:58:22.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-15T19:33:45.000Z (about 3 years ago)
- Last Synced: 2024-05-30T01:03:47.784Z (6 months ago)
- Language: Python
- Size: 18.6 KB
- Stars: 8
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Prometheus Dead Man's Switch
Deploys a couple of Lambda functions which receive the `Watchdog` webhook from Prometheus/AlertManager and alert to a Slack channel if a Prometheus instance hasn't been heard from for over 5 minutes.
It uses API Gateway, DynamoDB and Lambda.
- `api.py` is the Lambda responsible for receiving the webhook POST requests and storing the timestamp for each cluster in DynamoDB.
- `checker.py` is run in a schedule and checks if any of the timestamps in DynamoDB are more than 5 minutes in the past.
## Deployment
1. Install the [Serverless Framework](https://github.com/serverless/serverless), python3 and pip
2. Install the dependencies with `pip3 install -t vendored/ -r requirements.txt`
3. Run the deploy command:
```
sls deploy --region eu-west-1 --bucket your-bucket --verify-token YOUROWNVERIFYTOKEN --slack-channel your-slack-channel --slack-token your-slack-bot-token
```
Where:
- `region` is your chosen AWS region
- `bucket` is a pre-existing S3 bucket where the Serverless Framework can store state
- `verify-token` is a made up token which matches your Alert Manager configuration (see below)
- `slack-channel` is the name of your Slack channel
- `slack-token` is a Slack bot token with access to post to the Slack channel ([see the Slack documentation](https://api.slack.com/authentication/basics#calling))
## Alert Manager configuration
For this to work you must first have a `Watchdog` Prometheus Rule like in [coreos/kube-prometheus](https://github.com/coreos/kube-prometheus/blob/master/examples/existingrule.yaml) or the one which gets installed by default in the [prometheus-community/kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/blob/d6f10fef4e92f948131f39743beac9019eb20958/charts/kube-prometheus-stack/templates/prometheus/rules/general.rules.yaml#L37) Helm Chart. See [cablespaghetti/k3s-monitoring](https://github.com/cablespaghetti/k3s-monitoring) for a quick start guide which will set up Prometheus to work with this function.
Example receiver configuration:
```
- name: prometheus_deadmansswitch
webhook_configs:
- url: "https://example.execute-api.us-east-1.amazonaws.com/prod/my-cluster-name?verify_token=YOUROWNVERIFYTOKEN"
```
This URL will be output by the `sls deploy` command above.
Example route configuration:
```
routes:
- match:
alertname: Watchdog
receiver: prometheus_deadmansswitch
repeat_interval: 1m
```