HealthChecks

HealthChecks is a way for systems to periodically check in. This allows operators to be aware they are still functioning or are alive. HealthChecks have a range of uses from ensuring services are still running, jobs are being executed like backups or a server is still online.

Monitoring with HealthChecks

Unlike the other monitors HealthChecks are inbound requests to the platform. For a HealthCheck to work you'll need a URI to call in order to send requests to our system. Navigate to the HealthChecks page to create new endpoints.

How to send HealthChecks to the platform

You can send requests in many ways to the platform either through your own application, scripts or web-hooks. HealthCheck endpoints require a valid JSON payload with:

Format

struct HealthCheckPostResult {
    state: bool,
    message: String
}

Example

{
    "state": true
    "message": "Successfully backed up database"
}

Adding A HealthCheck monitor

As HealthChecks are inbound requests to the platform, when creating a healthcheck you will be given a uniqe URL to make calls to.
This is normally in the form of https://hc.pingsphere.io/<UUID>

You're able to add a single HealthCheck with a name, description and timeout (in seconds). The purpose of the timeout is for alerting if your healthcheck has not called in for that period of time and an Alert Rule has been configured then it will let you know.

Checking HealthCheck state

After a little while of sending the first check-in you will be able to see metrics and messages coming in. Using the action buttons to the right of your HealthCheck to view, edit or delete any monitor.

Conclusion

Adding HealthCheck monitor is a great way to get insight into internal processes. We use HealthChecks to track CI, deployments, backups and jobs. Doing so provides some quick insight into if something is running, when and what state it is in.

---