bowero / laravel-healthchecks

healthchecks.io 的 Laravel 封装器

v1.0.0 2022-03-09 14:06 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Healthchecks.io 是一个监控您的 cron 作业并在它们宕机时向您发出警报的服务。本包是 Healthchecks.io API 的封装。

安装

您可以通过 composer 安装此包

composer require bowero/laravel-healthchecks

然后您需要发布配置文件

php artisan vendor:publish --tag="laravel-healthchecks-config"

这是发布配置文件的内容

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',
        ],
    ],
];

就这样!现在您可以在 Laravel 应用程序中使用此包了。它将在您的服务提供者中自动注册。

用法

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);

测试

composer test

变更日志

有关最近更改的更多信息,请参阅变更日志

贡献

有关详细信息,请参阅贡献指南

安全漏洞

有关如何报告安全漏洞的详细信息,请参阅我们的安全策略

鸣谢

许可证

MIT 许可证(MIT)。有关更多信息,请参阅许可证文件