gon-nl/laravel-status-endpoint

Laravel Status Endpoint 是一个 Laravel 扩展包,为您的应用程序添加简单的状态端点

1.0.0 2023-04-29 15:19 UTC

This package is auto-updated.

Last update: 2023-12-09 15:03:13 UTC


README

Laravel Status Endpoint 是一个 Laravel 扩展包,它为您的应用程序添加一个简单的 /api/status 端点,返回数据库和缓存的当前状态。

安装

您可以通过 composer 安装此扩展包

composer require gon-nl/laravel-status-endpoint

安装后,该扩展包应该会被 Laravel 自动发现。

配置

您可以通过运行以下命令来发布配置文件

php artisan vendor:publish --provider="GonNl\LaravelStatusEndpoint\LaravelStatusEndpointServiceProvider" --tag="config"

这将创建一个名为 laravel-status-endpoint.php 的新文件在您的 config 目录中。

阈值

您可以通过在配置文件中指定 database.thresholdcache.threshold 的值来配置数据库和缓存检查的警告阈值。默认值分别为 200100(以毫秒为单位)。

使用方法

安装后,您可以通过访问应用程序的 /api/status 端点来获取数据库和缓存的当前状态。该端点返回一个 JSON 响应,其结构如下

{
    "status": "OK",
    "database": 94,
    "cache": 36,
    "last_check": "2022-05-01 12:00:00",
    "last_check_human": "1 hour ago"
}

status 字段指示检查的整体状态,可以是 OKWARNINGERRORdatabasecache 字段分别指示数据库和缓存检查的执行时间(以毫秒为单位)。last_checklast_check_human 字段分别指示最后状态检查的日期和时间,以及自上次检查以来经过的时间的易读表示。

许可证

MIT 许可证(MIT)。请参阅 许可证文件 了解更多信息。