スナップショット デバッガーを使用してライブ ASP.NET Azure アプリをデバッグする
スナップショット デバッガーは、対象コードの実行時に実稼働アプリのスナップショットを取得します。 スナップショットを取得するようにデバッガーに指示するには、コードでスナップショットとログポイントを設定します。 デバッガーでは、実稼働アプリケーションのトラフィックに影響を与えることなく、問題を正確に確認できます。 スナップショット デバッガーは、実稼働環境で発生する問題の解決にかかる時間を大幅に短縮するのに役立ちます。
スナップポイントとログポイントはブレークポイントと似ていますが、ブレークポイントとは異なり、スナップポイントはヒットしてもアプリケーションが停止しません。 通常、スナップポイントでスナップショットをキャプチャするには 10 から 20 ミリ秒かかります。
このチュートリアルでは、次のことを行います。
- スナップショット デバッガーを起動する
- スナップポイントを設定してスナップショットを表示する
- ログポイントを設定する
前提条件
スナップショット デバッガーは、Azure 開発ワークロードに対して Visual Studio 2017 Enterprise バージョン 15.5 以降でのみ使用できます。 ([個別のコンポーネント] タブの [デバッグとテスト]>[スナップショット デバッガー] にあります)。
まだインストールされていない場合、Visual Studio 2019 をインストールします。 以前の Visual Studio インストールから更新する場合は、Visual Studio インストーラーを実行し、ASP.NET および Web 開発ワークロードのスナップショット デバッガー コンポーネントを確認してください。
Basic 以上の Azure App Service プラン。
スナップショット コレクションは、Azure App Service で実行されている次の Web アプリで利用できます。
- .NET Framework 4.6.1 以降で実行されている ASP.NET アプリケーション。
- Windows の .NET Core 2.0 以降で実行されている ASP.NET Core アプリケーション。
プロジェクトを開いてスナップショット デバッガーを起動する
デバッグのスナップショットを取得するプロジェクトを開きます。
重要
デバッグのスナップショットを取得するには、Azure App Service に公開されているものと同じバージョンのソース コードを開く必要があります。
[デバッグ] > [スナップショット デバッガーのアタッチ] を選びます。プロジェクトがデプロイされる Azure App Service と Azure ストレージ アカウントを選び、[アタッチ] をクリックします。 スナップショット デバッガーは Azure Kubernetes Service と Azure Virtual Machines (VM) および Virtual Machine Scale Sets もサポートしています。
重要
初めて [スナップショット デバッガーのアタッチ] を選択した場合は、Azure App Service にスナップショット デバッガー サイト拡張機能をインストールするように求められます。 このインストールでは、Azure App Service を再起動する必要があります。
Note
(Visual Studio 2019 バージョン 16.2 以降) スナップショット デバッガーで、Azure クラウドのサポートが有効になりました。 選択する Azure リソースと Azure Storage アカウントの両方が、同じクラウドからのものであることを確認します。 企業の Azure コンプライアンス構成についてご不明な点がある場合は、Azure 管理者にお問い合わせください。
これで、Visual Studio はスナップショット デバッグ モードになりました。
[モジュール] ウィンドウは、Azure App Service のすべてのモジュールが読み込まれたときに表示されます (このウィンドウを開くには、[デバッグ] > [ウィンドウ] > [モジュール] を選びます)。
スナップポイントを設定する
コード エディターで、目的のコード行の横にある左側の余白をクリックしてスナップポイントを設定します。 実行されることがわかっているコードを選択します。
[コレクションの開始] をクリックしてスナップポイントを有効にします。
ヒント
スナップショットを表示するときはステップ実行できませんが、コード内に複数のスナップポイントを配置して、コードのさまざまな行の実行を追跡することができます。 コード内に複数のスナップポイントがある場合、スナップショット デバッガーでは、対応するスナップショットが同じエンドユーザー セッションに由来していることが確認されます。 スナップショット デバッガーでは、アプリをヒットするユーザーが多数の場合でもこの処理が実行されます。
スナップショットを作成する
スナップポイントを設定したら、Web サイトのブラウザー ビューに移動して、マークされたコード行を実行してスナップショットを手動で生成することも、ユーザーがサイトを使用してスナップショットを生成するのを待機することもできます。
スナップショット データを調べる
スナップポイントにヒットすると、[診断ツール] ウィンドウにスナップショットが表示されます。 このウィンドウを開くには、[デバッグ] > [ウィンドウ] > [診断ツールの表示] を選びます。
スナップポイントをダブルクリックして、コード エディターでスナップショットを開きます。
このビューから、変数にポイントしてデータヒントを表示し、[ローカル]、[ウォッチ]、および [コール スタック] ウィンドウを使用できます。また、式を評価することもできます。
Web サイト自体はまだ稼働中であり、エンド ユーザーは影響を受けません。 既定では、スナップポイントごとに 1 つのスナップショットのみがキャプチャされます。スナップショットがキャプチャされると、スナップポイントは無効になります。 そのスナップポイントで別のスナップショットをキャプチャする場合は、[コレクションの更新] をクリックしてスナップポイントを元に戻すことができます。
アプリにスナップポイントを追加して [コレクションの更新] ボタンをクリックして有効にすることもできます。
お困りの際は、 トラブルシューティングと既知の問題とスナップショットのデバッグに関する FAQ のページを参照してください。
条件付きスナップポイントを設定する
アプリで特定の状態を再現することが難しい場合は、条件付きスナップポイントの使用を検討してください。 条件付きスナップポイントを使用すると、変数値に調査する特定の値が含まれている場合など、いつスナップショットを取得するかを制御できます。 式、フィルター、またはヒット数を使用して条件を設定できます。
条件付きスナップポイントを作成するには
スナップポイント アイコン (白抜きの球) を右クリックして、[設定] を選択します。
スナップポイント設定ウィンドウで式を入力します。
前の図では、
visitor.FirstName == "Dan"のときにのみ、スナップポイントのスナップショットが取得されます。
ログポイントを設定する
スナップポイントにヒットしたときにスナップショットを取得するだけでなく、メッセージをログに記録する (つまりログポイントを作成する) ようにスナップポイントを構成することもできます。 ログポイントは、アプリを再配置することなく設定できます。 ログポイントは仮想的に実行されるので、実行中のアプリケーションには影響も副作用もありません。
ログポイントを作成するには
スナップポイント アイコン (青色の六角形) を右クリックして、[設定] を選択します。
スナップポイント設定ウィンドウで [アクション] を選択します。
[メッセージ] フィールドには、ログに記録する新しいログ メッセージを入力できます。 ログ メッセージ内の変数を中かっこで囲んで評価することもできます。
[出力ウィンドウに送信します] を選択した場合、ログポイントにヒットすると、メッセージが [診断ツール] ウィンドウに表示されます。
[アプリケーション ログに送信します] を選択した場合、ログポイントにヒットすると、App Insights など、
System.Diagnostics.Trace(.NET Core ではILogger) からメッセージを表示できる任意の場所にメッセージが表示されます。
関連するコンテンツ
このチュートリアルでは、App Service 用のスナップショット デバッガーの使用方法を学習しました。 必要に応じて、この機能の詳細な記事を参照してください。