Application Insights Snapshot Debugger の有効化やスナップショットの表示に関する問題のトラブルシューティング

[アーティクル]
11/17/2023

アプリケーションで Application Insights スナップショットデバッガーを有効にしても、例外のスナップショットが表示されない場合は、こちらの手順を使用してトラブルシューティングを行うことができます。

スナップショットが生成されない理由としては、さまざまなことが考えられます。まずスナップショットの正常性チェックを実行することにより、考えられるいくつかの一般的な原因を特定できます。

サポートされていないシナリオ

Snapshot Collector がサポートされていないシナリオを以下に示します。

シナリオ	副作用	推奨
アプリケーションで Snapshot Collector SDK を直接使用する場合 (.csproj) に、事前オプション "Interop" を有効にしている。	ローカルの Application Insights SDK (Snapshot Collector テレメトリを含む) は失われるため、スナップショットは使用できません。起動時にアプリケーションが `System.ArgumentException: telemetryProcessorTypedoes not implement ITelemetryProcessor` でクラッシュする可能性があります。 Application Insights 機能 "Interop" の詳細については、ドキュメントを参照してください。	事前オプション "Interop" を使用している場合、コードレス Snapshot Collector インジェクション (Azure portal UX から有効にする) を使用します

適切なスナップショットデバッガーエンドポイントを使用していることを確認する

現在、エンドポイントの変更が必要なリージョンは Azure Government と 21Vianet によって運営される Microsoft Azure のみです。

Application Insights SDK を使用する App Service とアプリケーションでは、次の定義されているように、サポートされているスナップショットデバッガーのオーバーライドを使用して接続文字列を更新する必要があります。

接続文字列プロパティ	米国政府のクラウド	China Cloud
SnapshotEndpoint	`https://snapshot.monitor.azure.us`	`https://snapshot.monitor.azure.cn`

その他の接続のオーバーライドの詳細については、Application Insights のドキュメントを参照してください。

Function App の場合は、サポートされている次のオーバーライドを使用して host.json を更新する必要があります。

プロパティ	米国政府のクラウド	China Cloud
AgentEndpoint	`https://snapshot.monitor.azure.us`	`https://snapshot.monitor.azure.cn`

米国政府のクラウドエージェントエンドポイントで更新された host.json の例を次に示します。

{
  "version": "2.0",
  "logging": {
    "applicationInsights": {
      "samplingExcludedTypes": "Request",
      "samplingSettings": {
        "isEnabled": true
      },
      "snapshotConfiguration": {
        "isEnabled": true,
        "agentEndpoint": "https://snapshot.monitor.azure.us"
      }
    }
  }
}

スナップショットの正常性チェックを使用する

いくつかの一般的な問題により、[デバッグスナップショットを開く] が表示されません。古い Snapshot Collector を使用します (たとえば、1 日のアップロード上限に達した場合)。そうしないと、スナップショットのアップロードに時間がかかることがあります。一般的な問題のトラブルシューティングには、Snapshot Health Check を使用します。

エンドツーエンドのトレースビューの例外ウィンドウには、Snapshot Health Check に接続できるリンクが表示されます。

Snapshot Health Check の入力方法を示すスクリーンショット。

インタラクティブでチャットのようなインターフェイスでは、一般的な問題が検索され、問題の解決が案内されます。

問題とその解決方法を一覧表示するインタラクティブな Health Check ウィンドウを示すスクリーンショット。

それでも問題が解決しない場合は、以下の手動トラブルシューティング手順を参照してください。

インストルメンテーションキーの確認

公開したアプリケーションで、正しいインストルメンテーションキーを使用していることを確認します。通常、インストルメンテーションキーは、ApplicationInsights.config ファイルから読み取られます。値が、ポータルに表示される Application Insights リソースのインストルメンテーションキーと同じであることを確認します。

注意

インストルメンテーションキーのインジェストのサポートは、2025 年 3 月 31 日に終了します。インストルメンテーションキーのインジェストは引き続き機能しますが、この機能の更新プログラムやサポートは提供されなくなります。接続文字列に移行することで、新機能をご利用いただけます。

TLS/SSL クライアント設定の確認 (ASP.NET)

ASP.NET アプリケーションが、Azure App Service または仮想マシンの IIS でホストされている場合、SSL セキュリティプロトコルがないため、お使いのアプリケーションがスナップショットデバッガーサービスに接続できない可能性があります。

スナップショットデバッガーエンドポイントには、TLS バージョン 1.2 が必要です。 SSL セキュリティプロトコルのセットは、web.config の system.web セクションの httpRuntime targetFramework 値によって有効にされる特性の 1 つです。 httpRuntime targetFramework が 4.5.2 以下の場合、TLS 1.2 は既定では含まれていません。

注意

httpRuntime targetFramework 値は、アプリケーションのビルド時に使用されるターゲットフレームワークに依存しません。設定を確認するには、web.config ファイルを開き、system.web セクションを見つけます。 httpRuntime の targetFramework が 4.6 以上に設定されていることを確認します。

<system.web>
   ...
   <httpRuntime targetFramework="4.7.2" />
   ...
</system.web>

Note

httpRuntime targetFramework の値を変更すると、アプリケーションに適用されるランタイムの特性が変更され、その他の微妙な動作の変更が発生する可能性があります。この変更を行った後は、アプリケーションを十分にテストするようにしてください。互換性の変更点のすべての一覧については、「変更の再ターゲット」を参照してください。

注意

targetFramework が 4.7 以上の場合、使用可能なプロトコルは Windows によって決定されます。 Azure App Service では、TLS 1.2 を使用できます。ただし、独自の仮想マシンを使用している場合は、OS で TLS 1.2 を有効にすることが必要になる場合があります。

.NET Core のプレビューバージョン

.NET Core のプレビューバージョンを使用している場合、またはアプリケーションによって、依存アセンブリを介して直接または間接的に Application Insights SDK が参照されている場合は、その他の環境用にスナップショットデバッガーを有効にする方法に関する記事の手順に従ってください。

診断サービスのサイト拡張機能の状態ページを確認する

スナップショットデバッガーがポータルの[Application Insights] ペインから有効にされた場合は、診断サービスのサイト拡張機能によって有効にされています。

Note

Application Insights スナップショットデバッガーのコード不要のインストールは、.NET Core サポートポリシーに従います。サポートされているランタイムの詳細については、.Net Core サポートポリシーに関するページを参照してください。この拡張機能の状態ページを確認するには、次の URL に移動します: https://{site-name}.scm.azurewebsites.net/DiagnosticServices

Note

状態ページリンクのドメインは、クラウドによって異なります。このドメインは App Service の Kudu 管理サイトと同じです。この状態ページには、Profiler と Snapshot Collector エージェントのインストール状態が表示されます。予期しないエラーが発生した場合は、それが表示され、その修正方法が示されます。

App Service の Kudu 管理サイトを使用して、この状態ページのベース URL を取得できます。

Azure Portal で App Service アプリケーションを開きます。
[高度なツール] を選択するか、「Kudu」を検索します。
[Go] \(移動) を選択します。
Kudu 管理サイトが表示されたら、URL に /DiagnosticServices を追加して、Enter キーを押します。最終的には次のようになります: https://<kudu-url>/DiagnosticServices

アップローダーログの確認

スナップショットの作成後、ミニダンプファイル (.dmp) がディスク上に作成されます。個別アップローダープロセスでは、そのミニダンプファイルを作成し、これを関連する PDB と共に Application Insights のスナップショットデバッガーのストレージにアップロードします。ミニダンプは、正常にアップロードされた後、ディスクから削除されます。アップローダープロセスのログファイルは、ディスク上に保持されます。 App Service 環境では、これらのログは D:\Home\LogFiles にあります。 App Service の Kudu 管理サイトを使用すると、これらのログファイルを検索できます。

Azure Portal で App Service アプリケーションを開きます。
[高度なツール] を選択するか、「Kudu」を検索します。
[Go] \(移動) を選択します。
[デバッグコンソール] ドロップダウンリストで、[CMD] を選択します。
[LogFiles] を選択します。

Uploader_ または SnapshotUploader_で始まる名前で拡張子が .log であるファイルが 1 つ以上表示されます。適切なアイコンを選択してログファイルをダウンロードするかブラウザーで開きます。ファイル名には、App Service インスタンスを識別する一意のサフィックスが含まれます。 App Service のインスタンスが 1 つ以上のコンピューターでホストされている場合は、コンピューターごとに個別のログファイルがあります。アップローダーは、新しいミニダンプファイルを検出すると、ログファイルに記録します。スナップショットとアップロードの成功の例を次に示します。

SnapshotUploader.exe Information: 0 : Received Fork request ID 139e411a23934dc0b9ea08a626db16c5 from process 6368 (Low pri)
    DateTime=2018-03-09T01:42:41.8571711Z
SnapshotUploader.exe Information: 0 : Creating minidump from Fork request ID 139e411a23934dc0b9ea08a626db16c5 from process 6368 (Low pri)
    DateTime=2018-03-09T01:42:41.8571711Z
SnapshotUploader.exe Information: 0 : Dump placeholder file created: 139e411a23934dc0b9ea08a626db16c5.dm_
    DateTime=2018-03-09T01:42:41.8728496Z
SnapshotUploader.exe Information: 0 : Dump available 139e411a23934dc0b9ea08a626db16c5.dmp
    DateTime=2018-03-09T01:42:45.7525022Z
SnapshotUploader.exe Information: 0 : Successfully wrote minidump to D:\local\Temp\Dumps\c12a605e73c44346a984e00000000000\139e411a23934dc0b9ea08a626db16c5.dmp
    DateTime=2018-03-09T01:42:45.7681360Z
SnapshotUploader.exe Information: 0 : Uploading D:\local\Temp\Dumps\c12a605e73c44346a984e00000000000\139e411a23934dc0b9ea08a626db16c5.dmp, 214.42 MB (uncompressed)
    DateTime=2018-03-09T01:42:45.7681360Z
SnapshotUploader.exe Information: 0 : Upload successful. Compressed size 86.56 MB
    DateTime=2018-03-09T01:42:59.6184651Z
SnapshotUploader.exe Information: 0 : Extracting PDB info from D:\local\Temp\Dumps\c12a605e73c44346a984e00000000000\139e411a23934dc0b9ea08a626db16c5.dmp.
    DateTime=2018-03-09T01:42:59.6184651Z
SnapshotUploader.exe Information: 0 : Matched 2 PDB(s) with local files.
    DateTime=2018-03-09T01:42:59.6809606Z
SnapshotUploader.exe Information: 0 : Stamp does not want any of our matched PDBs.
    DateTime=2018-03-09T01:42:59.8059929Z
SnapshotUploader.exe Information: 0 : Deleted D:\local\Temp\Dumps\c12a605e73c44346a984e00000000000\139e411a23934dc0b9ea08a626db16c5.dmp
    DateTime=2018-03-09T01:42:59.8530649Z

Note

上記の例は、Microsoft.ApplicationInsights.SnapshotCollector NuGet パッケージのバージョン 1.2.0 からのものです。以前のバージョンのアップローダープロセスは MinidumpUploader.exe で、ログはこれほど詳しくありません。インストルメンテーションキーは、前の例では、c12a605e73c44346a984e00000000000 です。この値は、アプリケーションのインストルメンテーションキーと一致する必要があります。ミニダンプは ID 139e411a23934dc0b9ea08a626db16c5 を持つスナップショットに関連付けられています。この ID は、後で Application Insights Analytics で関連する例外レコードを検索するために使用できます。

アップローダーは、約 15 分ごとに 1 回新しい PDB をスキャンします。次に例を示します。

SnapshotUploader.exe Information: 0 : PDB rescan requested.
    DateTime=2018-03-09T01:47:19.4457768Z
SnapshotUploader.exe Information: 0 : Scanning D:\home\site\wwwroot for local PDBs.
    DateTime=2018-03-09T01:47:19.4457768Z
SnapshotUploader.exe Information: 0 : Local PDB scan complete. Found 2 PDB(s).
    DateTime=2018-03-09T01:47:19.4614027Z
SnapshotUploader.exe Information: 0 : Deleted PDB scan marker : D:\local\Temp\Dumps\c12a605e73c44346a984e00000000000\6368.pdbscan
    DateTime=2018-03-09T01:47:19.4614027Z

App Service にホストされて "いない" アプリケーションでは、アップローダーログは、ミニダンプと同じフォルダー %TEMP%\Dumps\<ikey> にあります (<ikey> はインストルメンテーションキー)。

クラウドサービスのトラブルシューティング

クラウドサービスでは、既定の一時フォルダーがミニダンプファイルを保持するには小さすぎて、スナップショットが失われる可能性があります。

必要な領域は、アプリケーションの合計ワーキングセットと同時実行スナップショット数によって異なります。

32 ビット ASP.NET web ロールのワーキングセットは、通常は 200 MB から 500 MB です。少なくとも 2 つの同時実行スナップショットを許可します。

たとえば、アプリケーションで 1 GB の合計ワーキングセットが使用されている場合は、スナップショットを格納するために少なくとも 2 GB のディスク領域が存在するようにする必要があります。

次の手順に従って、スナップショット専用のローカルリソースを持つクラウドサービスロールを構成します。

クラウドサービス定義 (.csdef) ファイルを編集して、新しいローカルリソースをクラウドサービスに追加します。次の例では、サイズが 5 GB の SnapshotStore というリソースを定義します。
```
<LocalResources>
  <LocalStorage name="SnapshotStore" cleanOnRoleRecycle="false" sizeInMB="5120" />
</LocalResources>
```

ロールの起動コードを変更して、SnapshotStore ローカルリソースを指す環境変数を追加します。 worker ロールの場合は、コードをロールの OnStart メソッドに追加する必要があります。

public override bool OnStart()
{
    Environment.SetEnvironmentVariable("SNAPSHOTSTORE", RoleEnvironment.GetLocalResource("SnapshotStore").RootPath);
    return base.OnStart();
}

Web ロール (ASP.NET) の場合は、コードを Web アプリケーションの Application_Start メソッドに追加する必要があります。

using Microsoft.WindowsAzure.ServiceRuntime;
using System;
namespace MyWebRoleApp
{
    public class MyMvcApplication : System.Web.HttpApplication
    {
       protected void Application_Start()
       {
          Environment.SetEnvironmentVariable("SNAPSHOTSTORE", RoleEnvironment.GetLocalResource("SnapshotStore").RootPath);
          // TODO: The rest of your application startup code
       }
    }
}

ロールの ApplicationInsights.config ファイルを更新して、SnapshotCollector によって使用される一時フォルダーの場所をオーバーライドします。

<TelemetryProcessors>
 <Add Type="Microsoft.ApplicationInsights.SnapshotCollector.SnapshotCollectorTelemetryProcessor, Microsoft.ApplicationInsights.SnapshotCollector">
   <!-- Use the SnapshotStore local resource for snapshots -->
   <TempFolder>%SNAPSHOTSTORE%</TempFolder>
   <!-- Other SnapshotCollector configuration options -->
 </Add>
</TelemetryProcessors>

シャドウコピーフォルダーのオーバーライド

Snapshot Collector を起動すると、Snapshot Uploader プロセスを実行するのに適したディスク上のフォルダーが検索されます。選択されたフォルダーは、シャドウコピーフォルダーと呼ばれます。

Snapshot Collector は、いくつかのよく知られている場所を確認し、Snapshot Uploader のバイナリをコピーするアクセス許可があることを確認します。次の環境変数が使用されます。

Fabric_Folder_App_Temp
LOCALAPPDATA
APPDATA
TEMP

適切なフォルダーが見つからない場合は、Snapshot Collector によって " "Could not find a suitable shadow copy folder (適切なシャドウコピーフォルダーが見つかりません)" " というエラーが報告されます。

コピーに失敗した場合、Snapshot Collector は ShadowCopyFailed エラーを報告します。

アップローダーを起動できない場合、Snapshot Collector は UploaderCannotStartFromShadowCopy エラーを報告します。メッセージの本文に System.UnauthorizedAccessException が含まれることがよくあります。このエラーは、通常、アクセス許可が制限されたアカウントの下でアプリケーションが実行されているために発生します。このアカウントには、シャドウコピーフォルダーに書き込むためのアクセス許可が与えられていますが、コードを実行するためのアクセス許可が与えられていません。

これらのエラーは通常、起動時に発生するため、"Uploader failed to start (アップローダーを起動できませんでした)" という ExceptionDuringConnect エラーが続いて表示されます。

これらのエラーを回避するには、ShadowCopyFolder 構成オプションを使用して、シャドウコピーフォルダーを手動で指定します。たとえば、ApplicationInsights.config を使用する場合は、次のように指定します。

<TelemetryProcessors>
 <Add Type="Microsoft.ApplicationInsights.SnapshotCollector.SnapshotCollectorTelemetryProcessor, Microsoft.ApplicationInsights.SnapshotCollector">
   <!-- Override the default shadow copy folder. -->
   <ShadowCopyFolder>D:\SnapshotUploader</ShadowCopyFolder>
   <!-- Other SnapshotCollector configuration options -->
 </Add>
</TelemetryProcessors>

または、.NET Core アプリケーションで appsettings.json を使用する場合は、次のように指定します。

{
  "ApplicationInsights": {
    "InstrumentationKey": "<your instrumentation key>"
  },
  "SnapshotCollectorConfiguration": {
    "ShadowCopyFolder": "D:\\SnapshotUploader"
  }
}

Application Insights 検索を使用してスナップショット付きの例外を検索する

スナップショットが作成されている場合、例外がスローされるとスナップショット ID がタグ付けされます。 Application Insights に例外が報告されると、そのスナップショット ID はカスタムプロパティとして含まれます。 Application Insights の [検索] を使用すると、ai.snapshot.id カスタムプロパティを持つすべてのレコードを見つけることができます。

Azure Portal の Application Insights のリソースを参照します。
[Search] を選択します。
[検索] テキストボックスに ai.snapshot.id と入力し、Enter キーを押します。

この検索で結果が返されない場合は、選択された時間範囲内に Application Insights に報告されたスナップショットがなかったことを示しています。

アップローダーログから特定のスナップショット ID を検索するには、[検索] ボックスにその ID を入力します。アップロードされたことがわかっているスナップショットのレコードを検出できない場合は、こちらの手順に従ってください。

インストルメンテーションキーを確認することにより、正しい Application Insights のリソースを探していることを再確認します。
アップローダーログからのタイムスタンプを使用して、その時間範囲をカバーするように検索の時間範囲フィルターを調整します。

それでもそのスナップショット ID の例外が表示されない場合、例外レコードは Application Insights に報告されていません。この状況は、スナップショットの作成後、例外レコードを報告する前に、アプリケーションがクラッシュした場合に発生する可能性があります。この場合、Diagnose and solve problems で App Service を確認し、予期しない再起動またはハンドルされない例外があったかどうかを確認します。

ネットワークプロキシまたはファイアウォール規則を編集する

アプリケーションがプロキシまたはファイアウォール経由でインターネットに接続される場合は、スナップショットデバッガーサービスと通信するように規則を更新する必要がある場合があります。

Application Insights スナップショットデバッガーで使用される IP は、Azure Monitor サービスタグに含まれています。詳細については、サービスタグに関するドキュメントを参照してください。

スナップショットを使用する場合、課金コストはありますか?

スナップショットデバッガー固有のサブスクリプションに対する料金は発生しません。収集されたスナップショットファイルは、Application Insights SDK によって収集されたテレメトリとは別に保存され、スナップショットのインジェストまたはストレージに対する料金は発生しません。

Application Insights Snapshot Debugger の有効化やスナップショットの表示に関する問題のトラブルシューティング

サポートされていないシナリオ

適切なスナップショットデバッガーエンドポイントを使用していることを確認する

スナップショットの正常性チェックを使用する

インストルメンテーションキーの確認

TLS/SSL クライアント設定の確認 (ASP.NET)

.NET Core のプレビューバージョン

診断サービスのサイト拡張機能の状態ページを確認する

最新バージョンの NuGet にアップグレードする

アップローダーログの確認

クラウドサービスのトラブルシューティング

シャドウコピーフォルダーのオーバーライド

Application Insights 検索を使用してスナップショット付きの例外を検索する

ネットワークプロキシまたはファイアウォール規則を編集する

スナップショットを使用する場合、課金コストはありますか?

その他のリソース

Application Insights Snapshot Debugger の有効化やスナップショットの表示に関する問題のトラブルシューティング

サポートされていないシナリオ

適切なスナップショット デバッガー エンドポイントを使用していることを確認する

スナップショットの正常性チェックを使用する

インストルメンテーション キーの確認

TLS/SSL クライアント設定の確認 (ASP.NET)

.NET Core のプレビュー バージョン

診断サービスのサイト拡張機能の状態ページを確認する

最新バージョンの NuGet にアップグレードする

アップローダー ログの確認

クラウド サービスのトラブルシューティング

シャドウ コピー フォルダーのオーバーライド

Application Insights 検索を使用してスナップショット付きの例外を検索する

ネットワーク プロキシまたはファイアウォール規則を編集する

スナップショットを使用する場合、課金コストはありますか?

その他のリソース

適切なスナップショットデバッガーエンドポイントを使用していることを確認する

インストルメンテーションキーの確認

.NET Core のプレビューバージョン

アップローダーログの確認

クラウドサービスのトラブルシューティング

シャドウコピーフォルダーのオーバーライド

ネットワークプロキシまたはファイアウォール規則を編集する