Hellcheck

HTTP health checker.

Getting started

DISCLAIMER: This is a prove of concept, the project is ongoing development.

Roadmap

• [ ] Support notifiers
  • [x] command customer notifier
  • [x] telegram
  • [ ] Slack
  • [ ] HipChat
• [ ] Checkers
  • [x] Custom intervals
  • [ ] Verify body (presence of some given text)
  • [ ] Custom OKish HTTP status
• [ ] Use structopt/clap for nice command line interface
• [ ] Implement hellcheck test command to test notifiers
• [ ] Configure CI
  • [ ] Run build/tests
  • [ ] Setup clippy lint
  • [ ] Setup rusmft

Install

With cargo:

cargo install hellcheck

Configuration file

Create hellcheck.yml file:

yaml checkers: greyblake: url: https://www.greyblake.com interval: 10s notifiers: [me] localhost8000: url: http://localhost:8000 interval: 1500ms notifiers: [me, custom] notifiers: me: type: telegram token: <BOT-TOKEN> chat_id: <CHAT-ID> custom: type: command command: ["./custom.sh", "arg1", "arg2"]

Notifiers

Telegram notifier

For telegram notifier you have to create a bot with BotFather and obtain the bot token.

Chat ID can be found out with GetidsBot.

yaml notifiers: me: type: telegram token: <BOT-TOKEN> chat_id: <CHAT-ID>

Command notifier

Command notifier allows you to invoke any shell command or custom script as notifier.

Example:

yaml notifiers: custom: type: command command: ["/path/to/custom-notifier.sh", "arg1", "arg2"]

Within the script the following environment variables are accessible:

• HELLCHECK_ID - checker id
• HELLCHECK_URL - checker URL
• HELLCHECK_OK
  • true - when service is up
  • false - when service is down

Start

Assuming, you have ./hellcheck.yml in your current directory, this will start monitoring of the services, described in checkers configuration sections:

hellcheck

License

MIT © Sergey Potapov

Contributors

• greyblake Potapov Sergey - creator, maintainer.