heartbeat-sh/documentation

Documentation for heartbeat.sh

Heartbeat.sh Documentation

Welcome to heartbeat.sh. The easiest way, by far, to set up your own heartbeat monitoring service.

Why Heartbeat.sh?

Heartbeat.sh is a free heartbeat monitoring tool, for proactively monitoring your servers and processes. Heartbeat monitoring makes it easy to monitor processes, especially ones that run on a cron. To automate operational checks, just send a heartbeat as part of your process. It's that easy!

Getting Started

Create your own heartbeat server at heartbeat.sh. Enter a subdomain for your server, and click on create.

You can start sending your heartbeats right away. To send a heartbeat, just send a POST request to /beat/{name} on your server.

curl -X POST 'https://{subdomain}.heartbeat.sh/beat/{name}'

The server will reply with your heartbeat in JSON if everything worked okay. You can then navigate to https://{subdomain}.heartbeat.sh to see your heartbeat dashboard. The dashboard will show all your heartbeats and their states.

Heartbeat.sh is great for:

• Monitoring Scheduled Tasks
• Automating Daily Checks
• Checking performance of long running tasks
• Ensuring that locks (or other resources) get released

For more information, check out our wiki.

Client Libraries

We aim to make heartbeat monitoring as easy as possible for developers. So we are working on client libraries for most popular programming languages. We currently have these available:

• Bash Shell
• Go
• JavaScript
• Python

Community Maintained Libraries

These packages were created and are maintained by community developers, who graciously shared them with us. Please note that these libraries are unaffiliated with the heartbeat.sh organisation.

• Drupal

documentation's Issues

Feature request: Sticky header

It would be nice to have a sticky header.

position: sticky;
top: 0;
z-index: 1;

Project status?

Is this project still under active development? I just came across it and it seems useful, but I don't see a lot of recent updates. E.g. https://github.com/heartbeat-sh/documentation/wiki/Patterns hasn't been edited since 2020 and has a number of "Coming soon" entries.

Dark mode background color is misplaced

I have more heartbeats than fits on a single screen at https://rsc.heartbeat.sh/ In dark mode, when scrolling down, the dark background only applies to the first screenful of content:

I think the bg-gray-900 class should move from div.h-screen to body. Then it looks like this:

Feature request: Sort by column

Ideally, it should remember the sorting (per browser is OK, so you don't need fancy server side stuff). More specifically, I would like to sort by status, with red on top, then orange, then green.

PS: I know this is the documentation repo, but I could not find an issue tracker for the service as a whole.

Anyone can add heartbeats and remove them?

I've created an account. I've followed wiki and I've created a setup that posts heartbeats.

It seems that there is nothing to prevent anyone to create a heartbeat?

Also anyone can delete a heartbeat?

What's the login for?
Any way to limit who can beat the hearts?

Feature request: Collapse

It would be fantastic to be able to collapse groups (where groups are defined by the colons in the names) hierarchically, and see which groups are green (if all children of the group are green) or orange or red (if any child of the group is orange or red).

Alerting

Can heartbeat.sh send out email alerts when no heartbeat has been received for a while? The current documentation doesn’t mention alerts.