kayw-geek/yii2-error-dingtalk

When an HTTP error occurs, it can help you record the log and notify the Dingding group through webhook

v1.0 2020-09-10 08:17 UTC

Requires

• yiisoft/yii2: *

MIT

• Kay W

• error handler
• yii
• webhook
• yii2
• notice
• dingtalk

README

基于Yii2错误处理的钉钉群机器人Webhook通知

安装

使用 Composer 安装:

$ composer require kayw-geek/yii2-error-dingtalk

使用

1. 入口文件 index.php 中 defined('YII_DEBUG') or define('YII_DEBUG', true); 修改为 defined('YII_DEBUG') or define('YII_DEBUG', false);

2. 确保应用下 main.php 配置文件中已配置

   'errorHandler' => [
               'errorAction' => 'site/error',
           	],

3. SiteController控制器中配置

public function actions()
	{
            return [
                'error' => [
                    'class' => 'kaywGeek\yii2ErrorDingtalk\ErrorDingtalk', 
                    'handle' => [ '500','403','401','502','404'], //启用哪些状态码
                    'title' => 'PC Web 异常状态码监测通知', //通知标题
                    'logCategoryName' => 'error-status', //日志分类名
                    'dingTalkWebHookUrl' => 'https://oapi.dingtalk.com/robot/send?access_token=xxxxxx', //钉钉群机器人获取到的webhook URL
                    'enable' => true, //是否启用
                    'text'=>'- 用户IP: '.Yii::$app->request->userIP, //设置额外的通知内容

                ],
            ];
	}

获取钉钉机器人Webhook URL

点击自己的钉钉群 - 群设置 - 智能群助手 - 群机器人 - 添加机器人 - 获取Webhook 地址

注意： 安全设置可以选择自定义关键词 通知内容中只要包含 设置的关键词 就可以正常推送

效果展示

License