[Craft CMS] Rollbarプラグインを使ってサイトのエラーを通知する

Craft CMS Advent Calendar 2019の15日目です。忘れてました。。
Rollbarプラグインを使ってExceptionを通知して、早めにサイトの異常に気付こうって内容です。

Rollbarとは

Rollbarとは、簡単に言うとエラー通知サービスです。サイトで予期せぬエラーが発生した際に、Rollbarにデータを送信することで、メールやSlackなどいろいろな方法でエラーを通知し、Rollbarのダッシュボード上でエラー内容を詳しくみることができます。

Craft CMSにはRollbarというプラグインがあり、無料で公開されています。これをインストール・設定することで、Craft CMS上のエラーを早期に検知し、対処を行うことができます。

インストール

インストールはCraft CMS上のプラグインストアからダウンロードするだけでOKです！

設定

Rollbarのアカウントとプロジェクトを作ると、設定画面にアクセスできます。設定画面からpost_server_itemをコピーします。

コピーしたpost_server_itemをCraft CMS上のRollbar設定画面にあるAccess Tokenにペースとして保存します。

これで完了です。RollbarではJavaScriptのエラーも検知することができます。その場合はEnable JS IntegrationをONにし、post_client_itemの値をPost Client Item Access Tokenにセットします。

これで設定は完了です。これで、Craft CMS上で発生したPHPのExceptionやJavaScriptのエラーをRollbarに送信し、Rollbarからサイト管理者に通知することができます。

エラーを起こす

と言っても、本来は簡単にエラーを起こすことはできません。そこで、プラグインをちょこっと修正し、エラーを起こしたことにしてテストメッセージを送信するようにしたPRを出しました。マージされればテストでエラーを起こすことができます。エラーを起こすとRollbarで以下のような画面で確認することができます。見せられないですが、エラーの起きたファイル名と行数もわかります。

Rollbarのメリット

Rollbarでエラーを検知してサイト管理者に通知するというのが大きなメリットですが、もうひとつサーバにアクセスできない人もエラー内容を確認できるようになるのが大きなメリットではないかと個人的には思います。サーバにアクセスできればエラーログを直接見ることで確認できますが、サーバにアクセスできる人を増やすのは危険です。Rollbarであれば、サーバにアクセスできない人でもエラーを確認できるようにすることができます。サーバにアクセスできる人を絞ってサーバの堅牢さを損なわないようにすることができるのが大きなメリットだと思います。