Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Swatto/promtotwilio
Send text messages for Prometheus alerts using Twilio
https://github.com/Swatto/promtotwilio
alert alertmanager prometheus prometheus-alert twilio
Last synced: 3 months ago
JSON representation
Send text messages for Prometheus alerts using Twilio
- Host: GitHub
- URL: https://github.com/Swatto/promtotwilio
- Owner: Swatto
- License: mit
- Created: 2016-03-21T10:41:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T13:12:50.000Z (over 1 year ago)
- Last Synced: 2024-06-21T00:30:16.394Z (5 months ago)
- Topics: alert, alertmanager, prometheus, prometheus-alert, twilio
- Language: Go
- Homepage:
- Size: 1.02 MB
- Stars: 32
- Watchers: 4
- Forks: 20
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-twilio-golang - Swatto/promtotwilio
README
# Prometheus alert with text message
This is a simple and stupid program that will receive webhooks from [Prometheus](https://prometheus.io/) to send them as text message (using [Twilio](https://www.twilio.com/)) with the summary of the alert.
The [Docker image](https://hub.docker.com/r/swatto/promtotwilio/) size is less than 9MB.
## Configuration
It needs 4 environment variables:
- `SID` - Twilio Account SID
- `TOKEN` - Twilio Auth Token
- `RECEIVER` - Phone number of receiver (optional parameter, representing default receiver)
- `SENDER` - Phone number managed by Twilio (friendly name)
You can see a basic launch inside the Makefile.
## API
`/`: ping promtotwilio application. Returns 200 OK if application works fine.
`/send?receiver=`: send Prometheus firing alerts from payload to a rcv if specified, or to default receiver, represented by RECEIVER environment variable. If none is specified, status code 400 BadRequest is returned.
## Test it
To send test sms to a phone +zxxxyyyyyyy use the following command (please notice `%2B` symbols, representing a url encoded `+` sign)
```bash
$ curl -H "Content-Type: application/json" -X POST -d \
'{"version":"2","status":"firing","alerts":[{"annotations":{"summary":"Server down"},"startsAt":"2016-03-19T05:54:01Z"}]}' \
http://localhost:9090/send?receiver=%2Bzxxxyyyyyyy
```
## Configuration example
Here's a sample Docker Compose file to use it with [cAdvisor](https://github.com/google/cadvisor), [Prometheus](http://prometheus.io/), [Alertmanager](https://github.com/prometheus/alertmanager) and [Grafana](https://github.com/grafana/grafana).
```yml
sms:
image: swatto/promtotwilio:latest
environment:
SID: xxx
TOKEN: xxx
RECEIVER: xxx
SENDER: xxx
alert:
image: prom/alertmanager:latest
links:
- sms
volumes:
- ./alertmanager.yml:/etc/alertmanager/config.yml
container:
image: google/cadvisor:latest
volumes:
- /:/rootfs:ro
- /var/run:/var/run:rw
- /sys:/sys:ro
- /var/lib/docker/:/var/lib/docker:ro
prometheus:
image: prom/prometheus:latest
links:
- container
- alert
volumes:
- ./prometheus.yml:/etc/prometheus/prometheus.yml
- ./alerts.conf:/etc/prometheus/alerts.conf
entrypoint: /bin/prometheus -config.file=/etc/prometheus/prometheus.yml -alertmanager.url=http://alert:9093
web:
image: grafana/grafana:latest
links:
- prometheus
ports:
- "3000:3000"
environment:
GF_SERVER_ROOT_URL: http://stats.example.com
GF_SECURITY_ADMIN_PASSWORD: 123456
```
Here's the AlertManager config where `sms` will be provided by Docker Compose
```yml
route:
receiver: 'admin'
receivers:
- name: 'admin'
webhook_configs:
- url: 'http://sms:9090/send'
```