msfjarvis/healthchecks-rs

Simple Rust library to interact with healthchecks.io

healthchecks-rs's Issues

Improve pinging reliability

https://healthchecks.io/docs/reliability_tips/

Implement support for V2 APIs

https://github.com/healthchecks/healthchecks/releases/tag/v2.6

Add errors section to `healthchecks` rustdoc

https://rust-lang.github.io/rust-clippy/master/index.html#missing_errors_doc

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (github>msfjarvis/.github//renovate/rust)

Switch to clap's derive-based configuration

It is more type-safe and allows idiomatic access of values (opts.check_id vs matches.value_of("check_id").unwrap()).

Clap documentation

Restore retry mechanism from healthchecks v1

The healthchecks library upgraded to ureq 2.0 as part of the healthchecks 2.0 release, missing a crucial feature: retries. The pings module still contains remnants of that code. Bringing it back is a nice to have option for resilience.

Replace `chrono` with `time`

The time crate has gotten all the functionality we need so chrono no longer needs to exist as an abstraction between us and time.

Add a binary crate for admin APIs

A simple CLI tool that reads an API key from the environment and is able to list checks with their last pings is good enough as a start.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Branch Automerge

These updates await pending status checks before automerging. Click on a checkbox to abort the branch automerge, and create a PR instead.

• chore(deps): lock file maintenance

Detected dependencies

cargo

Cargo.toml

• clap 4.5.4
• color-eyre 0.6.3
• uuid 1.8.0

hcctl/Cargo.toml

• comfy-table 7.1.1
• time 0.3.36
• time 0.3.36

healthchecks/Cargo.toml

• serde 1.0.200
• serde_derive 1.0.200
• serde_json 1.0.116
• ureq 2.9.7

monitor/Cargo.toml

• subprocess 0.2.9

github-actions

.github/workflows/flake-lock-maintenance.yml

---

• Check this box to trigger a request for Renovate to run again on this repository

Support uploading log snippets

The pinging APIs also have support for additional parameters such as including logs for analysis, and we should try and support this case.

Add support for installation through Nix

Support cron-backed jobs

I currently use hcctl to monitor sync jobs and have them run by cron from the distro. Using a cron parser it should be possible to implement a scheduler within hcctl. Steps to completion would roughly be:

1. Add a cron expression parser (preferably a library dependency) and wire up the CLI to accept and validate it as input
2. Add support for running a task and sleeping till the next run as decided by the cron expression

Implement search in `hcctl pings`

f0c9c45 implemented hcctl search <search-term> which gets a list of pings from healthchecks, matches the search term against them and then prints the results.

This can be extended to create a variant of hcctl pings <UUID> that looks like hcctl pings <search-term>, by trying to parse the argument as a UUID, and falling back to hcctl search's logic if the value is not a valid UUID.

Add remaining admin APIs

As noted in the healthchecks README, there are a couple remaining admin APIs that should be relatively straightforward to add.

Resources:

• API docs
• Transform tools (to convert JSON to a serde compatible struct)