denoz/health-check

一个包含用于输出用于监控系统json信息的工具库。

1.0.0-beta 2023-03-03 16:45 UTC

This package is auto-updated.

Last update: 2024-09-30 01:57:34 UTC


README

GitHub issues Build Status GitHub GitHub release (latest by date) Packagist PHP Version Support

此包包含一个标准化的格式,便于进行监控检查。

工具将以以下格式生成输出。

{
    "status":"OK",
    "applicationName":"foo-service",
    "version":"1.1",
    "environment":"prod"
}

您需要手动设置 状态

以下信息将自动检测。

  • GIT 版本
  • 开发环境(例如:dev、test、prod)
  • 应用程序名称

如果...

  • ...服务器已安装git
  • ...应用程序本身是git仓库

安装

composer require dennzo/monitoring-tools

用法

使用 MonitoringTools 类将此功能实现到您的应用程序中。

根据您的应用程序,您可能需要创建 MonitoringController 并定义一个 health_check 路由。

// Json
MonitoringTools::provideHealthCheckAsJson();

// Object
MonitoringTools::provideHealthCheckAsObject();

您可以在这里找到更多示例和说明。

默认值