LoginSignup
0
0

More than 3 years have passed since last update.

OctoberCMSのエラーをSlackに通知する

Last updated at Posted at 2018-07-21

Error Loggerプラグインを使うと楽にできるが、Slackの方の設定など情報がなかったのでメモ。

Error Loggerプラグインのインストール

OctoberCMSの管理画面、またはcomposerでもインストールできる。
composerではプロジェクトのルートディレクトリで下記コマンドで完了。

composer require vojtasvoboda/oc-errorlogger-plugin

以上で、下記のような画面が管理画面で開ける。

oc_error_logger_slack.png

Slackの設定

ブラウザでSlackにログインしてSlack APIページからSlackアプリを作成する。

Screen_Shot_2018-07-21_at_10_44_09.png

「Review Scopes to Add」をクリック
Screen_Shot_2021-01-14_at_16_58_18.png

「Bot Token Scopes」で、Botに許可する権限を選択して設定する。
「Add an OAuth Scope」ボタンをクリックして、chat:write.customizeを設定するとchat:writeも追加するダイアログが出るので「Add Scopes」を押せば両方設定できる。
Screen_Shot_2021-01-14_at_17_01_29.png

Screen Shot 2021-01-14 at 17.03.25.png

そしたら、ページの上の方に戻って「Install to Workspace」をクリックする。
Screen_Shot_2018-07-21_at_10_48_11.png

確認画面が表示されるので許可して自分のチームのワークスペースにアプリをインストールする。

インストールされると元の画面に戻り、「Bot Uesr OAuth Access Token」をコピーする。
Screen_Shot_2021-01-14_at_17_05_51.png

そして、Slackのチャネルでこのアプリを追加してやる。
Screen_Shot_2021-01-14_at_18_46_39.png

以上で、Slackの方の設定は完了。

Error Logger プラグインの設定

OctoberCMS管理画面のSettings画面で、SYSTEM以下にある「Error logger」のメニューを開き、Slackタブを選択する。
Screen_Shot_2021-01-14_at_18_44_24.png

ここの「Slack API token」に先ほどコピーしたBotのトークンを貼り付ける。

Slack channelはお好きなチャンネル名を。ちなみに#で始まるのはチーム内の公開チャネルで?で始まるのは非公開チャネル、@で始まるのはユーザ名でダイレクトメッセージになる。

「Name of a bot」は実は先ほと作成したBotの名前でなくてもよい。単純にこの名前がSlackへの投稿で表示される。

「Send as attachment (option)」はチェックした方がSlackに表示されるメッセージがコンパクトになってよい。

以上で、ログにエラーが吐かれるとSlackに通知が飛ぶようになる。

Screen Shot 2018-07-21 at 12.04.52.png

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0