{"id":16677228,"url":"https://github.com/greyblake/hellcheck","last_synced_at":"2025-09-21T20:32:21.781Z","repository":{"id":57634369,"uuid":"162843655","full_name":"greyblake/hellcheck","owner":"greyblake","description":"HTTP health checker implemented in Rust","archived":false,"fork":false,"pushed_at":"2019-01-25T21:21:21.000Z","size":147,"stargazers_count":20,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-12-28T14:47:02.089Z","etag":null,"topics":["alert","checker","checkup","health-check","healthcheck","hipchat","http","notification-service","notifications","rust","rust-lang","slack","telegram"],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greyblake.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-22T21:24:21.000Z","updated_at":"2024-11-26T22:30:31.000Z","dependencies_parsed_at":"2022-09-16T03:50:38.527Z","dependency_job_id":null,"html_url":"https://github.com/greyblake/hellcheck","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyblake%2Fhellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyblake%2Fhellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyblake%2Fhellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greyblake%2Fhellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greyblake","download_url":"https://codeload.github.com/greyblake/hellcheck/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233723968,"owners_count":18720110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alert","checker","checkup","health-check","healthcheck","hipchat","http","notification-service","notifications","rust","rust-lang","slack","telegram"],"created_at":"2024-10-12T13:25:40.000Z","updated_at":"2025-09-21T20:32:16.480Z","avatar_url":"https://github.com/greyblake.png","language":"Rust","readme":"# Hellcheck\n\nHTTP health checker.\n\n\n* [Installation](#installation)\n   * [Install with cargo](#install-with-cargo)\n* [Configuration](#configuration)\n   * [Basic configuration example](#basic-configuration-example)\n   * [Notifiers](#notifiers)\n      * [Slack notifier](#slack-notifier)\n      * [Telegram notifier](#telegram-notifier)\n      * [HipChat notifier](#hipchat-notifier)\n      * [Command notifier](#command-notifier)\n* [Start](#start)\n* [Roadmap](#roadmap)\n* [License](#license)\n* [Contributors](#contributors)\n\n\n## Installation\n\n### Install with cargo\n\nInstall system dependencies.\n\nOn Debian/Ubuntu:\n\n```sh\napt-get install libssl-dev pkg-config\n```\n\nInstall hellcheck crate:\n\n```sh\ncargo install hellcheck\n```\n\n## Configuration\n\n### Basic configuration example\n\nConfiguration file `hellcheck.yml` may have the following format:\n\n```yaml\n# Declare what has to be watched\ncheckers:\n  example:\n    url: https://www.example.com\n    notifiers: [my_team]\n  localhost8000:\n    url: http://localhost:8000\n    interval: 1500ms\n    notifiers: [my_team, sound_alarm]\n    basic_auth:\n      username: \"foo\"\n      password: \"bar\"\n\n# Declare notification channels\nnotifiers:\n  my_team:\n    type: slack\n    token: \u003cWEBHOOK_URL\u003e\n  sound_alarm:\n    type: command\n    command: [\"./custom.sh\", \"arg1\", \"arg2\"]\n```\n\n### Notifiers\n\n#### Slack notifier\n\nCreate an [incoming webhook](https://api.slack.com/incoming-webhooks) in Slack.\nThen define your notifier with type `slack` and `webhook_url`:\n\n```yaml\nnotifiers:\n  notifier_name:\n    type: slack\n    webhook_url: \u003cWEBHOOK_URL\u003e\n```\n\n#### Telegram notifier\n\nFor telegram notifier you have to create a bot with [BotFather](https://telegram.me/BotFather) and\nobtain the bot token.\n\nChat ID can be found out with [GetidsBot](https://telegram.me/getidsbot).\n\n```yaml\nnotifiers:\n  notifier_name:\n    type: telegram\n    token: \u003cBOT-TOKEN\u003e\n    chat_id: \u003cCHAT-ID\u003e\n```\n\n#### HipChat notifier\n\n```yaml\nnotifiers:\n  notifier_name:\n    type: hipchat\n    base_url: https://hipchat.com\n    token: \u003cAUTH_TOKEN\u003e\n    room_id: \u003cROOM_NAME_OR_ID\u003e\n```\n\n#### Command notifier\n\nCommand notifier allows you to invoke any shell command or custom script as notifier.\n\nExample:\n\n```yaml\nnotifiers:\n  custom:\n    type: command\n    command: [\"/path/to/custom-notifier.sh\", \"arg1\", \"arg2\"]\n```\n\nWithin the script the following environment variables are accessible:\n\n* `HELLCHECK_ID` - checker id\n* `HELLCHECK_URL` - checker URL\n* `HELLCHECK_OK`\n  * `true` - when service is up\n  * `false` - when service is down\n\n\n## Start\n\nAssuming, you have `./hellcheck.yml` in your current directory, this will start monitoring of the services,\ndescribed in `checkers` configuration sections:\n\n```\nhellcheck watch --file ./hellcheck.yml\n```\n\n## Roadmap\n\n* [x] Support notifiers\n  * [x] Command customer notifier\n  * [x] Telegram\n  * [x] HipChat\n  * [x] Slack\n* [ ] Checkers\n  * [x] Custom intervals\n  * [ ] Verify body (presence of some given text)\n  * [ ] Custom OKish HTTP status\n* [x] Use structopt/clap for nice command line interface\n* [ ] Implement `hellcheck test` command to test notifiers\n* [x] Configure CI\n  * [x] Run build/tests\n  * [x] Setup clippy lint\n  * [x] Setup rusmft\n* [x] Ensure endpoints with http basic authentication can be health checked\n* [ ] Inject credentials with env variables into yaml file\n* [ ] Allow customizable messages for notifiers\n* [ ] Allow custom scripts as checkers\n* [ ] Make pretty colorized output for console\n* [ ] Validate for unexpected panics in the code (unwrap, panic, expect, etc..)\n* [ ] Add logging\n\n## License\n\n[MIT](https://github.com/greyblake/whatlang-rs/blob/master/LICENSE) © [Sergey Potapov](http://greyblake.com/)\n\n## Contributors\n\n- [greyblake](https://github.com/greyblake) Potapov Sergey - creator, maintainer.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreyblake%2Fhellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreyblake%2Fhellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreyblake%2Fhellcheck/lists"}