Azure クラウドサービス向けの Application Insights

[アーティクル]
06/02/2022

Application Insights では、Application Insights SDK からのデータとお客様のクラウドサービスからの Azure 診断データを組み合わせることで、Azure クラウドサービスアプリの可用性、パフォーマンス、障害、使用状況を監視できます。アプリのパフォーマンスと効果に関するフィードバックが得られたら、各開発ライフサイクルにおける設計の方向性について、情報に基づいて選択できます。

概要ダッシュボード

Note

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

前提条件

開始する前に、次のことが必要です。

Azure サブスクリプション。

Windows、Xbox Live、またはその他の Microsoft クラウドサービスの Microsoft アカウントでサインインします。
Microsoft Azure Tools 2.9 以降。
Developer Analytics Tools 7.10 以降。

すぐに使い始められる

Application Insights を使ってクラウドサービスを監視する最も早くて簡単な方法は、サービスを Azure に発行するときにそのオプションを選択することです。

[診断設定] ページの例

このオプションでは、お客様のアプリが実行時にインストルメント化され、お客様の Web ロールで要求、例外、依存関係を監視するのに必要なすべてのテレメトリが提供されます。また、お客様の worker ロールからのパフォーマンスカウンターを監視します。お客様のアプリによって生成された診断トレースも Application Insights に送信されます。

このオプションで十分な場合、これで完了です。

次の手順は、アプリからのメトリックの表示、および Analytics によるデータのクエリの実行です。

ブラウザーでパフォーマンスを監視するには、可用性テストを設定して、お客様の Web ページにコードを追加することもできます。

以下のセクションでは、次の追加のオプションについて説明します。

さまざまなコンポーネントからデータを送信し、リソースを分離するための構成をビルドします。
アプリからカスタムテレメトリを追加します。

Application Insights を使用してインストルメント化されたサンプルアプリ

こちらのサンプルアプリでは、Application Insights がクラウドサービスに追加され、2 つの worker ロールが Azure でホストされています。

次のセクションでは、同じ方法でお客様自身のクラウドサービスプロジェクトを調整する方法について説明します。

リソースとリソースグループを計画する

お客様のアプリからのテレメトリは、Application Insights 型の Azure リソースで格納、分析、表示されます。

各リソースはリソースグループに属しています。リソースグループは、コストの管理、チームメンバーへのアクセスの許可、調整された単一のトランザクションでの更新のデプロイに使用されます。たとえば、1 回の操作で Azure クラウドサービスとその Application Insights 監視リソースをデプロイするスクリプトを記述できます。

コンポーネント用のリソース

ディメンションプロパティを、そのソースロールを識別する各テレメトリ項目に追加することをお勧めします。この方法では、例外などのメトリックグラフに通常はさまざまなロールからのカウントの集計が表示されます。しかし、必要な場合にはロール識別子を使用してグラフを分割することができます。同じディメンションによって検索をフィルターすることもできます。この代替方法ではすべてを同時に表示するのが若干簡単になりますが、ロール間で混乱を招く可能性もあります。

通常、ブラウザーのテレメトリはサーバー側の Web ロールと同じリソースに含まれています。

さまざまなコンポーネント用の Application Insights リソースを 1 つのリソースグループに配置します。この方法により、まとめて管理することが簡単になります。

開発、テスト、運用の分離

前のバージョンがライブである間に次の機能用のカスタムイベントを開発する場合、開発に関するテレメトリを別の Application Insights リソースに送信する必要があります。そうしないと、ライブサイトから送信されるすべてのトラフィックの中からお客様のテストテレメトリを見つけることが難しくなります。

この状況を回避するには、お客様のシステムの各ビルド構成または "スタンプ" (開発、テスト、運用など) 用に別個のリソースを作成します。各ビルド構成用のリソースを別個のリソースグループに配置します。

テレメトリを適切なリソースに送信するには、ビルド構成に応じて異なるインストルメンテーションキーを選択するように Application Insights SDK を設定できます。

さまざまな段階のインストルメンテーションキーを動的に設定する方法について説明します。

役割ごとに Application Insights リソースを作成する

各ロール用に別個のリソースを作成する (場合によっては各ビルド構成用に別個のセットも作成する) ことにした場合、Application Insights ポータルでそれらすべてを作成するのが最も簡単です。リソースを多数作成する場合は、プロセスを自動化できます。

Azure portal で、 [新規作成]>[開発者サービス]>[Application Insights] の順に選択します。
[アプリケーションの種類] ドロップダウンリストで [ASP.NET Web アプリケーション] を選択します。

各リソースは、インストルメンテーションキーによって識別されます。このキーは、SDK を手動で構成したい場合や SDK の構成を確認したい場合に後で必要になる可能性があります。

Set up Azure Diagnostics for each role (各ロール用の Azure 診断を設定する)

このオプションは、Application Insights でアプリを監視する場合に設定します。 Web ロールの場合は、このオプションによってパフォーマンスの監視、アラート、診断、使用状況の分析が提供されます。その他のロールの場合は、再起動、パフォーマンスカウンター、System.Diagnostics.Trace への呼び出しなど、Azure 診断を検索して監視できます。

Visual Studio ソリューションエクスプローラーの [<YourCloudService>]>[ロール] で、各ロールのプロパティを開きます。
[構成] で [診断データを Application Insights に送信する] チェックボックスをオンにしてから、お客様が先ほど作成した Application Insights リソースを選択します。

各ビルド構成に対して別個の Application Insights リソースを使用することにした場合は、まず構成を選択します。

Application Insights の構成

これにより、お客様の Application Insights インストルメンテーションキーが ServiceConfiguration.*.cscfg という名前のファイルに挿入されます。こちらにサンプルコードがあります。

Application Insights に送信される診断情報のレベルを変更したい場合、.cscfg ファイルを直接編集することで実行できます。

各プロジェクトに SDK をインストールする

このオプションでは、カスタムビジネステレメトリを任意のロールに追加できます。お客様のアプリの使用状況とパフォーマンスについてより詳しい分析が得られます。

Visual Studio で、Application Insights SDK を各クラウドアプリプロジェクト用に構成します。

Web ロールを構成するには、プロジェクトを右クリックし、[Application Insights の構成] を選択するか、または [追加] > [Application Insights のテレメトリ] の順に選択します。
worker ロールを構成するには:

a. プロジェクトを右クリックし、 [NuGet パッケージの管理] を選択します。

b. Windows サーバー用の Application Insights を追加します。
データを Application Insights リソースに送信するように SDK を構成するには:

a. 適切なスタートアップ関数で、 .cscfg ファイルに含まれている構成設定のインストルメンテーションキーを設定します。
```
    TelemetryConfiguration configuration = TelemetryConfiguration.CreateDefault();
    configuration.InstrumentationKey = RoleEnvironment.GetConfigurationSettingValue("APPINSIGHTS_INSTRUMENTATIONKEY");
    var telemetryClient = new TelemetryClient(configuration);
```
b. お客様のアプリの各ロールについて "手順 a." を繰り返します。次の例を参照してください。
ApplicationInsights.config ファイルが常に出力ディレクトリにコピーされるように設定します。

.config ファイルのメッセージによって、インストルメンテーションキーをそこに配置するよう求められます。ただし、クラウドアプリでは、それは .cscfg ファイルから設定することをお勧めします。この方法により、ポータルでロールが正しく識別されます。

完全な SQL クエリを収集するように Status Monitor を設定する (省略可能)

この手順は、.NET Framework で完全な SQL クエリをキャプチャする場合にのみ必要です。

\*.csdef ファイルに、次のように各ロールのスタートアップタスクを追加します

<Startup>
  <Task commandLine="AppInsightsAgent\InstallAgent.bat" executionContext="elevated" taskType="simple">
    <Environment>
      <Variable name="ApplicationInsightsAgent.DownloadLink" value="http://go.microsoft.com/fwlink/?LinkID=522371" />
      <Variable name="RoleEnvironment.IsEmulated">
        <RoleInstanceValue xpath="/RoleEnvironment/Deployment/@emulated" />
      </Variable>
    </Environment>
  </Task>
</Startup>

InstallAgent.bat と InstallAgent.ps1 をダウンロードし、各ロールプロジェクトの AppInsightsAgent フォルダーに配置します。必ず Visual Studio のファイルのプロパティまたはビルドスクリプトを使用して、それらを出力ディレクトリにコピーします。

すべての worker ロールに環境変数を追加します。

  <Environment>
    <Variable name="COR_ENABLE_PROFILING" value="1" />
    <Variable name="COR_PROFILER" value="{324F817A-7420-4E6D-B3C1-143FBED6D855}" />
    <Variable name="MicrosoftInstrumentationEngine_Host" value="{CA487940-57D2-10BF-11B2-A3AD5A13CBC0}" />
  </Environment>

アプリを実行して発行する

お客様のアプリを実行し、Azure にサインインします。
お客様が作成した Application Insights リソースを開きます。

個別のデータポイントは [検索] に表示され、集計されたデータは [メトリックエクスプローラー] に表示されます。
さらにテレメトリを追加し (以下のセクションを参照)、お客様のアプリを発行して、ライブの診断と使用状況のフィードバックを取得します。

データがない場合、以下の手順を実行します。

個別のイベントを表示するには、[検索] タイルを開きます。
アプリで、テレメトリがいくつか生成されるようにさまざまなページを開きます。
数秒待ってから [最新の情報に更新] をクリックします。

Azure 診断イベントを表示する

Application Insights の Azure 診断情報は、以下の場所にあります。

パフォーマンスカウンターは、カスタムメトリックとして表示されます。
Windows イベントログは、トレースとカスタムイベントとして表示されます。
アプリケーションログ、ETW ログ、診断インフラストラクチャログは、トレースとして表示されます。

パフォーマンスカウンターおよびイベント数を表示するには、[メトリックスエクスプローラー] を開き、次のグラフを追加します。

Azure 診断データ

Azure 診断によって送信されるさまざまなトレースログ全体を検索するには、[検索] または Analytics クエリを使用します。たとえば、ハンドルされない例外が発生し、それによってロールがクラッシュしてリサイクルされたとします。その情報は、Windows イベントログのアプリケーションチャンネルに表示されます。 [検索] を使用して Windows イベントログのエラーを表示し、例外の完全なスタックトレースを取得できます。これは、問題の根本原因の発見に役立ちます。

Azure 診断の検索

テレメトリの追加

以下のセクションでは、お客様のアプリのさまざまな側面に関して追加のテレメトリを取得する方法を説明します。

worker ロールからの要求を追跡する

Web ロールでは、HTTP 要求に関するデータが要求モジュールによって自動的に収集されます。既定の収集動作をオーバーライドする方法の例については、サンプルの MVCWebRole を参照してください。

HTTP 要求の場合と同じ方法で追跡することで、worker ロールの呼び出しのパフォーマンスを記録できます。 Application Insights では、"要求" 型のテレメトリは、サーバー側で名前を付け、時間を指定し、個別に成功と失敗を判定できる作業単位を測定できます。 SDK によって HTTP 要求が自動的にキャプチャされますが、独自のコードを挿入して worker ロールへの要求を追跡できます。

要求を報告するためにインストルメント化された 2 つのサンプル worker ロール

例外

ハンドルされない例外を各種の Web アプリから収集する方法の詳細については、Application Insights での例外の監視に関するページを参照してください。

サンプルの web ロールには MVC5 コントローラーおよび Web API 2 コントローラーが含まれています。この 2 つからのハンドルされない例外は、以下のハンドラーを使用してキャプチャされます。

MVC5 コントローラー向けの AiHandleErrorAttribute 設定 (こちらの例を参照)
Web API 2 コントローラー向けの AiWebApiExceptionLogger 設定 (こちらの例を参照 )

worker ロールの場合、2 つの方法で例外を追跡できます。

TrackException(ex) を使用します。
Application Insights トレースリスナー NuGet パッケージを追加した場合、こちらの例に示すように、System.Diagnostics.Trace を使用して例外を記録できます。

パフォーマンスカウンター

既定では、次のカウンターが収集されます。

\Process(??APP_WIN32_PROC??)% Processor Time
\Memory\Available Bytes
.NET CLR Exceptions(??APP_CLR_PROC??)# of Exceps Thrown / sec
\Process(??APP_WIN32_PROC??)\Private Bytes
\Process(??APP_WIN32_PROC??)\IO Data Bytes/sec
\Processor(_Total)% Processor Time

Web ロールの場合、以下のカウンターも収集されます。

\ASP.NET Applications(??APP_W3SVC_PROC??)\Requests/Sec
\ASP.NET Applications(??APP_W3SVC_PROC??)\Request Execution Time
\ASP.NET Applications(??APP_W3SVC_PROC??)\Requests In Application Queue

追加のカスタムパフォーマンスカウンターやその他の Windows パフォーマンスカウンターは、こちらの例に示すように、ApplicationInsights.config を編集することで指定できます。

パフォーマンスカウンター

worker ロールの関連付けられたテレメトリ

リッチな診断エクスペリエンスでは、失敗した要求や待ち時間の長い要求の原因を確認できます。 Web ロールを使用すると、関連するテレメトリ間の関連付けが SDK によって自動的に設定されます。

worker ロールでこのビューを実現するには、カスタムのテレメトリ初期化子を使用して、共通の Operation.Id context 属性をすべてのテレメトリに設定します。これを行うと、待ち時間または失敗の問題の原因が依存関係とコードのどちらにあったかを一目で把握することができます。

その方法は次のとおりです。

こちらの例に示すように、correlationId を CallContext に設定します。このケースでは、要求 ID を correlationId として使用しています。
カスタムの TelemetryInitializer 実装を追加して、先ほど設定された correlationId に Operation.Id を設定します。例については、ItemCorrelationTelemetryInitializer を参照してください。
カスタムのテレメトリ初期化子を追加します。これは、ApplicationInsights.config ファイル内で実行できます。または、こちらの例に示すようにコードで実行できます。

クライアントテレメトリ

ページビュー数、ページの読み込み時間、スクリプトの例外など、ブラウザーベースのテレメトリを取得し、お客様のページスクリプトにカスタムテレメトリを記述するには、Web ページへの JavaScript SDK の追加に関するページを参照してください。

可用性テスト

お客様のアプリが動作していて応答することを確認するには、Web テストを設定します。

すべてをまとめて表示する

お客様のシステムの全体像を把握したい場合、主要な監視グラフを 1 つのダッシュボードにまとめて表示できます。たとえば、各ロールの要求と失敗のカウントをピン留めできます。

お客様のシステムで他の Azure サービス (Stream Analytics など) が使用されている場合は、それらの監視グラフも含めます。

クライアントのモバイルアプリがある場合は、App Center を使用してください。 Analytics でクエリを作成してイベントカウントを表示してから、それをダッシュボードにピン留めします。

例

この例では、1 つの Web ロールと 2 つの worker ロールが含まれたサービスを監視します。

Azure クラウドサービスにおける実行での例外 "メソッドが見つかりません"

.NET LTS でビルドした場合以前のバージョンは、Azure Cloud Services のロールでは自動的にサポートされません。アプリを実行する前に、.NET LTS を各ロールにインストールしてください。

次の方法で共有

Azure クラウドサービス向けの Application Insights

前提条件

すぐに使い始められる

Application Insights を使用してインストルメント化されたサンプルアプリ

リソースとリソースグループを計画する

コンポーネント用のリソース

開発、テスト、運用の分離

役割ごとに Application Insights リソースを作成する

Set up Azure Diagnostics for each role (各ロール用の Azure 診断を設定する)

各プロジェクトに SDK をインストールする

完全な SQL クエリを収集するように Status Monitor を設定する (省略可能)

アプリを実行して発行する

Azure 診断イベントを表示する

テレメトリの追加

worker ロールからの要求を追跡する

例外

パフォーマンスカウンター

worker ロールの関連付けられたテレメトリ

クライアントテレメトリ

可用性テスト

すべてをまとめて表示する

例

Azure クラウドサービスにおける実行での例外 "メソッドが見つかりません"

次のステップ

その他のリソース

次の方法で共有

Azure クラウド サービス向けの Application Insights

前提条件

すぐに使い始められる

Application Insights を使用してインストルメント化されたサンプル アプリ

リソースとリソース グループを計画する

コンポーネント用のリソース

開発、テスト、運用の分離

役割ごとに Application Insights リソースを作成する

Set up Azure Diagnostics for each role (各ロール用の Azure 診断を設定する)

各プロジェクトに SDK をインストールする

完全な SQL クエリを収集するように Status Monitor を設定する (省略可能)

アプリを実行して発行する

Azure 診断イベントを表示する

テレメトリの追加

worker ロールからの要求を追跡する

例外

パフォーマンス カウンター

worker ロールの関連付けられたテレメトリ

クライアント テレメトリ

可用性テスト

すべてをまとめて表示する

例

Azure クラウド サービスにおける実行での例外 "メソッドが見つかりません"

次のステップ

その他のリソース

Azure クラウドサービス向けの Application Insights

Application Insights を使用してインストルメント化されたサンプルアプリ

リソースとリソースグループを計画する

パフォーマンスカウンター

クライアントテレメトリ

Azure クラウドサービスにおける実行での例外 "メソッドが見つかりません"