Azure App Service でのアプリの診断ログの有効化

[アーティクル]
08/21/2024

Note

2024 年 6 月 1 日より、新しく作成されたすべての App Service アプリには、名前付け規則 <app-name>-<random-hash>.<region>.azurewebsites.net を使用して一意の既定のホスト名を生成するオプションが備わります。既存のアプリ名は変更されません。

例: myapp-ds27dh7271aah175.westus-01.azurewebsites.net

詳しくは、App Service リソースの一意の既定のホスト名に関する記事をご覧ください。

このビデオでは、アプリの診断ログを有効にする方法について説明します。

ビデオの手順については、次のセクションでも説明します。

概要

Azure では、組み込みの診断機能により、 App Service アプリのデバッグを容易に行うことができます。この記事では、診断ログを有効にしてインストルメンテーションをアプリケーションに追加する方法と、Azure によってログに記録された情報にアクセスする方法について説明します。

この記事では、Azure portal と Azure CLI を使用して診断ログを操作します。 Visual Studio で診断ログを使用する方法の詳細については、「 Visual Studio での Azure のトラブルシューティング」を参照してください。

Note

この記事のログ手順に加えて、Azure Monitor の統合ログ機能を使用することもできます。この機能の詳細については、「ログを Azure Monitor に送信する」のセクションを参照してください。

Type	プラットフォーム	ログの保存場所	説明
アプリケーションのログ記録	Windows、Linux	App Service ファイルシステムおよび Azure Storage BLOB	アプリケーションのコードによって生成されたメッセージがログに記録されます。メッセージは、選択した Web フレームワークによって、またはお使いの言語の標準ログパターンを使用してアプリケーションのコードから直接、生成できます。各メッセージには、次のいずれかのカテゴリが割り当てられます: 重大、エラー、警告、情報、デバッグ、トレース。アプリケーションのログ記録を有効にするときに、重大度レベルを設定することにより、ログ記録の詳細さを指定できます。
Web サーバーのログ記録	Windows	App Service ファイルシステムまたは Azure Storage BLOB	W3C 拡張ログファイル形式の生 HTTP 要求データ。各ログメッセージには、HTTP メソッド、リソース URI、クライアント IP、クライアントポート、ユーザーエージェント、応答コードなどのデータが含まれます。
詳細なエラーメッセージ	Windows	App Service ファイルシステム	クライアントのブラウザーに送信された .htm エラーページのコピー。セキュリティ上の理由から、運用環境では詳細なエラーページをクライアントに送信することはできませんが、App Service では、HTTP コード 400 以上のアプリケーションエラーが発生するたびにエラーページを保存できます。ページには、サーバーによってエラーコードが返される理由を特定するのに役立つ情報が記録されている場合があります。
失敗した要求トレース	Windows	App Service ファイルシステム	要求の処理に使用された IIS コンポーネントのトレースや各コンポーネントにかかった時間など、失敗した要求の詳細なトレース情報。この情報は、サイトのパフォーマンスを向上させたい場合や、特定の HTTP エラーを分離する場合に役立ちます。失敗した要求ごとに 1 つのフォルダーが生成されます。このフォルダーには、XML ログファイルと、ログファイルを表示するための XSL スタイルシートが含まれています。
デプロイログ	Windows、Linux	App Service ファイルシステム	アプリにコンテンツを発行するときのログ。デプロイログの記録は自動的に行われ、デプロイログの構成可能な設定はありません。デプロイが失敗した理由を判断するのに役立ちます。たとえば、カスタムデプロイスクリプトを使用している場合は、デプロイログを使用して、スクリプトでエラーが発生する理由を特定できることがあります。

App Service ファイルシステムに保存されている場合、ログには価格レベルで使用可能なストレージが適用されます (App Serviceの制限に関するページを参照してください)。

Note

App Service では、アプリケーションのトラブルシューティングに役立つ専用の対話型診断ツールが提供されています。詳細については、「Azure App Service 診断の概要」を参照してください。

さらに、Azure Monitor などの他の Azure サービスを使用して、アプリのログ記録と監視の機能を向上させることができます。

アプリケーションのログ記録を有効にする (Windows)

Azure portal で Windows アプリのアプリケーションログ記録を有効にするには、アプリに移動し、 [App Service ログ] を選択します。

[アプリケーションログ (ファイルシステム)] と [アプリケーションログ (Blob)] の一方または両方で、 [オン] を選択します。

ファイルシステム オプションは、一時的なデバッグ用であり、12 時間で自動的にオフになります。 Blob オプションは、長期的なログ記録用であり、ログを書き込む BLOB ストレージコンテナーが必要です。 Blob オプションには、ログメッセージの生成元 VM インスタンスの ID (InstanceId)、スレッド ID (Tid)、さらに細かいタイムスタンプ (EventTickCount) など、ログメッセージの追加情報も含まれます。

Note

現在、Blob Storage には .NET アプリケーションのログのみ書き込むことができます。 Java、PHP、Node.js、Python のアプリケーションログは、App Service ファイルシステムにのみ保存できます (ログを外部ストレージに書き込むためのコードの変更は必要ありません)。

また、ストレージアカウントのアクセスキーを再生成する場合、更新されたキーを使用するように、該当するログ記録の構成を再設定する必要があります。これを行うには、次の手順を実行します。

[構成] タブで、該当するログ機能を [オフ] に設定します。設定を保存します。
ストレージアカウントの BLOB へのログを再び有効にします。設定を保存します。

ログに記録する詳細さのレベルを選択します。次の表に、各レベルに含まれるログのカテゴリを示します。

Level	含まれるカテゴリ
無効	なし
エラー	エラー、クリティカル
警告	警告、エラー、クリティカル
情報	情報、警告、エラー、クリティカル
詳細	トレース、デバッグ、情報、警告、エラー、クリティカル (すべてのカテゴリ)

終わったら、 [保存] を選択します。

Note

BLOB にログを書き込む場合、アプリを削除しても BLOB にログを保持していると、アイテム保持ポリシーは適用されなくなります。詳細については、「リソースの削除後に発生する可能性があるコスト」を参照してください。

アプリケーションのログ記録を有効にする (Linux/コンテナー)

Azure portal で Linux アプリまたはカスタムコンテナーのアプリケーションログ記録を有効にするには、アプリに移動し、[App Service ログ] を選択します。

[アプリケーションログ記録] で [ファイルシステム] を選択します。

[クォータ (MB)] で、アプリケーションログのディスククォータを指定します。 [リテンション期間 (日)] で、ログを保持する日数を設定します。

終わったら、 [保存] を選択します。

Web サーバーのログ記録を有効にする

Azure portal で Windows アプリの Web サーバーログ記録を有効にするには、アプリに移動し、 [App Service ログ] を選択します。

[Web サーバーのログ記録] で、Blob Storage にログを格納する場合は [ストレージ] を選択し、App Service ファイルシステムにログを格納する場合は [ファイルシステム] を選択します。

[リテンション期間 (日)] で、ログを保持する日数を設定します。

Note

ストレージアカウントのアクセスキーを再生成する場合は、該当するログ構成を更新後のキーを使用するように設定し直す必要があります。これを行うには、次の手順を実行します。

[構成] タブで、該当するログ機能を [オフ] に設定します。設定を保存します。
ストレージアカウントの BLOB へのログを再び有効にします。設定を保存します。

終わったら、 [保存] を選択します。

Note

詳細なエラーのログを記録する

Azure portal で Windows アプリのエラーページまたは失敗した要求のトレースを保存するには、アプリに移動し、 [App Service ログ] を選択します。

[詳細なエラーログ] または [失敗した要求のトレース] で [オン] を選択し、次に [保存] を選択します。

どちらの種類のログも、App Service ファイルシステムに格納されます。最大 50 件のエラー (ファイルまたはフォルダー) が保持されます。 HTML ファイルの数が 50 を超えた場合、古い順にエラーファイルが自動的に削除されます。

既定では、失敗した要求のトレース機能では、400 から 600 までの HTTP ステータスコードで失敗した要求のログをキャプチャします。カスタムルールを指定するには、web.config ファイルの <traceFailedRequests> セクションをオーバーライドします。

コードでログメッセージを追加する

アプリケーションのコードでは、通常のログ記録機能を使用して、ログメッセージをアプリケーションログに送信します。次に例を示します。

ASP.NET アプリケーションは、 System.Diagnostics.Trace クラスを使用して、情報をアプリケーション診断ログに記録できます。次に例を示します。
```
System.Diagnostics.Trace.TraceError("If you're seeing this, something bad happened");
```
ASP.NET Core では、既定で、Microsoft.Extensions.Logging.AzureAppServices ログプロバイダーが使用されます。詳しくは、Azure 内での ASP.NET Core のログ記録に関するページをご覧ください。 WebJobs SDK のログの詳細については、Azure WebJobs SDK の概要に関するページを参照してください。
Python アプリケーションでは、OpenCensus パッケージを使用して、アプリケーション診断ログにログを送信できます。

ログのストリーミング

ログをリアルタイムでストリーミングする前に、目的のログの種類を有効にします。コンソール出力または /home/LogFiles ディレクトリ (D:\home\LogFiles) に格納されており、末尾が .txt、.log、または .htm のファイルに書き込まれた情報が、App Service によってストリーミングされます。

Note

ログバッファーの種類によってはログファイルに書き込まれるため、イベントがストリーム内で正しくない順序で表示される可能性があります。たとえば、ユーザーがページにアクセスしたときに発生するアプリケーションログエントリは、ページ要求の該当する HTTP ログエントリより前のストリームに表示されることがあります。

Azure Portal の場合

Azure portal でログをストリーミングするには、アプリに移動し、 [ログストリーム] を選択します。

Cloud Shell の場合

Cloud Shell でログをライブストリーミングするには、次のコマンドを使用します。

重要

このコマンドは、Linux App Service プランでホストされている Web アプリでは機能しない可能性があります。

az webapp log tail --name appname --resource-group myResourceGroup

HTTP などの特定のログの種類をフィルター処理するには、--provider パラメーターを使用します。次に例を示します。

az webapp log tail --name appname --resource-group myResourceGroup --provider http

ローカルターミナルの場合

ローカルコンソールでログをストリーミングするには、Azure CLI をインストールし、アカウントにサインインします。ログインした後、Cloud Shell の場合の手順に従います。

アクセスログファイル

ログの種類に Azure Storage BLOB オプションを構成する場合は、Azure Storage で使用できるクライアントツールが必要です。詳しくは、「Azure Storage クライアントツール」をご覧ください。

App Service ファイルシステムに格納されているログの場合、ファイルにアクセスする最も簡単な方法は、ブラウザーで次の ZIP ファイルをダウンロードすることです。

Linux/custom コンテナー: https://<app-name>.scm.azurewebsites.net/api/logs/docker/zip
Windows アプリ: https://<app-name>.scm.azurewebsites.net/api/dump

Linux/カスタムコンテナーの場合、ZIP ファイルには、Docker ホストと Docker コンテナーの両方のコンソール出力ログが含まれます。スケールアウトされたアプリの場合、ZIP ファイルには、各インスタンスの 1 セットのログが含まれます。 App Service ファイルシステムでは、これらのログファイルは /home/LogFiles ディレクトリの内容です。デプロイログは、/site/deployments/ に格納されています。

Windows アプリの場合、ZIP ファイルには、App Service ファイルシステムの D:\Home\LogFiles ディレクトリの内容が含まれています。その構造を次に示します。

ログのタイプ	ディレクトリ	説明
アプリケーションログ	/LogFiles/Application/	1 つ以上のテキストファイルが含まれます。ログメッセージの形式は、使用するログプロバイダーによって異なります。
失敗した要求のトレース	/LogFiles/W3SVC#########/	XML ファイルと XSL ファイルが含まれます。書式設定された XML ファイルをブラウザーで表示できます。
詳細なエラーログ	/LogFiles/DetailedErrors/	HTM エラーファイルが含まれます。ブラウザーで HTM ファイルを表示できます。失敗した要求のトレースを表示するもう 1 つの方法は、ポータルでアプリのページに移動します。左側のメニューから、[問題の診断と解決] を選択して、[失敗した要求トレースログ] を探し、次にアイコンをクリックして目的のトレースを参照して表示します。
Web サーバーログ	/LogFiles/http/RawLogs/	W3C 拡張ログファイル形式を使用して書式設定されたテキストファイルが含まれます。これらのファイルは、テキストエディターまたは Log Parser などのユーティリティを使用して読み取ることができます。 App Service では、`s-ip`、`s-computername`、または `cs-version` フィールドはサポートされていません。
デプロイログ	/LogFiles/Git/ および /deployments/	内部デプロイプロセスによって生成されたログと、Git デプロイのログが含まれます。

ログを Azure Monitor に送信する

Azure Monitor の統合により、診断設定を作成して、ストレージアカウント、イベントハブ、Log Analytics にログを送信できます。診断設定を追加すると、App Service がアプリ設定をアプリに追加し、それによってアプリの再起動がトリガーされます。

診断設定

サポートされるログの種類

サポートされているログの種類とその説明の一覧については、「Microsoft.Web でサポートされているリソースログ」を参照してください。

ネットワークに関する考慮事項

診断設定の制限については、送信先の制限に関する診断設定の公式ドキュメントを参照してください。

次の方法で共有

Azure App Service でのアプリの診断ログの有効化

概要

アプリケーションのログ記録を有効にする (Windows)

アプリケーションのログ記録を有効にする (Linux/コンテナー)

Web サーバーのログ記録を有効にする

詳細なエラーのログを記録する

コードでログメッセージを追加する

ログのストリーミング

Azure Portal の場合

Cloud Shell の場合

ローカルターミナルの場合

アクセスログファイル

ログを Azure Monitor に送信する

サポートされるログの種類

ネットワークに関する考慮事項

次のステップ

フィードバック

その他のリソース

次の方法で共有

Azure App Service でのアプリの診断ログの有効化

概要

アプリケーションのログ記録を有効にする (Windows)

アプリケーションのログ記録を有効にする (Linux/コンテナー)

Web サーバーのログ記録を有効にする

詳細なエラーのログを記録する

コードでログ メッセージを追加する

ログのストリーミング

Azure Portal の場合

Cloud Shell の場合

ローカル ターミナルの場合

アクセス ログ ファイル

ログを Azure Monitor に送信する

サポートされるログの種類

ネットワークに関する考慮事項

次のステップ

フィードバック

その他のリソース

コードでログメッセージを追加する

ローカルターミナルの場合

アクセスログファイル