io-digital/health-check

此包已被废弃,不再维护。没有建议的替代包。

一个对您的应用程序执行健康检查的Laravel包

v0.3 2017-07-26 15:33 UTC

This package is not auto-updated.

Last update: 2021-05-01 10:15:01 UTC


README

Latest Version on Packagist Software License Total Downloads

HealthCheck为您的Laravel应用程序提供了一个/healthcheck端点,使其更容易查看应用程序的状态。

安装

支持Laravel的包自动发现

通过Composer

$ composer require io-digital/health-check

将ServiceProvider添加到您的config/app.php的providers数组中

IoDigital\HealthCheck\HealthCheckServiceProvider::class,

然后运行以下Artisan命令

$ php artisan vendor:publish --provider="IoDigital\HealthCheck\HealthCheckServiceProvider" 

这将发布包配置文件到config/healthcheck.php

您目前可以选择要执行哪些测试

'ssl' => true,
'database' => true,
'application' => true,

//System information
'memory' => false,
'cpu_usage' => false,

使用方法

该包自动将/healthcheck端点添加到您的应用程序中。您只需访问该路由即可。

目前端点返回以下内容

  • 200响应
  • 以下格式的JSON对象
{
    "application": {
        "message": "Application is running",
        "success": true
    },
    "database": {
        "message": "There was an error connecting to the database. Error has been logged.",
        "success": false
    },
    "ssl": {
        "message": "SSL is working.",
        "success": true 
    }
}

未来的版本将有望扩展测试内容。

变更日志

请参阅CHANGELOG以获取最近更改的详细信息。

测试

$ composer test

贡献

请参阅CONTRIBUTINGCONDUCT以获取详细信息。

安全

如果您发现任何安全相关的问题,请通过电子邮件:author_email联系,而不是使用问题跟踪器。

许可

MIT许可(MIT)。请参阅许可文件以获取更多信息。