This article was migrated from http://rails.office.drecom.jp/takiuchi/archive/168

Ruby on Railsの便利なプラグイン、exception_notificationの紹介です。

このプラグインを使うと、サーバでエラーが発生したときに、スタックトレースやセッション情報、環境変数などの情報をまとめて所定のメールアドレスに報告してくれるので、エラー原因の解析がとても楽になります。

使い方ですが、まずはプラグインをインストールします。

$ ./script/plugin install exception_notification

次に、ApplicationControllerに以下の行を追加します。

class ApplicationController < ActionController::Base
  include ExceptionNotifiable

このプラグインは、ActionMailerの機能を使っているので、ActionMailerの設定を行います。 config/environment.rbを開いて、以下の記述を加えます。

Rails::Initializer.run do |config|
  ...
  # action mailer
  config.action_mailer.delivery_method = :smtp
  config.action_mailer.smtp_settings = {
    :address => 'localhost',
    :port => 25,
    :domain => 'your.service.com',
  }
end

# exception notifier plugin
ExceptionNotifier.sender_address = 'error <info@your.service.com>'
ExceptionNotifier.email_prefix = '[your.service-error] '
ExceptionNotifier.exception_recipients = [
  'foo@baz.com',
  'bar@baz.com',
]

以上で完了です。上記は、ローカルに立ち上げたSMTPサーバを利用するようになっていますが、外部のSMTPサーバを使う場合は、ActionMailerの設定部分を書き換えてください。

config/environments/以下の設定ファイル内にもaction_mailer関連の設定項目が 存在するので、必要に応じて書き換えます。

This article was migrated from http://rails.office.drecom.jp/takiuchi/archive/168