浅谈Laravel中使用Slack进行异常通知
目录
- 概述
- 安装 maknz/slack-laravel 包
- 配置
- 调整 AppExceptionsHandler 类的 report 方法
概述
通常,我们可以依靠用户反馈、经常查看程序日志来发现程序存在的问题。但这要么不可靠要么不及时,所以下面我们介绍一种比较有效的做法--使用 Slack 通知程序跑出的异常信息。
Slack 是一款即时通信软件,类似于 QQ,它提供开放的 API,可以调用它向自己团队中指定的个人或者频道(Channel)发送消息,因此用它来进行异常通知是再合适不过的。
安装 maknz/slack-laravel 包
具体的安装方法请参考 Github 上的 [readme](https://github.com/maknz/slack-laravel)。
配置
安装完成后使用 php artisan vendor:publish 生成 configslack.php 配置文件,然后在.env文件中添加如下三项配置值.
SLACK_ENDPOINT=//slack 终端,即 slack 接口地址
SLACK_CHANNEL=//消息默认接收频道
SLACK_USERNAME//消息默认接收人
> 当然,也可以直接直接在 configslack.php 对应配置的默认值而不使用 .env,但并不推荐这样做。
> 根据实际需要设置 SLACK_CHANNEL 和 SLACK_USERNAME ,二者并不是必须的
调整 AppExceptionsHandler 类的 report 方法
实现 Slack 通知异常信息的逻辑。代码如下:
/** * Report or log an exception. * public function report(Exception $e){ if ($this->shouldReport($e)) { $slackMessage = "n[Error.{$e->getCode()}] {$e->getMessage()}"; $slackMessage.= "n[Line.{$e->getLine()}] {$e->getFile()}"; $slackMessage.= "n[Time] ".date('Y-m-d H:i:s'); try { Slack::to(config('slack.channel'))->send($slackMessage); } catch (Exception $eOther) { Log::info($slackMessage); } } return parent::report($e); }
对于一些可能频繁出现但又不致命的异常,例如404 NotFoundHttpException,我们可能并不想让程序通知它。为此,我们只需要在 AopExceptionsHandler 类里的 $dontReort 属性中加入指定的异常的类型就可以了。
protected $dontReport = [ NotFoundHttpException::class, // ... ];
示例中展示的是对指定的频道(channel)发送信息,当然你还可以向指定的人发送,或者其它更复杂的用法。不过要注意指定的用户名和频道是自己 slack 团队中已经存在的,不然会出错。
这样,当程序中出现异常时,运维能在第一时间收到相关的通知信息,方便及时处理了。
以上就是浅谈Laravel中使用Slack进行异常通知的详细内容,更多关于Laravel中使用Slack进行异常通知的资料请关注脚本之家其它相关文章!