Skip to content

heartbeat-sh/documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 

Repository files navigation

Have you been blocked recently?

Please contact admin@heartbeat.sh to discuss possible limits and/or abusive ping timeouts.

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:

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.