buexplain/alarm

这个是一个基于hyperf(swoole驱动)的告警组件

v3.0.1 2023-07-26 09:54 UTC

Requires

• php: >=8.1
• hyperf/contract: ^3.0
• hyperf/exception-handler: ^3.0
• hyperf/guzzle: ^3.0
• hyperf/process: ^3.0
• hyperf/utils: ^3.0
• monolog/monolog: ^3.0
• psr/log: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• hyperf/signal: @dev
• swoole/ide-helper: @dev

Apache-2.0

• php
• wechat
• swoole
• alarm
• dingtalk
• hyperf
• Feishu

README

这个是一个基于hyperf的告警组件。

支持发送告警到钉钉群机器人和企业微信群机器人。

大概的告警流程是：

1. 创建自定义告警进程
2. worker进程与task进程通过日志组件发送日志到告警进程，该日志包含告警组件的配置文件的handler信息
3. 告警进程接收到日志后，解析其中的告警组件的handler信息，然后循环丢给每一个handler进行处理

安装

下载包 composer require buexplain/alarm

发布告警组件的配置 php bin/hyperf.php vendor:publish buexplain/alarm

NOTE: 告警机器人地址的获取，请前往相关网站了解，申请成功后，请手动修改此配置文件。 目前钉钉群机器人和企业微信群机器人的发送频率限制皆为每分钟20条。 为避免触发对方接口的限流警告，本组件限制为单个机器人每分钟20条，可以配置多个机器人，缓解大量发送的需求。

修改日志配置文件 config/autoload/logger.php

<?php

declare(strict_types=1);

use Monolog\Logger;
use Monolog\Formatter\LineFormatter;
use Monolog\Handler\RotatingFileHandler;

return [
    'default' => [
        'handlers'=>[
            //默认的文件日志处理器
            [
                'class' => RotatingFileHandler::class,
                'constructor' => [
                    'filename' => BASE_PATH . '/runtime/logs/hyperf.log',
                    'level'=>Level::Error,
                ],
                'formatter' => [
                    'class' => LineFormatter::class,
                    'constructor' => [
                        'format' => null,
                        'dateFormat' => null,
                        'allowInlineLineBreaks' => true,
                    ],
                ],
            ],
            //告警日志处理器
            [
                'class' => \Alarm\Handler::class,
                'constructor' => [
                    //此处的handler对应的正是config/autoload/alarm.php配置的key值
                    'handlers'=>[
                        'dingTalk',
                        'weChat',
                        'feiShu',
                    ],
                    //接收的日志级别
                    'level'=>\Monolog\Level::Error,
                ],
            ],
        ],
    ],
    'alarm' => [  // 这是另外一种使用方式 \Hyperf\Utils\ApplicationContext::getContainer()->get(\Hyperf\Logger\LoggerFactory::class)->get('xxxxx' , 'alarm')->error('tips');
        'handlers' => [
            //告警日志处理器
            [
                'class' => \Alarm\Handler::class,
                'constructor' => [
                    //此处的handler对应的正是config/autoload/alarm.php配置的key值
                    'handlers'=>[
                        'feiShu',
                    ],
                    //接收的日志级别
                    'level'=>\Monolog\Level::Error,
                ],
            ],
        ],
        'formatter' => [
            'class'       => Monolog\Formatter\LineFormatter::class,
            'constructor' => [
                'format'                => null,
                'dateFormat'            => 'Y-m-d H:i:s.u',
                'allowInlineLineBreaks' => true,
            ],
        ],
    ],
];

NOTE:

1. 如果配置文件logger.php存在，则直接在需要告警的日志渠道上添加告警日志处理器，否则请先安装日志组件
2. 如果配置文件signal.php存在，则需要配置\Alarm\Signal\AlarmStopHandler::class => PHP_INT_MAX
3. 必须在协程环境下使用
4. 不支持协程风格的服务器

使用

$logger = \Hyperf\Utils\ApplicationContext::getContainer()->get(\Hyperf\Logger\LoggerFactory::class)->get();
//at群内用户需要提供手机号(飞书不支持)
$logger->error('at一个用户', ['@'=>'135xxxxxxx1']); // 注意: 目前飞书不支持 @指定用户提醒 , 只能群呼
$logger->error('at两个用户', ['@'=>['135xxxxxxx1', '135xxxxxxx2']]); 
$logger->error('at所有人', ['@'=>'all']); 

README.feishu.md , 飞书的使用例子

License

Apache-2.0