Visual Studio でのスナップショットデバッグに関するトラブルシューティングと既知の問題

[アーティクル]
03/21/2023

適用対象: Visual Studio

この記事では、Visual Studio でスナップショットデバッガーを使用して Azure アプリをデバッグするときに発生する可能性がある一般的な問題の解決策について説明します。

この記事で説明されている手順で問題が解決しない場合は、visual Studio で [ヘルプ>フィードバック>の報告] を選択して、Developer Communityの問題を検索するか、新しい問題を報告します。

問題: "スナップショットデバッガーのアタッチ" で HTTP 状態コードエラーが発生する

アタッチの試行中に [出力 ] ウィンドウに次のエラーが表示される場合は、次のセクションに記載されている既知の問題である可能性があります。提案された解決策を試し、問題が解決しない場合は、前のエイリアスにお問い合わせください。

[TIMESTAMP] Error --- Unable to Start Snapshot Debugger - Attach Snapshot Debugger failed: System.Net.WebException: The remote server returned an error: (###) XXXXXX

(401) 未承認

このエラーは、Visual Studio から Azure への REST 呼び出しで無効な資格情報が使用されていることを示します。

次の手順を実行します。

Visual Studio の個人用設定アカウントに、アタッチする Azure サブスクリプションとリソースに対するアクセス許可があることを確認します。これを判断する簡単な方法は、デバッグ>アタッチスナップショットデバッガーのダイアログボックスでリソースを使用できるかどうかをチェックすることです。>Azure リソース>[既存] または [クラウドエクスプローラー] を選択します。
このエラーが解決しない場合は、この記事の冒頭で説明したフィードバックチャネルのいずれかを使用します。

App Serviceで認証/承認 (EasyAuth) を有効にしている場合は、呼び出し履歴のエラーメッセージで LaunchAgentAsync で 401 エラーが発生する可能性があります。 要求が認証されていない場合に実行するアクションが、Azure portalで [匿名要求を許可する (アクションなし)] に設定されていることを確認し、代わりに D:\Home\sites\wwwroot に次のコンテンツを含むauthorization.jsonを提供します。

{
  "routes": [
    {
      "path_prefix": "/",
      "policies": {
        "unauthenticated_action": "RedirectToLoginPage"
      }
    },
    {
      "http_methods": [ "POST" ],
      "path_prefix": "/41C07CED-2E08-4609-9D9F-882468261608/api/agent",
      "policies": {
        "unauthenticated_action": "AllowAnonymous"
      }
    }
  ]
}

最初のルートは、[ IdentityProvider] を使用したログインに似たアプリドメインを効果的にセキュリティで保護します。 2 番目のルートは、認証の外部で SnapshotDebugger AgentLaunch エンドポイントを公開します。これは、SnapshotDebugger のプレインストールされたサイト拡張機能がアプリサービスに対して有効になっている 場合にのみ 、SnapshotDebugger 診断エージェントを開始する定義済みのアクションを実行します。 authorization.json構成の詳細については、「URL 承認規則」を参照してください。

(403) 禁止

403 - 禁止エラーは、アクセス許可が拒否されたことを示します。さまざまなシナリオでこのエラーが発生する可能性があります。

次の手順を実行します。

Visual Studio アカウントに、リソースに必要な Role-Based Access Control (RBAC) アクセス許可を持つ有効な Azure サブスクリプションがあることを確認します。 AppService の場合は、アプリをホストしているApp Service プランに対してクエリを実行するアクセス許可があるかどうかをチェックします。
クライアントマシンのタイムスタンプが正しく、最新であることを確認します。通常、要求タイムスタンプの 15 分を超えるタイムスタンプがオフになっているサーバーでは、このエラーが発生します。
このエラーが解決しない場合は、この記事の冒頭で説明したフィードバックチャネルのいずれかを使用します。

(404) 見つかりません

404 - 見つからないエラーは、Web サイトがサーバーで見つからなかったことを示します。

次の手順を実行します。

アタッチするApp Service リソースで Web サイトがデプロイされ、実行されていることを確認します。
サイトが https://< resource.azurewebsites.net> で使用可能であることを確認します
適切に実行されているカスタム Web アプリケーションが、https://< resource.azurewebsites.net> でアクセスしたときに状態コード 404 が返されていないことを確認します。
このエラーが解決しない場合は、この記事の冒頭で説明したフィードバックチャネルのいずれかを使用します。

(406) 受け入れ不可

406 - 許容不可エラーは、サーバーが要求の Accept ヘッダーで設定された型に応答できないことを示します。

次の手順を実行します。

サイトが https://< resource.azurewebsites.net> で使用可能であることを確認します。
サイトが新しいインスタンスに移行されていないことを確認します。スナップショットデバッガーでは、このエラーを断続的に生成できる特定のインスタンスへの要求のルーティングに ARRAffinity という概念が使用されます。
このエラーが解決しない場合は、この記事の冒頭で説明したフィードバックチャネルのいずれかを使用します。

(409) 競合

409 - 競合エラーは、要求が現在のサーバーの状態と競合していることを示します。

これは、ユーザーが ApplicationInsights を有効にしている AppService に対してスナップショットデバッガーをアタッチしようとしたときに発生する既知の問題です。 ApplicationInsights では、Visual Studio とは異なる大文字と小文字で AppSettings が設定され、この問題が発生します。

Visual Studio 2019 でこれを解決しました。

次の手順を実行します。

このエラーが解決しない場合は、この記事の冒頭で説明したフィードバックチャネルのいずれかを使用します。

(500) 内部サーバーエラー

500 - 内部サーバーエラーエラーは、サイトがダウンしているか、サーバーが要求を処理できないことを示します。スナップショットデバッガーは、実行中のアプリケーションでのみ機能します。 Application Insights Snapshot Debugger では、例外のスナップショットが提供され、ニーズに最適なツールになる場合があります。

(502) 無効なゲートウェイ

502 - 不正なゲートウェイエラーは、サーバー側のネットワークの問題を示し、一時的な可能性があります。

次の手順を実行します。

スナップショットデバッガーをもう一度アタッチする前に、数分待ってみてください。
このエラーが解決しない場合は、この記事の冒頭で説明したフィードバックチャネルのいずれかを使用します。

問題: スナップポイントがオンになっていない

通常のスナップポイントアイコンではなく、スナップポイントを含む警告アイコンが表示された場合、スナップポイントはオンになりません。

Snappoint がオンになっていないことを示すスクリーンショット。

次の手順を実行します。

同じバージョンのソースコードを使用して、アプリをビルドしてデプロイしてください。
デプロイに適したシンボルを読み込んでいる必要があります。
これを行うには、スナップショットデバッグ中に [モジュール ] ウィンドウを表示し、[シンボルファイル] 列に、デバッグ中のモジュール用に読み込まれた .pdb ファイルが表示されていることを確認します。
- スナップショットデバッガーは、デプロイにシンボルを自動的にダウンロードして使用しようとします。

問題: スナップショットを開くときにシンボルが読み込まれない

次のウィンドウが表示された場合、シンボルは読み込まれませんでした。

シンボルが読み込まれないことを示すスクリーンショット。

次の手順を実行します。

ページで [ シンボル設定の変更... ] を選択します。
[シンボルのデバッグ>] 設定で、シンボルキャッシュディレクトリを追加します。
シンボルパスが設定された後スナップショットデバッグを再起動します。

プロジェクトで使用できるシンボル (.pdb ファイル) は、App Service配置と一致している必要があります。ほとんどのデプロイ (Visual Studio を使用したデプロイ、Azure Pipelines または Kudu を使用した CI/CD など) では、シンボルファイルがApp Serviceに公開されます。シンボルキャッシュディレクトリを設定すると、Visual Studio でこれらのシンボルを使用できます。
または、organizationがシンボルサーバーを使用している場合、または別のパスにシンボルをドロップする場合は、シンボル設定を使用して、デプロイに適したシンボルを読み込みます。

問題: クラウドエクスプローラーに [スナップショットデバッガーのアタッチ] オプションが表示されない

次の手順を実行します。

スナップショットデバッガーコンポーネントがインストールされていることを確認します。 Visual Studio インストーラーを開き、Azure ワークロードのスナップショットデバッガー コンポーネントをチェックします。
Visual Studio 2019 以降のバージョンの場合は、アプリがサポートされていることを確認します。
- Azure アプリサービス - .NET Framework 4.6.1 以降で実行されているアプリケーションを ASP.NET します。
- Azure アプリサービス - Windows 上の .NET Core 2.0 以降で実行されているアプリケーションを ASP.NET Coreします。
- Azure Virtual Machines (および仮想マシンスケールセット) - .NET Framework 4.6.1 以降で実行されているアプリケーションを ASP.NET します。
- Azure Virtual Machines (および仮想マシンスケールセット) - Windows 上の .NET Core 2.0 以降で実行されているアプリケーションを ASP.NET Coreします。
- Azure Kubernetes Services - debian 9 で .NET Core 2.2 以降で実行されているアプリケーションを ASP.NET Coreします。
- Azure Kubernetes Services - Alpine 3.8 で .NET Core 2.2 以降で実行されているアプリケーションを ASP.NET Coreします。
- Azure Kubernetes Services - Ubuntu 18.04 で .NET Core 2.2 以降で実行されているアプリケーションを ASP.NET Coreします。

問題: 診断ツールで調整されたスナップショットのみが表示される

調整されたスナップポイントを示すスクリーンショット。

次の手順を実行します。

スナップショットはメモリをほとんど占有しませんが、コミット料金がかかります。スナップショットデバッガーによって、サーバーのメモリ負荷が高い状態であることが検出された場合、スナップショットは取得されません。スナップショットデバッガーセッションを停止してもう一度試すことで、既にキャプチャされたスナップショットを削除できます。

問題: 複数のバージョンの Visual Studio を使用したスナップショットデバッグでエラーが発生する (Visual Studio 2019 以降のバージョン)

Visual Studio 2019 では、Azure App Serviceのスナップショットデバッガーサイト拡張機能の新しいバージョンが必要です。このバージョンは、Visual Studio 2017 で使用されている以前のバージョンのスナップショットデバッガーサイト拡張機能と互換性がありません。 Visual Studio 2019 のスナップショットデバッガーを、Visual Studio 2017 のスナップショットデバッガーによって以前にデバッグされたAzure App Serviceにアタッチしようとすると、次のエラーが発生します。

互換性のないスナップショットデバッガーサイト拡張機能 Visual Studio 2019 のスクリーンショット。

逆に、Visual Studio 2017 を使用して、以前に Visual Studio 2019 のスナップショットデバッガーによってデバッグされたAzure App Serviceにスナップショットデバッガーをアタッチすると、次のエラーが発生します。

互換性のないスナップショットデバッガーサイト拡張機能 Visual Studio 2017 のスクリーンショット。

これを修正するには、Azure portalで次のアプリ設定を削除し、スナップショットデバッガーをもう一度アタッチします。

INSTRUMENTATIONENGINE_EXTENSION_VERSION
SNAPSHOTDEBUGGER_EXTENSION_VERSION

問題: 間違った/古い Azure リソースまたはストレージアカウントにアタッチしています

次の手順を実行します。

"Azure リソース" エントリと "ストレージアカウント" エントリでは、リソース名がキーとして使用されるため、リソースを別のサブスクリプションに移行するなどのアクションが問題を引き起こす可能性があります。一覧をクリアするには、次の手順に従います。

VS の開発者コマンドプロンプトでこれらのコマンドを実行します (管理者特権)。

vsregedit remove local HKCU SnapshotDebugger AzureResourcesMRU
vsregedit remove local HKCU SnapshotDebugger StorageAccountsMRU

Web アプリに関連付けられている .suo ファイルを削除します。

問題: スナップショットデバッグに問題があり、さらにログ記録を有効にする必要がある

エージェントログを有効にする

エージェントのログ記録を有効または無効にするには、Visual Studio を開き 、[ツール>オプション] [>スナップショットデバッガー>] [エージェントログの有効化] の順に移動します。 [セッションの開始時に古いエージェントログを削除する] も有効になっている場合、正常にアタッチされるたびに以前のエージェントログが削除されます。

エージェントログは、次の場所にあります。

App Services:
- App Serviceの Kudu サイト (つまり、<yourappservice) に移動します>。scm.azurewebsites.net) を選択し、[デバッグコンソール] に移動します。
- エージェントログは、 D:\home\LogFiles\SiteExtensions\DiagnosticsAgentLogs\ というディレクトリに格納されます。
VM/VMSS:
- VM にサインインすると、エージェントログは次のように格納されます: C:\WindowsAzure\Logs\Plugins\Microsoft.Azure.Diagnostics.IaaSDiagnostics<Version>\SnapshotDebuggerAgent*.txt_
Aks
- 次のディレクトリに移動します: /tmp/diag/AgentLogs/*

Profiler/Instrumentation ログを有効にする

インストルメンテーションログは、次の場所にあります。

App Services:
- エラーログは、 D:\Home\LogFiles\eventlog.xmlに自動的に送信され、イベントはまたは "運用ブレークポイント" で <Provider Name="Instrumentation Engine" /> マークされます
VM/VMSS:
- VM にサインインし、イベントビューアーを開きます。
- 次のビューを開きます: Windows ログ>アプリケーション。
- 運用ブレークポイントまたはインストルメンテーションエンジンを使用して、イベントソースで現在のログをフィルター処理します。
Aks
- /tmp/diag/log.txt でのインストルメンテーションエンジンのログ記録 (DockerFile で設定MicrosoftInstrumentationEngine_FileLogPath)
- /tmp/diag/shLog.txt での ProductionBreakpoint ログ記録

既知の問題

同じApp Serviceに対して複数の Visual Studio クライアントを使用したスナップショットデバッグは現在サポートされていません。
Roslyn IL の最適化は、ASP.NET Core プロジェクトでは完全にはサポートされていません。一部の ASP.NET Core プロジェクトでは、一部の変数を表示できない場合や、条件ステートメントで一部の変数を使用できない場合があります。
または $CALLERなどの$FUNCTION特殊な変数は、ASP.NET Core プロジェクトの条件付きステートメントやログポイントでは評価できません。
ローカルキャッシュが有効になっている App Services では、スナップショットのデバッグは機能しません。
スナップショットデバッグ API Apps は現在サポートされていません。

サイト拡張機能のアップグレード

スナップショットデバッグと Application Insights は、サイトプロセスに読み込まれる ICorProfiler に依存し、アップグレード中にファイルロックの問題が発生します。運用サイトにダウンタイムがないことを確認するには、このプロセスをお勧めします。

App Service内にデプロイスロットを作成し、サイトをスロットにデプロイします。
Visual Studio のクラウドエクスプローラーまたはAzure portalから、スロットを運用環境と交換します。
スロットサイトを停止します。すべてのインスタンスからサイト w3wp.exe プロセスを強制終了するには数秒かかります。
Kudu サイトまたは Azure portal (App Service ブレード>開発ツール>拡張機能の更新プログラム) からスロットサイト拡張機能を>アップグレードします。
スロットサイトを起動します。サイトにアクセスして、もう一度ウォームアップすることをお勧めします。
スロットを運用環境と交換します。

Visual Studio でのスナップショットデバッグに関するトラブルシューティングと既知の問題

問題: "スナップショットデバッガーのアタッチ" で HTTP 状態コードエラーが発生する

(401) 未承認

(403) 禁止

(404) 見つかりません

(406) 受け入れ不可

(409) 競合

(500) 内部サーバーエラー

(502) 無効なゲートウェイ

問題: スナップポイントがオンになっていない

問題: スナップショットを開くときにシンボルが読み込まれない

問題: クラウドエクスプローラーに [スナップショットデバッガーのアタッチ] オプションが表示されない

問題: 診断ツールで調整されたスナップショットのみが表示される

問題: 複数のバージョンの Visual Studio を使用したスナップショットデバッグでエラーが発生する (Visual Studio 2019 以降のバージョン)

問題: 間違った/古い Azure リソースまたはストレージアカウントにアタッチしています

問題: スナップショットデバッグに問題があり、さらにログ記録を有効にする必要がある

エージェントログを有効にする

Profiler/Instrumentation ログを有効にする

既知の問題

サイト拡張機能のアップグレード

関連情報

フィードバック

フィードバック

その他のリソース

Visual Studio でのスナップショットデバッグに関するトラブルシューティングと既知の問題

問題: "スナップショット デバッガーのアタッチ" で HTTP 状態コード エラーが発生する

(401) 未承認

(403) 禁止

(404) 見つかりません

(406) 受け入れ不可

(409) 競合

(500) 内部サーバー エラー

(502) 無効なゲートウェイ

問題: スナップポイントがオンになっていない

問題: スナップショットを開くときにシンボルが読み込まれない

問題: クラウド エクスプローラーに [スナップショット デバッガーのアタッチ] オプションが表示されない

問題: 診断ツールで調整されたスナップショットのみが表示される

問題: 複数のバージョンの Visual Studio を使用したスナップショット デバッグでエラーが発生する (Visual Studio 2019 以降のバージョン)

問題: 間違った/古い Azure リソースまたはストレージ アカウントにアタッチしています

問題: スナップショット デバッグに問題があり、さらにログ記録を有効にする必要がある

エージェント ログを有効にする

Profiler/Instrumentation ログを有効にする

既知の問題

サイト拡張機能のアップグレード

関連情報

フィードバック

フィードバック

その他のリソース

問題: "スナップショットデバッガーのアタッチ" で HTTP 状態コードエラーが発生する

(500) 内部サーバーエラー

問題: クラウドエクスプローラーに [スナップショットデバッガーのアタッチ] オプションが表示されない

問題: 複数のバージョンの Visual Studio を使用したスナップショットデバッグでエラーが発生する (Visual Studio 2019 以降のバージョン)

問題: 間違った/古い Azure リソースまたはストレージアカウントにアタッチしています

問題: スナップショットデバッグに問題があり、さらにログ記録を有効にする必要がある

エージェントログを有効にする