README

Laravel服务器与应用健康监控和通知器

此软件包检查应用资源是否按预期运行，并创建服务状态面板。以下是其主要特点：

高度可扩展和可配置：您可以非常容易地创建新的检查器和通知器，并且可以几乎改变它的一切。
易于配置：使用YAML作为配置文件
弹性资源检查器：如果框架正在运行并且至少有一个通知渠道，您应该会收到通知消息。
内置的通知系统：通过邮件、Slack、Telegram或其他您需要的方式获取通知。
路由：面板、JSON结果、字符串结果和资源。
可配置的面板设计。
缓存。
安排检查，以便在服务失败时自动接收通知。
在面板中直接查看应用错误消息。
对于像Envoyer这样的服务，错误时返回HTTP响应代码200和500，以跟踪您的应用健康。

内置资源

Heath为以下服务预先配置了资源检查器：

Adyen
AppKey
APIs
广播
缓存
配置缓存
证书
Checkout.com
数据库
调试模式
目录权限
磁盘空间
DocuSign
ElasticsearchConnectable
EnvExists
文件系统
框架
HealthPanel
Horizon
Http
Https
LaravelServices
延迟
LocalStorage
邮件
MailgunConnectable
MemcachedConnectable
迁移更新到最新
MixManifest
MySql
MySqlConnectable
NewrelicDeamon
NginxServer
包更新到最新
Php
PostgreSqlConnectable
PostgreSqlServer
队列
队列工作者
重启所需
Redis
RedisConnectable
RedisServer
路由缓存
S3
安全检查器
SeeTickets
Sendinblue
服务器负载
服务器变量
服务器运行时间
Sshd
Supervisor

但您还可以添加任何您需要的其他东西，您只需找到正确的检查器来使用或创建一个用于您资源的新的检查器。

面板面板

如果您有很多网站要检查，您可以使用HealthPanel检查器创建一个Health Monitor应用程序来检查所有您的远程监控器并创建一个仪表板来汇总所有网站的状态。

易于配置

创建新的资源监控器非常简单，只需在应用的config/health文件夹中创建一个新的YAML文件即可。以下是一些示例：

Amazon S3

name: S3
abbreviation: s3
checker: PragmaRX\Health\Checkers\CloudStorageChecker
notify: true
driver: s3
file: pragmarx-health-s3-testfile.txt
contents: {{ str_random(32) }}
error_message: 'Amazon S3 connection is failing.'
column_size: 4

Nginx

name: NginxServer
abbreviation: ngnxsrvr
checker: PragmaRX\Health\Checkers\ProcessChecker
command: 'pgrep %s'
method: process_count
process_name: nginx
instances:
    minimum:
        count: 4
        message: 'Process "%s" has not enough instances running: it has %s, when should have at least %s'
    maximum:
        count: 8
        message: 'Process "%s" exceeded the maximum number of running instances: it has %s, when should have at most %s'
notify: true
pid_file_missing_error_message: 'Process ID file is missing: %s.'
pid_file_missing_not_locked: 'Process ID file is not being used by any process: %s.'
column_size: 4

屏幕截图

面板

面板替代设计

如果您有很多服务要检查，您可能需要将默认的面板设计更改为使用更少的空间。

4列布局的面板

错误消息

将鼠标悬停在失败的资源上，即可立即获取错误消息

单击资源按钮，您将收到一个显示错误消息的警报

Slack通知

以下是通过Slack发送的示例通知

Artisan控制台命令

以下健康检查命令也以标准格式返回退出代码

health:panel

使用命令health:panel在控制台查看服务状态。

health:check

使用命令health:check检查所有资源并在失败时发送通知。

路由

安装后，您将能够访问以下路由

/health/panel

主面板路由。

/health/check

返回包含包所知道的所有服务的json。

/health/string

返回包含所有服务状态信息的字符串，当使用其他监控服务时很有用。

hlthFAIL-dbFAIL-filesystemOK-frmwrkOK-httpOK-httpsOK-mailOK

/health/resource/{name}

返回特定服务的json信息。

需求

PHP 7.3+
Laravel 8.0+

安装

使用Composer进行安装

composer require pragmarx/health

Laravel上的安装

将服务提供者添加到您的 config/app.php

PragmaRX\Health\ServiceProvider::class,

发布配置和视图

php artisan vendor:publish --provider="PragmaRX\Health\ServiceProvider"

点击健康面板

http://yourdomain.com/health/panel

配置所有内容

几乎所有的配置都可以在这个包中轻松完成。

面板名称
标题和消息
资源检查器
Slack图标
通知渠道
模板位置
路由和前缀
邮件服务器
缓存
调度器

配置二进制文件

某些检查器需要您配置正确的二进制文件路径才能工作。

'services' => [
    'ping' => [
        'bin' => env('HEALTH_PING_BIN', '/sbin/ping'),
    ],

    'composer' => [
        'bin' => env('HEALTH_COMPOSER_BIN', 'composer'),
    ],
],

允许Slack通知

要接收Slack通知，您需要设置入站Webhooks 并将此方法添加到您的用户模型中，并包含您的webhook。

/**
 * Route notifications for the Slack channel.
 *
 * @return string
 */
public function routeNotificationForSlack()
{
    return config('services.slack.webhook_url');
}

缓存

当健康结果被缓存时，您可以通过在URL中添加 ?flush=true 来清除缓存，以便再次处理所有资源。

http://yourdomain.com/health/panel?flush=true

事件

如果您更喜欢构建自己的通知系统，您可以选择禁用它并监听以下事件

PragmaRX\Health\Events\RaiseHealthIssue::class

广播检查器

广播检查器通过ping和pong系统完成。广播检查器将ping您的服务，并且它必须回送pong。基本上，您需要调用一个带有一些数据的URL进行回调。

Redis + Socket.io

var request = require('request');
var server = require('http').Server();
var io = require('socket.io')(server);
var Redis = require('ioredis');
var redis = new Redis();

redis.subscribe('pragmarx-health-broadcasting-channel');

redis.on('message', function (channel, message) {
    message = JSON.parse(message);

    if (message.event == 'PragmaRX\\Health\\Events\\HealthPing') {
        request.get(message.data.callbackUrl + '?data=' + JSON.stringify(message.data));
    }
});

server.listen(3000);

Pusher

<!DOCTYPE html>
<html>
    <head>
        <title>Pusher Test</title>
        <script src="https://js.pusher.com/3.2/pusher.min.js"></script>
        <script>
            var pusher = new Pusher('YOUR-PUSHER-KEY', {
                encrypted: true
            });

            var channel = pusher.subscribe('pragmarx-health-broadcasting-channel');

            channel.bind('PragmaRX\\Health\\Events\\HealthPing', function(data) {
                var request = (new XMLHttpRequest());

                request.open("GET", data.callbackUrl + '?data=' + JSON.stringify(data));

                request.send();
            });
        </script>
    </head>

    <body>
        Pusher waiting for events...
    </body>
</html>

程序化检查资源

$generalHealthState = app('pragmarx.health')->checkResources();

// or

$databaseHealthy = app('pragmarx.health')->checkResource('database')->isHealthy();

在 artisan 命令中的检查示例

Artisan::command('database:health', function () {
    app('pragmarx.health')->checkResource('database')->isHealthy()
        ? $this->info('database is healthy')
        : $this->info('database is in trouble')
    ;
})->describe('Check database health');

安全检查器

由于 SensioLabs 安全检查器包已被弃用，此检查器现在依赖于 local-php-security-checker。您需要在服务器或容器上编译或安装它，然后更新 config/resources/SecurityChecker.yml 文件。

Lumen

要在Lumen上使用它，您可能需要在您的 bootstrap/app.php 中执行类似以下操作

$app->instance('path.config', app()->basePath() . DIRECTORY_SEPARATOR . 'config');
$app->instance('path.storage', app()->basePath() . DIRECTORY_SEPARATOR . 'storage');

$app->withFacades();

$app->singleton('Illuminate\Contracts\Routing\ResponseFactory', function ($app) {
    return new \Illuminate\Routing\ResponseFactory(
        $app['Illuminate\Contracts\View\Factory'],
        $app['Illuminate\Routing\Redirector']
    );
});

$app->register(PragmaRX\Health\ServiceProvider::class);

测试

$ composer test

作者

Antonio Carlos Ribeiro

许可

Health遵循BSD 3-Clause许可 - 有关详细信息，请参阅LICENSE文件。

贡献

欢迎提交拉取请求和问题。

clonixdev / health

维护者

详细信息