Create a health check report to be verified by Oh Dear

Using Oh Dear you can monitor various aspects or your application and server. This way you could get alerts when:

disk space is running low
the database is down
Redis cannot be reached
mails cannot be sent
there are many application errors in a small timeframe (via Flare)
a reboot of your app is required
...

You can monitor any aspect of your app that you want.

Using this package you can build up the JSON that Oh Dear expects for its health check.

To learn more head over to the Application Health Monitoring docs at Oh Dear.

Installation

You can install the package via composer:

composer require ohdearapp/health-check-results

Usage

Here's an example that shows how you can create the JSON that Oh Dear expects for the health check.

$checkResults = new CheckResults(DateTime::createFromFormat('Y-m-d H:i:s', '2021-01-01 00:00:00'));

$checkResult = new CheckResult(
    name: 'UsedDiskSpace',
    label: 'Used disk space',
    notificationMessage: 'Your disk is almost full (91%)',
    shortSummary: '91%',
    status: CheckResult::STATUS_FAILED,
    meta: ['used_disk_space_percentage' => 91]
);

$checkResults->addCheckResult($checkResult);

This will output this JSON:

{
    "finishedAt": 1609459200,
    "checkResults": [
        {
            "name": "UsedDiskSpace",
            "label": "Used disk space",
            "notificationMessage": "Your disk is almost full (91%)",
            "shortSummary": "91%",
            "status": "failed",
            "meta": {
                "used_disk_space_percentage": 91
            }
        }
    ]
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

Health Check Results Laravel Package