Application Insights リソースの作成

[アーティクル]
01/05/2023

Azure Application Insights には、Microsoft Azure リソースのアプリケーションに関するデータが表示されます。したがって、新しいリソースの作成は、新しいアプリケーションを監視するための Application Insights の設定の一部です。新しいリソースを作成した後、そのインストルメンテーションキーを取得し、それを使用し Application Insights SDK を構成できます。インストルメンテーションキーにより、リソースとテレメトリがリンクされます。

重要

2024 年 2 月 29 日に、従来の Visual Studio Online Application Insights のサポートは終了します。ワークスペースベースの Visual Studio Online Application Insights に移行して、新しい機能を利用します。 2021 年 2 月以降に導入された新しいリージョンでは、クラシック Visual Studio Online Application Insights リソースの作成はサポートされていません。

Note

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

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

Application Insights リソースの作成

Azure portal にサインインし、Application Insights リソースを作成します。

左上隅にある [+] 記号をクリックします。開発者ツールを選択して、Application Insights を選択します

設定	値	説明
名前	`Unique value`	監視しているアプリを識別する名前。
リソースグループ	`myResourceGroup`	App Insights データをホストする新しいリソースグループまたは既存のリソースグループの名前。
リージョン	`East US`	お近くの場所か、アプリがホストされている場所の近くを選択します。
リソースモード	`Classic` または `Workspace-based`	ワークスペースベースのリソースを使用すると、Application Insights テレメトリを共通の Log Analyticsワークスペースに送信できます。詳細については、ワークスペースベースのリソースに関する記事を参照してください。

Note

異なるリソースグループ間で同じリソース名を使用できますが、グローバルに一意の名前を使用すると便利です。これは、必要な構文が簡略化するため、クロスリソースクエリを実行するする場合に便利です。

必須フィールドに適切な値を入力し、 [確認と作成] を選択します。

必須フィールドに値を入力し、[確認と作成] を選択します。

アプリが作成されると、新しいウィンドウが開きます。そのウィンドウには、監視対象アプリケーションに関するパフォーマンスと使用状況データが表示されます。

インストルメンテーションキーのコピー

インストルメンテーションキーにより、利用統計情報と関連付けるリソースが識別されます。インストルメンテーションキーをコピーして、アプリケーションのコードに追加する必要があります。

アプリケーションでの SDK のインストール

アプリで Application Insights SDK をインストールします。この手順は、アプリケーションの種類に大きく依存します。

インストルメンテーションキーを使用して、アプリケーションにインストールする SDK を構成します。

SDK には、追加コードを記述せずにテレメトリを送信する標準的なモジュールが含まれています。ユーザーの操作を追跡したり、問題をより詳しく診断したりするには、API を使用して、独自のテレメトリを送信します。

リソースの自動作成

PowerShell

新しい Application Insights リソースを作成します。

New-AzApplicationInsights [-ResourceGroupName] <String> [-Name] <String> [-Location] <String> [-Kind <String>]
 [-Tag <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

例

New-AzApplicationInsights -Kind java -ResourceGroupName testgroup -Name test1027 -location eastus

結果

Id                 : /subscriptions/{subid}/resourceGroups/testgroup/providers/microsoft.insights/components/test1027
ResourceGroupName  : testgroup
Name               : test1027
Kind               : web
Location           : eastus
Type               : microsoft.insights/components
AppId              : 8323fb13-32aa-46af-b467-8355cf4f8f98
ApplicationType    : web
Tags               : {}
CreationDate       : 10/27/2017 4:56:40 PM
FlowType           :
HockeyAppId        :
HockeyAppToken     :
InstrumentationKey : 00000000-aaaa-bbbb-cccc-dddddddddddd
ProvisioningState  : Succeeded
RequestSource      : AzurePowerShell
SamplingPercentage :
TenantId           : {subid}

このコマンドレットの詳細な PowerShell ドキュメントと、インストルメンテーションキーを取得する方法については、Azure PowerShell のドキュメントを参照してください。

Azure CLI (プレビュー)

プレビューの Application Insights Azure CLI コマンドにアクセスするには、まず次を実行する必要があります。

 az extension add -n application-insights

az extension add コマンドを実行しないと、az : ERROR: az monitor: 'app-insights' is not in the 'az monitor' command group. See 'az monitor --help'. のようなエラーメッセージが表示されます。

これで、以下を実行して Application Insights リソースを作成できるようになりました。

az monitor app-insights component create --app
                                         --location
                                         --resource-group
                                         [--application-type]
                                         [--kind]
                                         [--tags]

例

az monitor app-insights component create --app demoApp --location westus2 --kind web --resource-group demoRg --application-type web

結果

az monitor app-insights component create --app demoApp --location eastus --kind web --resource-group demoApp --application-type web
{
  "appId": "87ba512c-e8c9-48d7-b6eb-118d4aee2697",
  "applicationId": "demoApp",
  "applicationType": "web",
  "creationDate": "2019-08-16T18:15:59.740014+00:00",
  "etag": "\"0300edb9-0000-0100-0000-5d56f2e00000\"",
  "flowType": "Bluefield",
  "hockeyAppId": null,
  "hockeyAppToken": null,
  "id": "/subscriptions/{subid}/resourceGroups/demoApp/providers/microsoft.insights/components/demoApp",
  "instrumentationKey": "00000000-aaaa-bbbb-cccc-dddddddddddd",
  "kind": "web",
  "location": "eastus",
  "name": "demoApp",
  "provisioningState": "Succeeded",
  "requestSource": "rest",
  "resourceGroup": "demoApp",
  "samplingPercentage": null,
  "tags": {},
  "tenantId": {tenantID},
  "type": "microsoft.insights/components"
}

このコマンドの詳細な Azure CLI ドキュメントと、インストルメンテーションキーを取得する方法については、Azure CLI のドキュメントを参照してください。

既定のエンドポイントをオーバーライドする Application Insights

警告

エンドポイントの変更は推奨されません。接続文字列に移行することで、構成を簡素化し、エンドポイントを変更しなくて済むようになります。

Application Insights から特定のリージョンにデータを送信するには、既定のエンドポイントアドレスをオーバーライドする必要があります。 SDK ごとに必要な変更点は若干異なります。そのすべてについてこの記事で説明します。これらの変更には、サンプルコードを調整し、QuickPulse_Endpoint_Address、TelemetryChannel_Endpoint_Address、および Profile_Query_Endpoint_address のプレースホルダー値をお客様の特定のリージョンに対応する実際のエンドポイントアドレスに置き換える必要があります。この記事の末尾には、この構成が必要なリージョンのエンドポイントアドレスのリンクを記載しています。

Note

SDK コードの変更

Note

applicationinsights.config ファイルは、SDK のアップグレードが実行されるたびに自動的に上書きされます。 SDK のアップグレードを実行した後は、リージョン固有のエンドポイント値を必ず再入力します。

<ApplicationInsights>
  ...
  <TelemetryModules>
    <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse.QuickPulseTelemetryModule, Microsoft.AI.PerfCounterCollector">
      <QuickPulseServiceEndpoint>Custom_QuickPulse_Endpoint_Address</QuickPulseServiceEndpoint>
    </Add>
  </TelemetryModules>
   ...
  <TelemetrySinks>
    <Add Name = "default">
      <TelemetryChannel>
         <EndpointAddress>TelemetryChannel_Endpoint_Address</EndpointAddress>
      </TelemetryChannel>
    </Add>
  </TelemetrySinks>
  ...
  <ApplicationIdProvider Type="Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId.ApplicationInsightsApplicationIdProvider, Microsoft.ApplicationInsights">
    <ProfileQueryEndpoint>Profile_Query_Endpoint_address</ProfileQueryEndpoint>
  </ApplicationIdProvider>
  ...
</ApplicationInsights>

メインエンドポイントを調整するには、プロジェクト内の appsettings.json ファイルを次のように変更します。

"ApplicationInsights": {
    "InstrumentationKey": "instrumentationkey",
    "TelemetryChannel": {
      "EndpointAddress": "TelemetryChannel_Endpoint_Address"
    }
  }

Live Metrics と Profile Query Endpoint の値を設定するには、コードを使用する必要があります。コードを使用してすべてのエンドポイント値の既定値をオーバーライドするには、Startup.cs ファイルの ConfigureServices メソッドを次のように変更します。

using Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId;
using Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse; //Place at top of Startup.cs file

   services.ConfigureTelemetryModule<QuickPulseTelemetryModule>((module, o) => module.QuickPulseServiceEndpoint="QuickPulse_Endpoint_Address");

   services.AddSingleton<IApplicationIdProvider, ApplicationInsightsApplicationIdProvider>(_ => new ApplicationInsightsApplicationIdProvider() { ProfileQueryEndpoint = "Profile_Query_Endpoint_address" });

   services.AddSingleton<ITelemetryChannel>(_ => new ServerTelemetryChannel() { EndpointAddress = "TelemetryChannel_Endpoint_Address" });

    //Place in the ConfigureServices method. Place this before services.AddApplicationInsightsTelemetry("instrumentation key"); if it's present

既定のエンドポイントアドレスを変更するように applicationinsights.xml ファイルを変更します。

<?xml version="1.0" encoding="utf-8"?>
<ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings">
  <InstrumentationKey>ffffeeee-dddd-cccc-bbbb-aaaa99998888</InstrumentationKey>
  <TelemetryModules>
    <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebRequestTrackingTelemetryModule"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebSessionTrackingTelemetryModule"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebUserTrackingTelemetryModule"/>
  </TelemetryModules>
  <TelemetryInitializers>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebOperationIdTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebOperationNameTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebSessionTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebUserTelemetryInitializer"/>
    <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebUserAgentTelemetryInitializer"/>
  </TelemetryInitializers>
  <!--Add the following Channel value to modify the Endpoint address-->
  <Channel type="com.microsoft.applicationinsights.channel.concrete.inprocess.InProcessTelemetryChannel">
  <EndpointAddress>TelemetryChannel_Endpoint_Address</EndpointAddress>
  </Channel>
</ApplicationInsights>

Spring Boot

application.properties ファイルを変更して以下を追加します。

azure.application-insights.channel.in-process.endpoint-address= TelemetryChannel_Endpoint_Address

var appInsights = require("applicationinsights");
appInsights.setup('INSTRUMENTATION_KEY');
appInsights.defaultClient.config.endpointUrl = "TelemetryChannel_Endpoint_Address"; // ingestion
appInsights.defaultClient.config.profileQueryEndpoint = "Profile_Query_Endpoint_address"; // appid/profile lookup
appInsights.defaultClient.config.quickPulseHost = "QuickPulse_Endpoint_Address"; //live metrics
appInsights.Configuration.start();

エンドポイントは、環境変数を使用して構成することもできます。

Instrumentation Key: "APPINSIGHTS_INSTRUMENTATIONKEY"
Profile Endpoint: "Profile_Query_Endpoint_address"
Live Metrics Endpoint: "QuickPulse_Endpoint_Address"

現在のスニペット (下に示されています) はバージョン "5" で、バージョンは sv: "#" としてスニペットでエンコードされています。現在のバージョンは GitHub で入手することもできます。

<script type="text/javascript">
!function(T,l,y){var S=T.location,k="script",D="instrumentationKey",C="ingestionendpoint",I="disableExceptionTracking",E="ai.device.",b="toLowerCase",w="crossOrigin",N="POST",e="appInsightsSDK",t=y.name||"appInsights";(y.name||T[e])&&(T[e]=t);var n=T[t]||function(d){var g=!1,f=!1,m={initialize:!0,queue:[],sv:"5",version:2,config:d};function v(e,t){var n={},a="Browser";return n[E+"id"]=a[b](),n[E+"type"]=a,n["ai.operation.name"]=S&&S.pathname||"_unknown_",n["ai.internal.sdkVersion"]="javascript:snippet_"+(m.sv||m.version),{time:function(){var e=new Date;function t(e){var t=""+e;return 1===t.length&&(t="0"+t),t}return e.getUTCFullYear()+"-"+t(1+e.getUTCMonth())+"-"+t(e.getUTCDate())+"T"+t(e.getUTCHours())+":"+t(e.getUTCMinutes())+":"+t(e.getUTCSeconds())+"."+((e.getUTCMilliseconds()/1e3).toFixed(3)+"").slice(2,5)+"Z"}(),iKey:e,name:"Microsoft.ApplicationInsights."+e.replace(/-/g,"")+"."+t,sampleRate:100,tags:n,data:{baseData:{ver:2}}}}var h=d.url||y.src;if(h){function a(e){var t,n,a,i,r,o,s,c,u,p,l;g=!0,m.queue=[],f||(f=!0,t=h,s=function(){var e={},t=d.connectionString;if(t)for(var n=t.split(";"),a=0;a<n.length;a++){var i=n[a].split("=");2===i.length&&(e[i[0][b]()]=i[1])}if(!e[C]){var r=e.endpointsuffix,o=r?e.location:null;e[C]="https://"+(o?o+".":"")+"dc."+(r||"services.visualstudio.com")}return e}(),c=s[D]||d[D]||"",u=s[C],p=u?u+"/v2/track":d.endpointUrl,(l=[]).push((n="SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details)",a=t,i=p,(o=(r=v(c,"Exception")).data).baseType="ExceptionData",o.baseData.exceptions=[{typeName:"SDKLoadFailed",message:n.replace(/\./g,"-"),hasFullStack:!1,stack:n+"\nSnippet failed to load ["+a+"] -- Telemetry is disabled\nHelp Link: https://go.microsoft.com/fwlink/?linkid=2128109\nHost: "+(S&&S.pathname||"_unknown_")+"\nEndpoint: "+i,parsedStack:[]}],r)),l.push(function(e,t,n,a){var i=v(c,"Message"),r=i.data;r.baseType="MessageData";var o=r.baseData;return o.message='AI (Internal): 99 message:"'+("SDK LOAD Failure: Failed to load Application Insights SDK script (See stack for details) ("+n+")").replace(/\"/g,"")+'"',o.properties={endpoint:a},i}(0,0,t,p)),function(e,t){if(JSON){var n=T.fetch;if(n&&!y.useXhr)n(t,{method:N,body:JSON.stringify(e),mode:"cors"});else if(XMLHttpRequest){var a=new XMLHttpRequest;a.open(N,t),a.setRequestHeader("Content-type","application/json"),a.send(JSON.stringify(e))}}}(l,p))}function i(e,t){f||setTimeout(function(){!t&&m.core||a()},500)}var e=function(){var n=l.createElement(k);n.src=h;var e=y[w];return!e&&""!==e||"undefined"==n[w]||(n[w]=e),n.onload=i,n.onerror=a,n.onreadystatechange=function(e,t){"loaded"!==n.readyState&&"complete"!==n.readyState||i(0,t)},n}();y.ld<0?l.getElementsByTagName("head")[0].appendChild(e):setTimeout(function(){l.getElementsByTagName(k)[0].parentNode.appendChild(e)},y.ld||0)}try{m.cookie=l.cookie}catch(p){}function t(e){for(;e.length;)!function(t){m[t]=function(){var e=arguments;g||m.queue.push(function(){m[t].apply(m,e)})}}(e.pop())}var n="track",r="TrackPage",o="TrackEvent";t([n+"Event",n+"PageView",n+"Exception",n+"Trace",n+"DependencyData",n+"Metric",n+"PageViewPerformance","start"+r,"stop"+r,"start"+o,"stop"+o,"addTelemetryInitializer","setAuthenticatedUserContext","clearAuthenticatedUserContext","flush"]),m.SeverityLevel={Verbose:0,Information:1,Warning:2,Error:3,Critical:4};var s=(d.extensionConfig||{}).ApplicationInsightsAnalytics||{};if(!0!==d[I]&&!0!==s[I]){var c="onerror";t(["_"+c]);var u=T[c];T[c]=function(e,t,n,a,i){var r=u&&u(e,t,n,a,i);return!0!==r&&m["_"+c]({message:e,url:t,lineNumber:n,columnNumber:a,error:i}),r},d.autoExceptionInstrumented=!0}return m}(y.cfg);function a(){y.onInit&&y.onInit(n)}(T[t]=n).queue&&0===n.queue.length?(n.queue.push(a),n.trackPageView({})):a()}(window,document,{
src: "https://js.monitor.azure.com/scripts/b/ai.2.min.js", // The SDK URL Source
// name: "appInsights", // Global SDK Instance name defaults to "appInsights" when not supplied
// ld: 0, // Defines the load delay (in ms) before attempting to load the sdk. -1 = block page load and add to head. (default) = 0ms load after timeout,
// useXhr: 1, // Use XHR instead of fetch to report failures (if available),
crossOrigin: "anonymous", // When supplied this will add the provided value as the cross origin attribute on the script tag
// onInit: null, // Once the application insights instance has loaded and initialized this callback function will be called with 1 argument -- the sdk instance (DO NOT ADD anything to the sdk.queue -- As they won't get called)
cfg: { // Application Insights Configuration
    instrumentationKey:"INSTRUMENTATION_KEY",
    endpointUrl: "TelemetryChannel_Endpoint_Address"
}});
</script>

Note

読みやすくするためと、発生する可能性のある JavaScript エラーを減らすために、上記のスニペットコードでは、使用可能なすべての構成オプションが新しい行に示されています。コメント行の値を変更しない場合は、それを削除できます。

エンドポイントの変更が必要なリージョン

現在、エンドポイントの変更が必要なリージョンは Azure Government と Azure China のみです。

リージョン	エンドポイント名	値
Azure 中国	テレメトリチャネル	`https://dc.applicationinsights.azure.cn/v2/track`
Azure 中国	QuickPulse (Live Metrics)	`https://live.applicationinsights.azure.cn/QuickPulseService.svc`
Azure 中国	Profile Query	`https://dc.applicationinsights.azure.cn/api/profiles/{0}/appId`
Azure Government	テレメトリチャネル	`https://dc.applicationinsights.us/v2/track`
Azure Government	QuickPulse (Live Metrics)	`https://quickpulse.applicationinsights.us/QuickPulseService.svc`
Azure Government	Profile Query	`https://dc.applicationinsights.us/api/profiles/{0}/appId`

現在、一般的に `api.applicationinsights.io' によってアクセスされる Application Insights REST API をお使いの場合、お客様のリージョンのローカルのエンドポイントを使用する必要があります。

リージョン	エンドポイント名	値
Azure 中国	REST API	`api.applicationinsights.azure.cn`
Azure Government	REST API	`api.applicationinsights.us`

次のステップ

診断検索
メトリックを探索する
Analytics クエリを作成する
Azure Government のカスタム変更の詳細については、Azure の監視と管理の詳細なガイダンスを参照してください。
Azure China の詳細については、Azure China プレイブックのページを参照してください。

Application Insights リソースの作成

Application Insights リソースの作成

インストルメンテーションキーのコピー

アプリケーションでの SDK のインストール

リソースの自動作成

PowerShell

例

結果

Azure CLI (プレビュー)

例

結果

既定のエンドポイントをオーバーライドする Application Insights

SDK コードの変更

Spring Boot

エンドポイントの変更が必要なリージョン

次のステップ

その他のリソース

その他のリソース

Application Insights リソースの作成

Microsoft Azure にサインインする

Application Insights リソースの作成

インストルメンテーション キーのコピー

アプリケーションでの SDK のインストール

リソースの自動作成

PowerShell

例

結果

Azure CLI (プレビュー)

例

結果

既定のエンドポイントをオーバーライドする Application Insights

SDK コードの変更

エンドポイントの変更が必要なリージョン

次のステップ

その他のリソース

その他のリソース

インストルメンテーションキーのコピー