kopia lustrzana https://github.com/tmsmr/xmpp-webhook
560480354f
|
||
|---|---|---|
| dev | ||
| parser | ||
| .gitignore | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| THIRD-PARTY-NOTICES | ||
| go.mod | ||
| go.sum | ||
| handler.go | ||
| main.go | ||
| xmpp-webhook.service | ||
README.md
xmpp-webhook
- Multipurpose XMPP-Webhook (Built for Prometheus/Grafana Alerts)
- Based on https://github.com/atomatt/go-xmpp
Status
xmpp-webhook currently only provides a hook for Grafana. I will implement a . Check https://github.com/opthomas-prime/xmpp-webhook/blob/master/handler.go to learn how to support more source services.parserFunc for Prometheus ASAP
Usage
xmpp-webhookis configured via environment variables:XMPP_ID- The JID we want to useXMPP_PASS- The passwordXMPP_RECEIVERS- Comma-seperated list of JID'sXMPP_SKIP_VERIFY- Skip TLS verification (Optional)XMPP_OVER_TLS- Use dedicated TLS port (Optional)
- After startup,
xmpp-webhooktries to connect to the XMPP server and provides the implemented HTTP enpoints (on:4321). e.g.:
curl -X POST -d @grafana-webhook-alert-example.json localhost:4321/grafana
- After parsing the body in the appropriate
parserFunc, the notification is then distributed to the configured receivers.
Run with Docker
Build it
- Build image:
docker build -t xmpp-webhook . - Run:
docker run -e "XMPP_ID=alerts@example.org" -e "XMPP_PASS=xxx" -e "XMPP_RECEIVERS=receiver1@example.org,receiver2@example.org" -p 4321:4321 -d --name xmpp-webhook xmpp-webhook
Use prebuilt image from Docker Hub
- Run:
docker run -e "XMPP_ID=alerts@example.org" -e "XMPP_PASS=xxx" -e "XMPP_RECEIVERS=receiver1@example.org,receiver2@example.org" -p 4321:4321 -d --name xmpp-webhook opthomasprime/xmpp-webhook:latest
Installation
IMPORTANT NOTE: For the sake of simplicity, xmpp-webhook is not reconnecting to the XMPP server after a connection-loss. If you use the provided xmpp-webhook.service - Systemd will manage the reconnect by restarting the service.
- Download and extract the latest tarball (GitHub release page)
- Install the binary:
install -D -m 744 xmpp-webhook /usr/local/bin/xmpp-webhook - Install the service:
install -D -m 644 xmpp-webhook.service /etc/systemd/system/xmpp-webhook.service - Configure XMPP credentials in
/etc/xmpp-webhook.env. e.g.:
XMPP_ID='bot@example.com'
XMPP_PASS='passw0rd'
XMPP_RECEIVERS='jdoe@example.com,ops@example.com'
- Enable and start the service:
systemctl daemon-reload
systemctl enable xmpp-webhook
systemctl start xmpp-webhook
Building
- Dependencies are managed via Go Modules (https://github.com/golang/go/wiki/Modules).
- Clone the sources
- Change in the project folder:
- Build
xmpp-webhook:go build
Need help?
Feel free to contact me!