Azure Web Apps 上で稼働している ASP.NET Web API サーバーでの補足されない例外を記録・通知する方法

ASP.NET Web API によって実装した Web アプリ/API サーバーを、Azure Web Apps 上に配置、運用する際の話題。

過去に似たような話題でブログ記事を投稿しているが、

Azure Websites に配置した ASP.NET Web アプリで、捕捉されない例外のログを記録してみた、けど...
http://devadjust.exblog.jp/21591888/

ASP.NET Web API v2 だとまたちょっと事情が違うようで、APIコントローラのアクションメソッド内で補足されない例外発生しても、素の状態では、Azure Web Apps のイベントログには何も記録されない様子なのだ。

そこで以下の要領でプログラムにもテコ入れをして運用している。

ASP.NET Web API での補足されない例外発生を、Trace.TraceError("～") の呼び出しに振り替える

詳しくは下記参照。

miso_soup3 Blog - ASP.NET Web API 2.1 その 2 ～Global Error Handling～
http://miso-soup3.hateblo.jp/entry/2014/01/22/022129

具体的には下記のコードを実装する。

Trace.TraceError("～") の内容がテキストファイルに保存されるように、Azure Web Apps の設定を変更する

Azure のポータル画面 ( https://portal.azure.com ) にサインインし、対象 Web アプリの設定画面までブレードを開く。

そして「設定」をクリックして設定ブレードを開き、「診断ログ」をクリック。

ログブレードが開くので「アプリケーション ログ (ファイルシステム)」を「オン」に切り替えて、最後に「保存」をクリック。

これで C# コードの Trace.TraceError("～") の内容が、Azure Web Apps のファイルシステム上にテキストファイルで保存されるようになる。

なお、本投稿ではファイルシステムへの保存を選んだが、もちろん、Azure ストレージアカウントへの保存を選んでも運用可能だろう。

HTTP 500 が発生していたらメールによる通知を送信するよう、Azure Web Apps の設定を変更する

次に対象 Web アプリのブレードから「ツール」をクリックしてツールブレードを開き、「警告」をクリック。

アラートルールブレードが開くので、「ServerErrors (サイト名)」のアラートルールがもしすでにあればこれをクリック。
無ければアラートルールブレードの「アラートの追加」をクリック。

ルールの編集ブレードが開くので、ここで以下の要領でルールを編集する。

メトリック ... "Http Server Errors"
条件　　　 ... "より大きい"
しきい値　 ... "0"
期間　　　 ... "直近 5 分"
...に電子メールを送信 ... チェック On

勿論、要件に応じて上記パラメータは適宜都合のよいように変更されたし。
例えば電子メールアドレスは、このルール編集画面で即値指定もできるし、はたまた、電子メール通知ではなく Web Hook による外部サービスへの通知も可能な模様 (Web Hook は自分では試したことがない)。

以上で「保存」をクリック、さらに「有効」をクリックしてこのアラートルールを有効化する。

ASP.NET Web API アプリにおいて、補足されない例外発生時は通常 HTTP 500 ステータスによる返答を伴うはず。
なので、以上のアラートルールの設定によって、補足されない例外発生時にメールが送信されるようになる。

なお、このアラートルールによるメール通知は5分間隔で監視・実行されている様子。
補足されない例外発生したら即時にメール通知が届くわけではないようだ。

ログファイルの内容を見るには

方法その1.FTP/FTPSでダウンロード

先の手順で「設定」→「ログ」ブレードを開いたときに下のほうに表示されている FTP や FTPS の接続情報にて、FTP/FTPS クライアントから接続すれば、保存されたテキストファイルを取り出すことができる。

方法その2. ログブラウザの拡張入れてブラウザ上から閲覧

その他にも「ツール」→「拡張機能」→「追加」から、「Azure Web Site Logs Browser」拡張機能を追加すると、この拡張機能によって、Azure ポータル画面経由で Web ブラウザ上でログファイルの内容を閲覧できてなかなかに便利だ。

方法その3. Visual Studio のクラウドエクスプローラとか

はたまた、Visual Studio の「サーバーエクスプローラ」ないしは「クラウドエクスプローラ」からも、Azure に接続してアプリケーションログファイルをダウンロードして閲覧することができる。以上、状況・好みに応じて選択するとよいだろう。

まとめ

以上のアプリ側の実装と、Azure Web Apps の設定変更によって、万が一の補足されない例外発生時は、メールで通知がなされ、テキストファイルに記録されたログファイルを閲覧することで例外の内容を捜査可能となった。

ほかにもっと良い運用方法があるのかもしれないが、log4net や Elmah、NLog、あるいは Application Insights や New Relic などに依存せずにプラットフォームの引っ越しを容易にできるよう手軽に実現するとなると、こんな設定・運用になるのではないだろうか。

小規模・低負荷な API アプリを小さく運用する場合にのみ当てはまるシナリオかとは思うが、それでもどなたかの参考になれば幸いである。