brilliant-packages / betteruptime-laravel
BetterUptime 监控和心跳
1.1.2
2024-07-16 02:36 UTC
Requires
- php: ^7.4 || ^8.0
- illuminate/contracts: *
- spatie/laravel-package-tools: ^1.1
Requires (Dev)
- guzzlehttp/guzzle: ^7.2
- laravel/telescope: ^4.4 || ^5.0
- orchestra/testbench: ^6.0 || ^7.0 || ^8.0
- phpunit/phpunit: ^9.3 || ^10.0 || ^11.0
- spatie/laravel-ray: ^1.9
README
此包为 BetterUptime 提供了一个路由,用于监控并将其排除在 Telescope 监控之外。
它还启用了 BetterUptime 心跳监控。
安装
您可以通过 composer 安装此包
composer require brilliant-packages/betteruptime-laravel
您可以使用以下命令发布配置文件
php artisan vendor:publish --provider="BrilliantPackages\BetterUptimeLaravel\BetterUptimeLaravelServiceProvider" --tag="betteruptime-laravel-config"
这是已发布配置文件的内容
return [ 'monitor' => [ 'enabled' => env('BETTER_UPTIME_MONITOR_ENABLED', true), 'path' => env('BETTER_UPTIME_MONITOR_PATH', 'better-uptime'), ], 'heartbeat' => [ 'enabled' => env('BETTER_UPTIME_HEARTBEAT_ENABLED', true), 'url' => env('BETTER_UPTIME_HEARTBEAT_URL'), 'minutes' => env('BETTER_UPTIME_HEARTBEAT_FREQUENCY', 5), 'retry' => [ 'count' => env('BETTER_UPTIME_HEARTBEAT_RETRY_COUNT', 5), 'delay' => env('BETTER_UPTIME_HEARTBEAT_RETRY_DELAY', 3000), ], ], ];
使用方法
监控
使用 https://{yourDomain}/better-uptime
作为 URL 创建一个 BetterUptime 监控器(您可以使用 BETTER_UPTIME_MONITOR_PATH
环境变量更改路径)。
您可以将 BetterUptime 设置为在“不可用”或“不包含关键字”时提醒您;如果选择关键字方法,请使用您应用程序的名称(APP_ENV
环境变量)或“BetterUptime”作为关键字。
要禁用路由,设置 BETTER_UPTIME_MONITOR_ENABLED=false
。
心跳
创建一个具有您期望的名称、频率和宽限期的 BetterUptime 心跳监控器。
以分钟为单位确定频率(例如,1小时 = 60,1天 = 1440 等),并设置以下环境变量
BETTER_UPTIME_HEARTBEAT_URL=https://betteruptime.com/api/v1/heartbeat/abc123
BETTER_UPTIME_HEARTBEAT_FREQUENCY=5
要禁用心跳监控,删除 BETTER_UPTIME_HEARTBEAT_URL
或设置 BETTER_UPTIME_HEARTBEAT_ENABLED=false
。
测试
composer test
变更日志
请参阅 CHANGELOG 了解最近更改的详细信息。
贡献
请参阅 CONTRIBUTING 了解详细信息。
安全漏洞
请参阅 我们的安全策略 了解如何报告安全漏洞。
鸣谢
许可协议
MIT 许可协议 (MIT)。请参阅 许可文件 了解更多信息。