hea
healthchecks
cargo install healthchecks
hea

healthchecks

Simple Rust library to interact with healthchecks.io

by Harsh Shandilya

3.1.0 (see all)License:MIT/Apache-2.0
cargo install healthchecks
Readme

healthchecks-rs

A simple Rust library that allows pinging healthchecks.io to indicate success or failure of a task.

Supported API methods

Pinging API

  • Signal success
  • Signal failure
  • Signal start

Management API

  • Get a list of all checks
  • Get a single check
  • Create a new check
  • Update an existing check
  • Pause monitoring of a check
  • Delete check
  • Get a list of check's logged pings
  • Get a list of check's status changes
  • Get a list of existing integrations

Usage (pinging API)

use healthchecks::ping::get_client;


fn main() {
let config = get_client("073305d2-3582-4dd6-b6a3-425e88583ca2").unwrap();
config.report_failure();
config.report_success();
}

fn main() { let config = get_client("073305d2-3582-4dd6-b6a3-425e88583ca2").unwrap(); config.report_failure(); config.report_success(); }

If you want to set a custom user agent for filtering purposes (default is healthcheck-rs/$library_version)

use healthchecks::ping::get_client;


fn main() {
let config = get_client("073305d2-3582-4dd6-b6a3-425e88583ca2").unwrap().set_user_agent("very-fancy-useragent");
config.report_failure();
config.report_success();
}


You can also start a timer to record durations on healthchecks.io.

use healthchecks::ping::get_client;


fn do_long_running_task() {}




fn main() {
let config = get_client("073305d2-3582-4dd6-b6a3-425e88583ca2").unwrap();
config.start_timer();
do_long_running_task();
config.report_success();
}


Minimum supported Rust Version

healthchecks' MSRV is 1.59.0

Licensing

Dual licensed under Apache 2.0 or MIT at your option.

GitHub Stars

14

LAST COMMIT

1mo ago

MAINTAINERS

1

CONTRIBUTORS

10

OPEN ISSUES

1

OPEN PRs

0
VersionTagPublished
3.1.0
17d ago
3.0.6
1mo ago
3.0.5
2mos ago
3.0.4
4mos ago
No alternatives found
No tutorials found
Add a tutorial