首頁  >  文章  >  php框架  >  如何在 Laravel 中使用 Slack 進行異常通知

如何在 Laravel 中使用 Slack 進行異常通知

藏色散人
藏色散人轉載
2020-03-16 08:57:433187瀏覽

異常處理是軟體開發過程中無法逃避的問題。對於一套設計良好程式碼高效的程序,出現異常的可能性會比較低,但這並不意味著不會出現異常,有些異常甚至會引起嚴重的後果,所以如何及時的發現程序中的異常並處理它便顯得十分重要了。

推薦:laravel教學

#通常,我們可以依靠使用者回饋、經常查看程式日誌來發現程式存在的問題。但這要么不可靠要么不及時,所以下面我們介紹一個比較有效的做法--使用 Slack 通知程序跑出的異常信息。

Slack 是一款即時通訊軟體,類似於QQ,它提供開放的API,可以呼叫它向自己團隊中指定的個人或頻道(Channel)發送訊息,因此用它來進行異常通知是再合適不過的。

1.安裝 maknz/slack-laravel 套件

具体的安装方法请参考 Github 上的 [readme](https://github.com/maknz/slack-laravel)。

2.設定

安装完成后使用 php artisan vendor:publish 生成 config\slack.php 配置文件,然后在.env文件中添加如下三项配置值.
```
SLACK_ENDPOINT=//slack 终端,即 slack 接口地址
SLACK_CHANNEL=//消息默认接收频道
SLACK_USERNAME//消息默认接收人
```
> 当然,也可以直接直接在 config\slack.php 对应配置的默认值而不使用 .env,但并不推荐这样做。
> 根据实际需要设置 SLACK_CHANNEL 和 SLACK_USERNAME ,二者并不是必须的

3.調整 AppExceptionsHandler 類別的 report 方法,實作 Slack 通知例外資訊的邏輯。程式碼如下:

/**
 * Report or log an exception.
 *
 * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
 *
 * @param  \Exception  $e
 * @return void
 */
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,我們可能不想讓程式通知它。為此,我們只需要在 Aop\Exceptions\Handler 類別裡的 $dontReort 屬性中加入指定的異常的類型就可以了。

    protected $dontReport = [
        NotFoundHttpException::class,
        // ...
    ];

範例中展示的是對指定的頻道(channel)發送訊息,當然你也可以向指定的人發送,或者其它更複雜的用法。不過要注意指定的使用者名稱和頻道是自己 slack 團隊中已經存在的,不然會出錯。

這樣,當程式中出現異常時,維運能在第一時間收到相關的通知訊息,方便及時處理了。

相關推薦,PHP影片教學學習網址:https://www.php.cn/course/list/29/type/2.html

以上是如何在 Laravel 中使用 Slack 進行異常通知的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:segmentfault.com。如有侵權,請聯絡admin@php.cn刪除