heartbeat.sh

A shell script client for heartbeat.sh

Usage

To set up the environment for the heartbeat script, run source setup.sh {your-subdomain}. You might want to add this line to your profile.

If you've run the setup, you can send heartbeats to heartbeat.sh with ./heartbeat.sh name [options].

The options are:

• -w --warning To specify the warning timeout.
• -e --error To specify the error timeout.
• -d --delete To delete a heartbeat.

For example: ./heartbeat.sh example:shell --error 1d -w 12h will send a heartbeat named example:shell, and set its timeouts to 12 hours and 1 day for warnings and errors respectively.

Please note:

• The name is treated as a unique identifier. Sending a heartbeat to a non-existing name will create it.
• The timeout format is [1d][1h][1m][1[s]]. You can replace 1 with any integer.
• The specified days, hours, and minutes always get converted to seconds. The conversion is not aware of timezones or leap seconds.
• The conversion algorithm is pretty lenient. 1d, 1D, 1days, 1DaYes, and 1doggo will all be converted to 86400 seconds.
• If no timeouts are specified, the warning timeout will default to 1 minute for new heartbeats, or the existing timeout for existing heartbeats.
• If only the warning is specified, the error timeout will default to 5 times the warning timeout for new heartbeats, or the existing timeout for existing heartbeats.