ohdearapp / health-check-results
为 Oh Dear 创建应用程序健康检查结果
1.0.1
2022-04-29 13:13 UTC
Requires
- php: ^8.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- pestphp/pest: ^1.20
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- spatie/pest-plugin-snapshots: ^1.1
- spatie/ray: ^1.28
README
使用 Oh Dear,您可以监控应用程序和服务器各个方面的状态。这样,当以下情况发生时,您会收到警报:
- 磁盘空间不足
- 数据库宕机
- 无法访问 Redis
- 无法发送邮件
- 短时间内发生大量应用程序错误(通过 Flare)
- 需要重启应用程序
- ...
您可以选择监控应用程序的任何方面。
使用此包,您可以构建 Oh Dear 健康检查所需的 JSON 数据。
要了解更多信息,请访问 Oh Dear 的应用程序健康监控文档。
安装
您可以通过 composer 安装此包
composer require ohdearapp/health-check-results
用法
以下是一个示例,展示了如何创建 Oh Dear 健康检查所需的 JSON 数据。
$checkResults = new CheckResults(DateTime::createFromFormat('Y-m-d H:i:s', '2021-01-01 00:00:00')); $checkResult = new CheckResult( name: 'UsedDiskSpace', label: 'Used disk space', notificationMessage: 'Your disk is almost full (91%)', shortSummary: '91%', status: CheckResult::STATUS_FAILED, meta: ['used_disk_space_percentage' => 91] ); $checkResults->addCheckResult($checkResult);
这将输出以下 JSON
{
"finishedAt": 1609459200,
"checkResults": [
{
"name": "UsedDiskSpace",
"label": "Used disk space",
"notificationMessage": "Your disk is almost full (91%)",
"shortSummary": "91%",
"status": "failed",
"meta": {
"used_disk_space_percentage": 91
}
}
]
}
测试
composer test
变更日志
请参阅 变更日志 以获取有关最近更改的更多信息。
贡献
请参阅 贡献指南 以获取详细信息。
安全漏洞
请参阅 我们的安全策略 了解如何报告安全漏洞。
致谢
许可
MIT 许可证(MIT)。有关更多信息,请参阅 许可文件。