1 unstable release
0.1.0 | Feb 20, 2022 |
---|
#5 in #heartbeat
20KB
64 lines
Heartbeat
This is a quite simple server to check if another server is still alive.
What is a heartbeat? Wikipedia
You can register your service and the heartbeat checker will send a telegram message if it does not get heartbeats.
Installation
There are two ways to install it:
Directly
- clone the repository
- run
cargo install --path .
- run
heartbeat
Docker
- clone the repository (
docker pull ondolin/heartbeat
) - Start the container with:
docker run \
-e TELEGRAM_TARGET_CHAT=<chat id> \
-e TELEGRAM_BOT_TOKEN=<telegram token> \
-e ROCKET_ADDRESS=0.0.0.0 \
-e POLL_RATE=10 \
-e DEFAULT_TIMEOUT=120 \
-p <your desired port>:8000 \
--name heartbeat \
--rm -d \
ondolin/heartbeat
Usage
There are several routes to interact with the heartbeat server.
/online
: check if the heartbeat server is online/report/<user>/<service_id>?<timeout>
:user
: the user to reportservice_id
: the service to report (to make is secure choose a random id)timeout
: the timeout in seconds, until the service is considers you offline
Contribute
Feel free to contribute to this project by creating issues and pull requests. I am thankful for all your work.
Dependencies
~17–48MB
~832K SLoC