A Laravel wrapper for healthchecks.io
Healthchecks.io is a service that monitors your cron jobs and alerts you when they are down. This package is a wrapper for the Healthchecks.io API.
Installation
You can install the package via composer:
composer require bowero/laravel-healthchecks
You then need to publish the configuration file:
php artisan vendor:publish --tag="laravel-healthchecks-config"
This is the contents of the published config file:
return [
/*
* The URL endpoint of healthchecks.io
*/
'url' => 'https://hc-ping.com/',
/*
* Your registered jobs
*/
'jobs' => [
'my-first-check' => [
'uuid' => 'c2c0be0a-94fa-4128-aa8a-cd55889cdb29',
],
],
];
That's it! you can now use the package in your Laravel application. It is automatically registered in your service provider.
Usage
use Bowero\Healthchecks\Facades\Healthchecks;
/*
* Create a job
* (the job is registered in healthchecks.php)
*/
$job = Healthchecks::job('my-first-check');
/*
* Create a job based on the uuid
*/
$job = Healthchecks::uuid('c2c0be0a-94fa-4128-aa8a-cd55889cdb29');
/*
* Mark the job as started
*/
$job->start();
/*
* Mark the job as succesful
*/
$job->success();
/*
* Mark the job as failed
*/
$job->failure();
/*
* Mark the job as exited with a status code
*/
$job->exitWithStatus(1);
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.
2 Feb 16, 2022
1.2k Jan 2, 2023
3 Aug 7, 2022
10 Nov 29, 2022
22 Nov 17, 2022
11 Aug 21, 2022
29 Nov 27, 2022
112 Jan 4, 2023
4 Nov 29, 2022
8 Sep 9, 2018
1 Nov 1, 2021
24 Jun 24, 2022
244 Jan 3, 2023
155 Dec 14, 2022
97 Dec 22, 2022
5.6k Dec 25, 2022
189 Dec 26, 2022
618 Dec 12, 2022