A proxy to forward messages received via HTTP to MESHTASTIC
Project description
Alertmanager webhook for meshtastic
This little Adapter receives alertmanager webhooks and sends the notifications via a over serial attached Meshtastic device to the specified nodeID.
Warning Caution: The Tests that are provided for the code in this repository are not currently updated! Also this is a quickly hacked together peace of software, that has not built any security in it at the moment. If you have the skill and the time to contribute in any way, take a look at the Contribution section
Credits
This is based on the work of https://github.com/homeworkprod/weitersager Thanks to GUVWAF for the support and thanks to the whole meshtastic team for this awsome software!
Alertmanager configuration example
receivers:
- name: 'meshtastic-webhook'
webhook_configs:
- url: http://alertmanager-meshtastic:9119/alert
send_resolved: true
config.toml example
This is an example config, that shows all of the config options.
log_level = "debug"
[http]
host = "0.0.0.0"
port = 9119
[meshtastic.connection]
tty = "/tmp/vcom0"
nodeid = 631724152
maxsendingattempts = 30
timeout = 60
docker compose service example - Hardware Serial (default)
To integrate this bridge into your composed prometheus/alertmanager cluster, this is a good startingpoint. If you plan to use a virtual serial port that is provided with socat (for example /tmp/vcom0), you have to use a volume mount instead of the device binding:
alertmanagermeshtastic:
image: apfelwurm/alertmanagermeshtastic
ports:
- 9119:9119
volumes:
- /tmp/vcom0:/tmp/vcom0
- ./alertmanager-meshtastic/config.toml:/app/config.toml
restart: always
docker compose service example - Virtual Serial
To integrate this bridge into your composed prometheus/alertmanager cluster, this is a good startingpoint. If you plan to use a virtual serial port that is provided with socat (for example /tmp/vcom0), you have to use a volume mount instead of the device binding:
alertmanagermeshtastic:
image: apfelwurm/alertmanagermeshtastic
ports:
- 9119:9119
volumes:
- /tmp/vcom0:/tmp/vcom0
- ./alertmanager-meshtastic/config.toml:/app/config.toml
restart: always
Running on docker example - Hardware Serial (default)
docker run -d --name alertmanagermeshtastic \
--device=/dev/ttyACM0 \
-v ./alertmanager-meshtastic/config.toml:/app/config.toml \
-p 9119:9119 apfelwurm/alertmanagermeshtastic:latest
Running on docker example - Virtual Serial
If you plan to use a virtual serial port that is provided with socat (for example /tmp/vcom0), you have to use a volume mount instead of the device binding:
docker run -d --name alertmanagermeshtastic \
-v /tmp/vcom0:/tmp/vcom0 \
-v ./alertmanager-meshtastic/config.toml:/app/config.toml \
-p 9119:9119 apfelwurm/alertmanagermeshtastic:latest
Contribution
This is currently a minimal implementation that supports only a single node as a receiver. If you need additional features, you are welcome to open an issue, or even better, submit a pull request. You can also take a look on the opened Issues, where i have opened some for planned features and work on them if you want. I would appreciate any help.
Example to test
You can use the test.sh or the test single.sh or the following curl command to test alertmanager-meshtastic
curl -XPOST --data '{"status":"resolved","groupLabels":{"alertname":"instance_down"},"commonAnnotations":{"description":"i-0d7188fkl90bac100 of job ec2-sp-node_exporter has been down for more than 2 minutes.","summary":"Instance i-0d7188fkl90bac100 down"},"alerts":[{"status":"resolved","labels":{"name":"olokinho01-prod","instance":"i-0d7188fkl90bac100","job":"ec2-sp-node_exporter","alertname":"instance_down","os":"linux","severity":"page"},"endsAt":"2019-07-01T16:16:19.376244942-03:00","generatorURL":"http://pmts.io:9090","startsAt":"2019-07-01T16:02:19.376245319-03:00","annotations":{"description":"i-0d7188fkl90bac100 of job ec2-sp-node_exporter has been down for more than 2 minutes.","summary":"Instance i-0d7188fkl90bac100 down"}}],"version":"4","receiver":"infra-alert","externalURL":"http://alm.io:9093","commonLabels":{"name":"olokinho01-prod","instance":"i-0d7188fkl90bac100","job":"ec2-sp-node_exporter","alertname":"instance_down","os":"linux","severity":"page"}}' http://alertmanager-meshtastic:9119/alert
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file alertmanagermeshtastic-2023.8.1.12.tar.gz
.
File metadata
- Download URL: alertmanagermeshtastic-2023.8.1.12.tar.gz
- Upload date:
- Size: 15.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f220c69b6fb42260a20ef5c3e4b87c2ee4a8e1bd9930c66b437d906470dd4bc |
|
MD5 | 77fe4e06892f1125a74704d6c94a6709 |
|
BLAKE2b-256 | 50cd1bc4053b4166c25514fcfc20babd94741709d0c999637c0f8d531bca2d4b |
File details
Details for the file alertmanagermeshtastic-2023.8.1.12-py3-none-any.whl
.
File metadata
- Download URL: alertmanagermeshtastic-2023.8.1.12-py3-none-any.whl
- Upload date:
- Size: 13.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c90c6f42e2d7c565e73471e123ab7d62c9c7753d80fe4a86823a60e46d0be8c9 |
|
MD5 | 5d56145e7935cb5aa544a3e0252d2101 |
|
BLAKE2b-256 | f43858f63a2083443b5520e2d2141cf40a7e58bcf4d118f30f4ce936c1459d3f |