ASP.NET および ASP.NET Core アプリケーションの Application Insights

1. Visual Studio を開きます。
2. [ 新しいプロジェクトの作成] を選択します。
3. C#ASP.NET Web アプリケーション (.NET Framework) を選択し、[次へ] を選択します。
4. プロジェクト名を入力し、[作成] を選択します。
5. [MVC] を選択し、[作成] を選択します。

1. Visual Studio を開きます。
2. [ 新しいプロジェクトの作成] を選択します。
3. C#ASP.NET Core Web App (Razor Pages) を選択し、[次へ] を選択します。
4. プロジェクト名を入力し、[作成] を選択します。
5. フレームワーク (LTS または STS) を選択し、[作成] を選択します。

Visual Studio の ASP.NET Web アプリ プロジェクト内から:

1. [プロジェクト]>[Application Insights Telemetry の追加]>[Application Insights SDK (ローカル)]>[次へ]>[完了]>[閉じる] の順に選択します。

2. ApplicationInsights.config ファイルを開きます。

3. 終了タグ </ApplicationInsights> の前に、自分の Application Insights リソースの接続文字列を含む行を追加します。 新しく作成された Application Insights リソースの [概要] ペインで接続文字列を見つけます。

   <ConnectionString>Copy connection string from Application Insights Resource Overview</ConnectionString>
   

4. [プロジェクト]>[NuGet パッケージの管理]>[更新] を選択します。 次に、各 Microsoft.ApplicationInsights NuGet パッケージを最新の安定版リリースに更新します。

5. [IIS Express] を選択してアプリケーションを実行します。 基本的な ASP.NET アプリが開きます。 サイトでページを移動して閲覧すると、テレメトリが Application Insights に送信されます。

Visual Studio の ASP.NET Web アプリ プロジェクト内から:

1. [プロジェクト]>[Application Insights Telemetry の追加] に移動します。

2. [Azure Application Insights]>[次へ] を選択します。

3. サブスクリプションと Application Insights インスタンスを選択します。 または、[新規作成] を使用して新しいインスタンスを作成することもできます。 [次へ] を選択します。

4. Application Insights の接続文字列を追加または確認します。 これは、前の手順で選択した内容に基づいてあらかじめ設定されているはずです。 完了 を選択します。

5. Application Insights をプロジェクトに追加した後、SDK の最新の安定リリースを使用していることを確認します。 [プロジェクト]>[NuGet パッケージの管理]>[Microsoft.ApplicationInsights.AspNetCore] に移動します。 必要であれば、[更新] を選択します。

   

1. 次の NuGet パッケージとその依存関係をプロジェクトに追加します。

   • Microsoft.ApplicationInsights.WindowsServer
   • Microsoft.ApplicationInsights.Web
   • Microsoft.AspNet.TelemetryCorrelation

2. 場合によっては、ApplicationInsights.config ファイルが自動的に作成されます。 ファイルが既に存在する場合は、手順 4 に進みます。

   ない場合は、自分で作成してください。 ASP.NET アプリケーションのルート ディレクトリに、ApplicationInsights.configという名前の新規ファイルを作成します。

3. 次の XML 構成を新しく作成したファイルにコピーします。

   
   
   展開して構成を表示する

   <?xml version="1.0" encoding="utf-8"?>
   <ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings">
     <TelemetryInitializers>
       <Add Type="Microsoft.ApplicationInsights.DependencyCollector.HttpDependenciesParsingTelemetryInitializer, Microsoft.AI.DependencyCollector" />
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.AzureRoleEnvironmentTelemetryInitializer, Microsoft.AI.WindowsServer" />
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.BuildInfoConfigComponentVersionTelemetryInitializer, Microsoft.AI.WindowsServer" />
       <Add Type="Microsoft.ApplicationInsights.Web.WebTestTelemetryInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.SyntheticUserAgentTelemetryInitializer, Microsoft.AI.Web">
         <!-- Extended list of bots:
               search|spider|crawl|Bot|Monitor|BrowserMob|BingPreview|PagePeeker|WebThumb|URL2PNG|ZooShot|GomezA|Google SketchUp|Read Later|KTXN|KHTE|Keynote|Pingdom|AlwaysOn|zao|borg|oegp|silk|Xenu|zeal|NING|htdig|lycos|slurp|teoma|voila|yahoo|Sogou|CiBra|Nutch|Java|JNLP|Daumoa|Genieo|ichiro|larbin|pompos|Scrapy|snappy|speedy|vortex|favicon|indexer|Riddler|scooter|scraper|scrubby|WhatWeb|WinHTTP|voyager|archiver|Icarus6j|mogimogi|Netvibes|altavista|charlotte|findlinks|Retreiver|TLSProber|WordPress|wsr-agent|http client|Python-urllib|AppEngine-Google|semanticdiscovery|facebookexternalhit|web/snippet|Google-HTTP-Java-Client-->
         <Filters>search|spider|crawl|Bot|Monitor|AlwaysOn</Filters>
       </Add>
       <Add Type="Microsoft.ApplicationInsights.Web.ClientIpHeaderTelemetryInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.AzureAppServiceRoleNameFromHostNameHeaderInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.OperationNameTelemetryInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.OperationCorrelationTelemetryInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.UserTelemetryInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.AuthenticatedUserIdTelemetryInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.AccountIdTelemetryInitializer, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.SessionTelemetryInitializer, Microsoft.AI.Web" />
     </TelemetryInitializers>
     <TelemetryModules>
       <Add Type="Microsoft.ApplicationInsights.DependencyCollector.DependencyTrackingTelemetryModule, Microsoft.AI.DependencyCollector">
         <ExcludeComponentCorrelationHttpHeadersOnDomains>
           <!-- 
           Requests to the following hostnames will not be modified by adding correlation headers.
           Add entries here to exclude additional hostnames.
           NOTE: this configuration will be lost upon NuGet upgrade.
           -->
           <Add>core.windows.net</Add>
           <Add>core.chinacloudapi.cn</Add>
           <Add>core.cloudapi.de</Add>
           <Add>core.usgovcloudapi.net</Add>
         </ExcludeComponentCorrelationHttpHeadersOnDomains>
         <IncludeDiagnosticSourceActivities>
           <Add>Microsoft.Azure.EventHubs</Add>
           <Add>Azure.Messaging.ServiceBus</Add>
         </IncludeDiagnosticSourceActivities>
       </Add>
       <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.PerformanceCollectorModule, Microsoft.AI.PerfCounterCollector">
         <!--
         Use the following syntax here to collect additional performance counters:
   
         <Counters>
           <Add PerformanceCounter="\Process(??APP_WIN32_PROC??)\Handle Count" ReportAs="Process handle count" />
           ...
         </Counters>
   
         PerformanceCounter must be either \CategoryName(InstanceName)\CounterName or \CategoryName\CounterName
   
         NOTE: performance counters configuration will be lost upon NuGet upgrade.
   
         The following placeholders are supported as InstanceName:
           ??APP_WIN32_PROC?? - instance name of the application process for Win32 counters.
           ??APP_W3SVC_PROC?? - instance name of the application IIS worker process for IIS/ASP.NET counters.
           ??APP_CLR_PROC?? - instance name of the application CLR process for .NET counters.
         -->
       </Add>
       <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse.QuickPulseTelemetryModule, Microsoft.AI.PerfCounterCollector" />
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.AppServicesHeartbeatTelemetryModule, Microsoft.AI.WindowsServer" />
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.AzureInstanceMetadataTelemetryModule, Microsoft.AI.WindowsServer">
         <!--
         Remove individual fields collected here by adding them to the ApplicationInsighs.HeartbeatProvider
         with the following syntax:
   
         <Add Type="Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing.DiagnosticsTelemetryModule, Microsoft.ApplicationInsights">
           <ExcludedHeartbeatProperties>
             <Add>osType</Add>
             <Add>___location</Add>
             <Add>name</Add>
             <Add>offer</Add>
             <Add>platformFaultDomain</Add>
             <Add>platformUpdateDomain</Add>
             <Add>publisher</Add>
             <Add>sku</Add>
             <Add>version</Add>
             <Add>vmId</Add>
             <Add>vmSize</Add>
             <Add>subscriptionId</Add>
             <Add>resourceGroupName</Add>
             <Add>placementGroupId</Add>
             <Add>tags</Add>
             <Add>vmScaleSetName</Add>
           </ExcludedHeartbeatProperties>
         </Add>
   
         NOTE: exclusions will be lost upon upgrade.
         -->
       </Add>
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.DeveloperModeWithDebuggerAttachedTelemetryModule, Microsoft.AI.WindowsServer" />
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.UnhandledExceptionTelemetryModule, Microsoft.AI.WindowsServer" />
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.UnobservedExceptionTelemetryModule, Microsoft.AI.WindowsServer">
         <!--</Add>
       <Add Type="Microsoft.ApplicationInsights.WindowsServer.FirstChanceExceptionStatisticsTelemetryModule, Microsoft.AI.WindowsServer">-->
       </Add>
       <Add Type="Microsoft.ApplicationInsights.Web.RequestTrackingTelemetryModule, Microsoft.AI.Web">
         <Handlers>
           <!-- 
           Add entries here to filter out additional handlers:
   
           NOTE: handler configuration will be lost upon NuGet upgrade.
           -->
           <Add>Microsoft.VisualStudio.Web.PageInspector.Runtime.Tracing.RequestDataHttpHandler</Add>
           <Add>System.Web.StaticFileHandler</Add>
           <Add>System.Web.Handlers.AssemblyResourceLoader</Add>
           <Add>System.Web.Optimization.BundleHandler</Add>
           <Add>System.Web.Script.Services.ScriptHandlerFactory</Add>
           <Add>System.Web.Handlers.TraceHandler</Add>
           <Add>System.Web.Services.Discovery.DiscoveryRequestHandler</Add>
           <Add>System.Web.HttpDebugHandler</Add>
         </Handlers>
       </Add>
       <Add Type="Microsoft.ApplicationInsights.Web.ExceptionTrackingTelemetryModule, Microsoft.AI.Web" />
       <Add Type="Microsoft.ApplicationInsights.Web.AspNetDiagnosticTelemetryModule, Microsoft.AI.Web" />
     </TelemetryModules>
     <ApplicationIdProvider Type="Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId.ApplicationInsightsApplicationIdProvider, Microsoft.ApplicationInsights" />
     <TelemetrySinks>
       <Add Name="default">
         <TelemetryProcessors>
           <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse.QuickPulseTelemetryProcessor, Microsoft.AI.PerfCounterCollector" />
           <Add Type="Microsoft.ApplicationInsights.Extensibility.AutocollectedMetricsExtractor, Microsoft.ApplicationInsights" />
           <Add Type="Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.AdaptiveSamplingTelemetryProcessor, Microsoft.AI.ServerTelemetryChannel">
             <MaxTelemetryItemsPerSecond>5</MaxTelemetryItemsPerSecond>
             <ExcludedTypes>Event</ExcludedTypes>
           </Add>
           <Add Type="Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.AdaptiveSamplingTelemetryProcessor, Microsoft.AI.ServerTelemetryChannel">
             <MaxTelemetryItemsPerSecond>5</MaxTelemetryItemsPerSecond>
             <IncludedTypes>Event</IncludedTypes>
           </Add>
           <!--
             Adjust the include and exclude examples to specify the desired semicolon-delimited types. (Dependency, Event, Exception, PageView, Request, Trace)
           -->
         </TelemetryProcessors>
         <TelemetryChannel Type="Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.ServerTelemetryChannel, Microsoft.AI.ServerTelemetryChannel" />
       </Add>
     </TelemetrySinks>
     <!-- 
       Learn more about Application Insights configuration with ApplicationInsights.config here:
       http://go.microsoft.com/fwlink/?LinkID=513840
     -->
     <ConnectionString>Copy the connection string from your Application Insights resource</ConnectionString>
   </ApplicationInsights>
   

4. 接続文字列を追加します。このためには、次の 2 つの方法があります。

   • (推奨) 構成で接続文字列を設定します。

     </ApplicationInsights> で、終了タグ の前に Application Insights リソースの接続文字列を追加します。 新しく作成された Application Insights リソースの [概要] ペインで接続文字列を見つけることができます。

     <ConnectionString>Copy the connection string from your Application Insights resource</ConnectionString>
     

   • コードで接続文字列を設定します。

     program.cs クラスに接続文字列を指定します。

     var configuration = new TelemetryConfiguration
     {
         ConnectionString = "Copy the connection string from your Application Insights resource"
     };
     

5. プロジェクトの ApplicationInsights.config ファイルと同じレベルに、AiHandleErrorAttribute.cs という名前の新しい C# ファイルが含まれる ErrorHandler という名前のフォルダーを作成します。 このファイルの内容は次のようになります。

   using System;
   using System.Web.Mvc;
   using Microsoft.ApplicationInsights;
   
   namespace WebApplication10.ErrorHandler //namespace will vary based on your project name
   {
       [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, Inherited = true, AllowMultiple = true)] 
       public class AiHandleErrorAttribute : HandleErrorAttribute
       {
           public override void OnException(ExceptionContext filterContext)
           {
               if (filterContext != null && filterContext.HttpContext != null && filterContext.Exception != null)
               {
                   //If customError is Off, then AI HTTPModule will report the exception
                   if (filterContext.HttpContext.IsCustomErrorEnabled)
                   {   
                       var ai = new TelemetryClient();
                       ai.TrackException(filterContext.Exception);
                   } 
               }
               base.OnException(filterContext);
           }
       }
   }
   

6. App_Start フォルダーで FilterConfig.cs ファイルを開き、次のサンプルに一致するように変更します。

   using System.Web;
   using System.Web.Mvc;
   
   namespace WebApplication10 //Namespace will vary based on project name
   {
       public class FilterConfig
       {
           public static void RegisterGlobalFilters(GlobalFilterCollection filters)
           {
               filters.Add(new ErrorHandler.AiHandleErrorAttribute());
           }
       }
   }
   

7. Web.config が既に更新されている場合は、この手順をスキップします。 そうでない場合は、ファイルを次のように更新します。

   
   
   展開して構成を表示する

   <?xml version="1.0" encoding="utf-8"?>
   <!--
     For more information on how to configure your ASP.NET application, please visit
     https://go.microsoft.com/fwlink/?LinkId=301880
     -->
   <configuration>
     <appSettings>
       <add key="webpages:Version" value="3.0.0.0" />
       <add key="webpages:Enabled" value="false" />
       <add key="ClientValidationEnabled" value="true" />
       <add key="UnobtrusiveJavaScriptEnabled" value="true" />
     </appSettings>
     <system.web>
       <compilation debug="true" targetFramework="4.7.2" />
       <httpRuntime targetFramework="4.7.2" />
       <!-- Code added for Application Insights start -->
       <httpModules>
         <add name="TelemetryCorrelationHttpModule" type="Microsoft.AspNet.TelemetryCorrelation.TelemetryCorrelationHttpModule, Microsoft.AspNet.TelemetryCorrelation" />
         <add name="ApplicationInsightsWebTracking" type="Microsoft.ApplicationInsights.Web.ApplicationInsightsHttpModule, Microsoft.AI.Web" />
       </httpModules>
       <!-- Code added for Application Insights end -->
     </system.web>
     <runtime>
       <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
         <dependentAssembly>
           <assemblyIdentity name="Antlr3.Runtime" publicKeyToken="eb42632606e9261f" />
           <bindingRedirect oldVersion="0.0.0.0-3.5.0.2" newVersion="3.5.0.2" />
         </dependentAssembly>
         <dependentAssembly>
           <assemblyIdentity name="Newtonsoft.Json" publicKeyToken="30ad4fe6b2a6aeed" />
           <bindingRedirect oldVersion="0.0.0.0-12.0.0.0" newVersion="12.0.0.0" />
         </dependentAssembly>
         <dependentAssembly>
           <assemblyIdentity name="System.Web.Optimization" publicKeyToken="31bf3856ad364e35" />
           <bindingRedirect oldVersion="1.0.0.0-1.1.0.0" newVersion="1.1.0.0" />
         </dependentAssembly>
         <dependentAssembly>
           <assemblyIdentity name="WebGrease" publicKeyToken="31bf3856ad364e35" />
           <bindingRedirect oldVersion="0.0.0.0-1.6.5135.21930" newVersion="1.6.5135.21930" />
         </dependentAssembly>
         <dependentAssembly>
           <assemblyIdentity name="System.Web.Helpers" publicKeyToken="31bf3856ad364e35" />
           <bindingRedirect oldVersion="1.0.0.0-3.0.0.0" newVersion="3.0.0.0" />
         </dependentAssembly>
         <dependentAssembly>
           <assemblyIdentity name="System.Web.WebPages" publicKeyToken="31bf3856ad364e35" />
           <bindingRedirect oldVersion="1.0.0.0-3.0.0.0" newVersion="3.0.0.0" />
         </dependentAssembly>
         <dependentAssembly>
           <assemblyIdentity name="System.Web.Mvc" publicKeyToken="31bf3856ad364e35" />
           <bindingRedirect oldVersion="1.0.0.0-5.2.7.0" newVersion="5.2.7.0" />
         </dependentAssembly>
         <!-- Code added for Application Insights start -->
         <dependentAssembly>
           <assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
           <bindingRedirect oldVersion="0.0.0.0-4.0.1.1" newVersion="4.0.1.1" />
         </dependentAssembly>
         <!-- Code added for Application Insights end -->
       </assemblyBinding>
     </runtime>
     <system.codedom>
       <compilers>
         <compiler language="c#;cs;csharp" extension=".cs" type="Microsoft.CodeDom.Providers.DotNetCompilerPlatform.CSharpCodeProvider, Microsoft.CodeDom.Providers.DotNetCompilerPlatform, Version=2.0.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" warningLevel="4" compilerOptions="/langversion:default /nowarn:1659;1699;1701" />
         <compiler language="vb;vbs;visualbasic;vbscript" extension=".vb" type="Microsoft.CodeDom.Providers.DotNetCompilerPlatform.VBCodeProvider, Microsoft.CodeDom.Providers.DotNetCompilerPlatform, Version=2.0.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" warningLevel="4" compilerOptions="/langversion:default /nowarn:41008 /define:_MYTYPE=\&quot;Web\&quot; /optionInfer+" />
       </compilers>
     </system.codedom>
     <system.webServer>
       <validation validateIntegratedModeConfiguration="false" />
       <!-- Code added for Application Insights start -->
       <modules>
         <remove name="TelemetryCorrelationHttpModule" />
         <add name="TelemetryCorrelationHttpModule" type="Microsoft.AspNet.TelemetryCorrelation.TelemetryCorrelationHttpModule, Microsoft.AspNet.TelemetryCorrelation" preCondition="managedHandler" />
         <remove name="ApplicationInsightsWebTracking" />
         <add name="ApplicationInsightsWebTracking" type="Microsoft.ApplicationInsights.Web.ApplicationInsightsHttpModule, Microsoft.AI.Web" preCondition="managedHandler" />
       </modules>
       <!-- Code added for Application Insights end -->
     </system.webServer>
   </configuration>
   

これで、サーバー側アプリケーション監視は正常に構成されました。 Web アプリを実行すると、テレメトリが Application Insights に表示されるようになったことがわかります。

1. ASP.NET Core 用の Application Insights SDK NuGet パッケージをインストールします。

   常に最新の安定バージョンを使用することをお勧めします。 オープンソースの GitHub リポジトリで、SDK の完全なリリース ノートを探します。

   次のコード サンプルは、プロジェクトの .csproj ファイルに追加する変更を示しています。

   <ItemGroup>
       <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.21.0" />
   </ItemGroup>
   

2. AddApplicationInsightsTelemetry() を program.cs クラスに追加します。

   この例のように、builder.Services.AddApplicationInsightsTelemetry(); メソッドの後に WebApplication.CreateBuilder() を追加します。

   // This method gets called by the runtime. Use this method to add services to the container.
   var builder = WebApplication.CreateBuilder(args);
   
   // The following line enables Application Insights telemetry collection.
   builder.Services.AddApplicationInsightsTelemetry();
   
   // This code adds other services for your application.
   builder.Services.AddMvc();
   
   var app = builder.Build();
   

3. 接続文字列を追加します。このためには、次の 3 つの方法があります。

   • (推奨) 構成で接続文字列を設定します。

     appsettings.json に接続文字列を設定し、発行時に構成ファイルがアプリケーションのルート フォルダーにコピーされるようにします。

     {
         "Logging": {
             "LogLevel": {
                 "Default": "Information",
                 "Microsoft.AspNetCore": "Warning"
             }
         },
         "AllowedHosts": "*",
         "ApplicationInsights": {
             "ConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000"
         }
     }
     

   • APPLICATIONINSIGHTS_CONNECTION_STRING 環境変数に、または JSON 構成ファイルの ApplicationInsights:ConnectionString に接続文字列を設定します。

     例えば次が挙げられます。

     • SET ApplicationInsights:ConnectionString = <Copy connection string from Application Insights Resource Overview>
     • SET APPLICATIONINSIGHTS_CONNECTION_STRING = <Copy connection string from Application Insights Resource Overview>
     • 通常、APPLICATIONINSIGHTS_CONNECTION_STRING は Web Apps で使用されます。 また、この SDK がサポートされているすべての場所でも使用できます。

     メモ

     コードで指定された接続文字列は、他のオプションより優先される環境変数 APPLICATIONINSIGHTS_CONNECTION_STRING より優先されます。

   • コードで接続文字列を設定します。

     接続文字列を、ApplicationInsightsServiceOptions クラスの AddApplicationInsightsTelemetry に 引数の一部として指定します。

ユーザー シークレットとその他の構成プロバイダー

接続文字列を ASP.NET Core ユーザー シークレットに格納するか、別の構成プロバイダーから取得する場合は、Microsoft.Extensions.Configuration.IConfiguration パラメーターでオーバーロードを使用できます。 パラメーターの例は services.AddApplicationInsightsTelemetry(Configuration); です。

Microsoft.ApplicationInsights.AspNetCore バージョン 2.15.0 以降では、services.AddApplicationInsightsTelemetry() の呼び出しによって、アプリケーションの Microsoft.Extensions.Configuration.IConfiguration から接続文字列が自動的に読み取られます。 IConfiguration を明示的に指定する必要はありません。

複数のプロバイダーから構成 IConfiguration 読み込まれた場合、 services.AddApplicationInsightsTelemetry は、プロバイダーが追加される順序に関係なく、 appsettings.jsonからの構成に優先順位を付けます。 services.AddApplicationInsightsTelemetry(IConfiguration) メソッドを使用して、IConfiguration の優先処理なしで から構成を読み取ります。

Live Metrics を手動で構成するには:

1. NuGet パッケージ Microsoft.ApplicationInsights.PerfCounterCollector をインストールします。

2. 次のサンプル コンソール アプリ コードは、Live Metrics の設定方法を示しています。

using Microsoft.ApplicationInsights;
using Microsoft.ApplicationInsights.Extensibility;
using Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse;
using System;
using System.Threading.Tasks;

namespace LiveMetricsDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            // Create a TelemetryConfiguration instance.
            TelemetryConfiguration config = TelemetryConfiguration.CreateDefault();
            config.InstrumentationKey = "INSTRUMENTATION-KEY-HERE";
            QuickPulseTelemetryProcessor quickPulseProcessor = null;
            config.DefaultTelemetrySink.TelemetryProcessorChainBuilder
                .Use((next) =>
                {
                    quickPulseProcessor = new QuickPulseTelemetryProcessor(next);
                    return quickPulseProcessor;
                })
                .Build();

            var quickPulseModule = new QuickPulseTelemetryModule();

            // Secure the control channel.
            // This is optional, but recommended.
            quickPulseModule.AuthenticationApiKey = "YOUR-API-KEY-HERE";
            quickPulseModule.Initialize(config);
            quickPulseModule.RegisterTelemetryProcessor(quickPulseProcessor);

            // Create a TelemetryClient instance. It is important
            // to use the same TelemetryConfiguration here as the one
            // used to set up live metrics.
            TelemetryClient client = new TelemetryClient(config);

            // This sample runs indefinitely. Replace with actual application logic.
            while (true)
            {
                // Send dependency and request telemetry.
                // These will be shown in live metrics.
                // CPU/Memory Performance counter is also shown
                // automatically without any additional steps.
                client.TrackDependency("My dependency", "target", "http://sample",
                    DateTimeOffset.Now, TimeSpan.FromMilliseconds(300), true);
                client.TrackRequest("My Request", DateTimeOffset.Now,
                    TimeSpan.FromMilliseconds(230), "200", true);
                Task.Delay(1000).Wait();
            }
        }
    }
}

Live Metrics を手動で構成するには:

1. NuGet パッケージ Microsoft.ApplicationInsights.PerfCounterCollector をインストールします。

2. 次のサンプル コンソール アプリ コードは、Live Metrics の設定方法を示しています。

using Microsoft.ApplicationInsights;
using Microsoft.ApplicationInsights.Extensibility;
using Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.QuickPulse;

// Create a TelemetryConfiguration instance.
TelemetryConfiguration config = TelemetryConfiguration.CreateDefault();
config.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000";
QuickPulseTelemetryProcessor quickPulseProcessor = null;
config.DefaultTelemetrySink.TelemetryProcessorChainBuilder
    .Use((next) =>
    {
        quickPulseProcessor = new QuickPulseTelemetryProcessor(next);
        return quickPulseProcessor;
    })
    .Build();

var quickPulseModule = new QuickPulseTelemetryModule();

// Secure the control channel.
// This is optional, but recommended.
quickPulseModule.AuthenticationApiKey = "YOUR-API-KEY-HERE";
quickPulseModule.Initialize(config);
quickPulseModule.RegisterTelemetryProcessor(quickPulseProcessor);

// Create a TelemetryClient instance. It is important
// to use the same TelemetryConfiguration here as the one
// used to set up live metrics.
TelemetryClient client = new TelemetryClient(config);

// This sample runs indefinitely. Replace with actual application logic.
while (true)
{
    // Send dependency and request telemetry.
    // These will be shown in live metrics.
    // CPU/Memory Performance counter is also shown
    // automatically without any additional steps.
    client.TrackDependency("My dependency", "target", "http://sample",
        DateTimeOffset.Now, TimeSpan.FromMilliseconds(300), true);
    client.TrackRequest("My Request", DateTimeOffset.Now,
        TimeSpan.FromMilliseconds(230), "200", true);
    Task.Delay(1000).Wait();
}

上記のサンプルはコンソール アプリ用ですが、あらゆる .NET アプリケーションで同じコードを使用できます。

ILogger ガイダンスは、ASP.NET には適用されません。 クラシック ASP.NET アプリから Application Insights にトレース ログを送信するには、次のようなサポートされているアダプターを使用します。

• Application Insights TraceListener を使用した System.Diagnostics.Trace
• 公式の Application Insights ターゲットを含む log4net または NLog

詳細な手順と構成例については、「 トレース ログを Application Insights に送信する」を参照してください。

Application Insights SDK for ASP.NET Core では、既定で ILogger ログが既に収集されています。 SDK を使用する場合、通常、 builder.Logging.AddApplicationInsights() も呼び出す必要はありません。次の ILogger のインストール手順は無視できます。

完全なテレメトリ スタックではなく、ログ転送のみが必要な場合は、 Microsoft.Extensions.Logging.ApplicationInsights プロバイダー パッケージを使用してログをキャプチャできます。

ApplicationInsightsLoggerProvider の追加

1. Microsoft.Extensions.Logging.ApplicationInsightsをインストールします。

2. ApplicationInsightsLoggerProviderを追加します。

using Microsoft.Extensions.Logging.ApplicationInsights;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

builder.Logging.AddApplicationInsights(
        configureTelemetryConfiguration: (config) => 
            config.ConnectionString = builder.Configuration.GetConnectionString("APPLICATIONINSIGHTS_CONNECTION_STRING"),
            configureApplicationInsightsLoggerOptions: (options) => { }
    );

builder.Logging.AddFilter<ApplicationInsightsLoggerProvider>("your-category", LogLevel.Trace);

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

NuGet パッケージがインストールされ、プロバイダーが依存関係の挿入に登録されると、アプリはログに記録する準備が整います。 コンストラクターの挿入では、 ILogger またはジェネリック型の代替 ILogger<TCategoryName> が必要です。 これらの実装が解決されると、 ApplicationInsightsLoggerProvider によって提供されます。 ログに記録されたメッセージまたは例外は Application Insights に送信されます。

次のコントローラーの例を考えてみましょう。

public class ValuesController : ControllerBase
{
    private readonly ILogger _logger;

    public ValuesController(ILogger<ValuesController> logger)
    {
        _logger = logger;
    }

    [HttpGet]
    public ActionResult<IEnumerable<string>> Get()
    {
        _logger.LogWarning("An example of a Warning trace..");
        _logger.LogError("An example of an Error level message");

        return new string[] { "value1", "value2" };
    }
}

詳細については、「 ASP.NET Core でのログ記録 」および 「ILogger ログから生成される Application Insights テレメトリの種類」を参照してください。Application Insights の ILogger ログはどこで確認できますか?

.NET コンソール アプリから依存関係を自動的に追跡するには、NuGet パッケージ Microsoft.ApplicationInsights.DependencyCollector をインストールし、DependencyTrackingTelemetryModule を初期化します:

    DependencyTrackingTelemetryModule depModule = new DependencyTrackingTelemetryModule();
    depModule.Initialize(TelemetryConfiguration.Active);

.NET Core コンソール アプリの場合、TelemetryConfiguration.Active は非推奨です。 Worker サービスのドキュメントのガイダンスと、この記事の ASP.NET Core タブを参照してください。

ASP.NET アプリケーションの場合は、バイト コード インストルメンテーションの支援により、完全な SQL クエリ テキストが収集されます。これには、インストルメンテーション エンジン、または System.Data.SqlClient ライブラリではなく Microsoft.Data.SqlClient NuGet パッケージの使用が要求されます。 完全な SQL クエリの収集を有効にするためのプラットフォーム固有の手順を、次の表に示します。

前述のプラットフォーム固有の手順に加えて、次のコードで ファイルを変更することで、"SQL コマンドの収集の有効化も明示的に選択する" 必要があります。applicationInsights.config

<TelemetryModules>
  <Add Type="Microsoft.ApplicationInsights.DependencyCollector.DependencyTrackingTelemetryModule, Microsoft.AI.DependencyCollector">
    <EnableSqlCommandTextInstrumentation>true</EnableSqlCommandTextInstrumentation>
  </Add>

ASP.NET Core アプリケーションの場合は、次を使用して SQL Text コレクションをオプトインする必要があります。

services.ConfigureTelemetryModule<DependencyTrackingTelemetryModule>((module, o) => { module. EnableSqlCommandTextInstrumentation = true; });

サーバー側アプリケーションから例外を報告するには、次のシナリオを検討してください。

• Azure Web アプリ用の Application Insights 拡張機能 を追加します。
• Azure Virtual Machines と Azure Virtual Machine Scale Sets IIS でホストされるアプリの アプリケーション監視拡張機能 を追加します。
• Application Insights SDK を アプリ コードに追加するか、IIS Web サーバー用 の Application Insights エージェント を実行するか、Java Web アプリの Java エージェント を有効にします。

JavaScript SDK は、Web ブラウザーで発生する例外をクライアント側でレポートする機能を提供します。 クライアントで例外レポートを設定するには、 Web ページの Application Insights を参照してください。

一部のアプリケーション フレームワークでは、より多くの構成が必要です。 次のテクノロジについて考えてみましょう。

• Web フォーム
• MVC
• Web API 1.*
• Web API 2.*
• WCF

Application Insights には、監視対象のアプリケーションでエラーを診断するのに役立つ、キュレーションされた Application Performance Management エクスペリエンスが用意されています。

詳細な手順については、「 Application Insights を使用してエラー、パフォーマンス、トランザクションを調査する」を参照してください。

1. Visual Studio でアプリ ソリューションを開きます。 F5 キーを使用して、サーバーまたは開発用コンピューターでアプリを実行します。 例外を再作成します。

2. Visual Studio で Application Insights Search テレメトリ ウィンドウを開きます。 デバッグ中に、[ Application Insights ] ドロップダウン ボックスを選択します。

3. 例外レポートを選択して、そのスタック トレースを表示します。 関連するコード ファイルを開くには、スタック トレースで行参照を選択します。

   CodeLens が有効になっている場合は、例外に関するデータが表示されます。

   

var telemetry = new TelemetryClient();

try
{
    // ...
}
catch (Exception ex)
{
    var properties = new Dictionary<string, string>
    {
        ["Game"] = currentGame.Name
    };

    var measurements = new Dictionary<string, double>
    {
        ["Users"] = currentGame.Users.Count
    };

    // Send the exception telemetry:
    telemetry.TrackException(ex, properties, measurements);
}

try
{
    // ...
}
catch (ex)
{
    appInsights.trackException(ex, "handler loc",
    {
        Game: currentGame.Name,
        State: currentGame.State.ToString()
    });
}

ストレージ キューは HTTP API をサポートしているため、キューに対するすべての操作は Application Insights によって自動的に追跡されます。 多くの場合、このインストルメンテーションで十分です。 コンシューマー側のトレースをプロデューサー トレースと関連付けるためには、関連付け用 HTTP プロトコルで行う方法と同様に、関連付けコンテキストを渡す必要があります。

この例では、 Enqueue 操作を追跡する方法を示します。 次のようにすることができます。

• 再試行を関連付ける (存在する場合): すべての再試行には、 Enqueue 操作である共通の親が 1 つ存在します。 それ以外の場合は、受信要求の子として追跡されます。 キューに対する複数の論理要求がある場合、再試行の原因となった呼び出しを見つけるのが難しい場合があります。
• ストレージ ログを関連付ける (必要な場合):Application Insights テレメトリと関連付けられます。

Enqueue操作は親操作の子です。 たとえば、受信 HTTP 要求があります。 HTTP 依存関係呼び出しは、 Enqueue 操作の子であり、受信要求の孫です。

public async Task Enqueue(CloudQueue queue, string message)
{
    var operation = telemetryClient.StartOperation<DependencyTelemetry>("enqueue " + queue.Name);
    operation.Telemetry.Type = "Azure queue";
    operation.Telemetry.Data = "Enqueue " + queue.Name;

    // MessagePayload represents your custom message and also serializes correlation identifiers into payload.
    // For example, if you choose to pass payload serialized to JSON, it might look like
    // {'RootId' : 'some-id', 'ParentId' : '|some-id.1.2.3.', 'message' : 'your message to process'}
    var jsonPayload = JsonConvert.SerializeObject(new MessagePayload
    {
        RootId = operation.Telemetry.Context.Operation.Id,
        ParentId = operation.Telemetry.Id,
        Payload = message
    });
    
    CloudQueueMessage queueMessage = new CloudQueueMessage(jsonPayload);

    // Add operation.Telemetry.Id to the OperationContext to correlate Storage logs and Application Insights telemetry.
    OperationContext context = new OperationContext { ClientRequestID = operation.Telemetry.Id};

    try
    {
        await queue.AddMessageAsync(queueMessage, null, null, new QueueRequestOptions(), context);
    }
    catch (StorageException e)
    {
        operation.Telemetry.Properties.Add("AzureServiceRequestID", e.RequestInformation.ServiceRequestID);
        operation.Telemetry.Success = false;
        operation.Telemetry.ResultCode = e.RequestInformation.HttpStatusCode.ToString();
        telemetryClient.TrackException(e);
    }
    finally
    {
        // Update status code and success as appropriate.
        telemetryClient.StopOperation(operation);
    }
}  

アプリケーションが報告するテレメトリの量を減らすか、他の理由で Enqueue 操作を追跡したくない場合は、 Activity API を直接使用します。

• Application Insights 操作を開始するのではなく、新しい Activity を作成 (および開始) します。 操作名以外のプロパティを割り当てる必要 はありません 。
• operation.Telemetry.Idではなく、メッセージ ペイロードにyourActivity.Idをシリアル化します。 Activity.Current.Idを使用することもできます。

Enqueueと同様に、ストレージ キューへの実際の HTTP 要求は Application Insights によって自動的に追跡されます。 Enqueue操作は、受信要求コンテキストなどの親コンテキストで発生する可能性があります。 Application Insights SDK は、このような操作とその HTTP 部分を、同じスコープで報告された親要求やその他のテレメトリと自動的に関連付けます。

Dequeue操作は難しいです。 Application Insights SDK は、HTTP 要求を自動的に追跡します。 ただし、メッセージが解析されるまで、関連付けコンテキストは認識されません。 HTTP 要求を関連付けてメッセージを取得することは、特に複数のメッセージが受信された場合に、残りのテレメトリと関連付けすることはできません。

public async Task<MessagePayload> Dequeue(CloudQueue queue)
{
    var operation = telemetryClient.StartOperation<DependencyTelemetry>("dequeue " + queue.Name);
    operation.Telemetry.Type = "Azure queue";
    operation.Telemetry.Data = "Dequeue " + queue.Name;

    try
    {
        var message = await queue.GetMessageAsync();
    }
    catch (StorageException e)
    {
        operation.telemetry.Properties.Add("AzureServiceRequestID", e.RequestInformation.ServiceRequestID);
        operation.telemetry.Success = false;
        operation.telemetry.ResultCode = e.RequestInformation.HttpStatusCode.ToString();
        telemetryClient.TrackException(e);
    }
    finally
    {
        // Update status code and success as appropriate.
        telemetryClient.StopOperation(operation);
    }

    return null;
}

次の例では、受信メッセージは受信 HTTP 要求と同様の方法で追跡されます。

public async Task Process(MessagePayload message)
{
    // After the message is dequeued from the queue, create RequestTelemetry to track its processing.
    RequestTelemetry requestTelemetry = new RequestTelemetry { Name = "process " + queueName };
    
    // It might also make sense to get the name from the message.
    requestTelemetry.Context.Operation.Id = message.RootId;
    requestTelemetry.Context.Operation.ParentId = message.ParentId;

    var operation = telemetryClient.StartOperation(requestTelemetry);

    try
    {
        await ProcessMessage();
    }
    catch (Exception e)
    {
        telemetryClient.TrackException(e);
        throw;
    }
    finally
    {
        // Update status code and success as appropriate.
        telemetryClient.StopOperation(operation);
    }
}

ASP.NET Web アプリケーションの既定のカウンター:

• % プロセス\プロセッサ時間
• % Process\Processor Time Normalized
• Memory\Available Bytes
• ASP.NET Requests/Sec
• .NET 共通言語ランタイム (CLR) 例外が 1 秒ごとにスローされる
• ASP.NET ApplicationsRequest の実行時間
• Process\Private Bytes
• Process\IO Data Bytes/sec
• アプリケーション キュー内のアプリケーションの ASP.NET\要求
• Processor(_Total)\% Processor Time

ASP.NET Core Web アプリケーションの既定のカウンター:

• % プロセス\プロセッサ時間
• % Process\Processor Time Normalized
• Memory\Available Bytes
• Process\Private Bytes
• Process\IO Data Bytes/sec
• Processor(_Total)\% Processor Time

オプション 1: ApplicationInsights.configでの構成

1. ローカル サーバーで次の PowerShell コマンドを使用して、サーバーで使用できるカウンターを確認します。

   Get-Counter -ListSet *
   

   詳細については、Get-Counterを参照してください。

2. ApplicationInsights.configを開きます。

   開発中に Application Insights をアプリに追加した場合:

   1. プロジェクト内の ApplicationInsights.config を編集します。
   2. サーバーに再デプロイします。

3. パフォーマンス コレクター ディレクティブを編集します。

   
       <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.PerformanceCollectorModule, Microsoft.AI.PerfCounterCollector">
         <Counters>
           <Add PerformanceCounter="\Objects\Processes"/>
           <Add PerformanceCounter="\Sales(photo)\# Items Sold" ReportAs="Photo sales"/>
         </Counters>
       </Add>
   

標準カウンターと、自分で実装したカウンターの両方をキャプチャします。 \Objects\Processes は、すべての Windows システムで使用できる標準カウンターの例です。 \Sales(photo)\# Items Sold は、Web サービスに実装される可能性があるカスタム カウンターの例です。

形式は \Category(instance)\Counter、またはインスタンスがないカテゴリの場合は \Category\Counter。

ReportAsと一致しないカウンター名には、[a-zA-Z()/-_ \.]+ パラメーターが必要です。

インスタンスを指定すると、報告されたメトリックのディメンション CounterInstanceName になります。

オプション 2: コードでの構成

次のセクションを参照してください。

PerformanceCollectorModuleの WebApplication.CreateBuilder() メソッドの後にProgram.csを構成します。

using Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddApplicationInsightsTelemetry();

// The following configures PerformanceCollectorModule.

builder.Services.ConfigureTelemetryModule<PerformanceCollectorModule>((module, o) =>
    {
        // The application process name could be "dotnet" for ASP.NET Core self-hosted applications.
        module.Counters.Add(new PerformanceCounterCollectionRequest(@"\Process([replace-with-application-process-name])\Page Faults/sec", "DotnetPageFaultsPerfSec"));
    });

var app = builder.Build();

Application Insights .NET SDK は、多くの NuGet パッケージで構成されています。 コア パッケージは、Application Insights にテレメトリを送信するための API を提供します。 その他のパッケージ には、アプリケーションとそのコンテキストからのテレメトリを自動的に追跡するためのテレメトリ モジュール と 初期化子 が用意されています。 構成ファイルを調整することで、テレメトリ モジュールと初期化子を有効または無効にすることができます。 また、一部のパラメーターを設定することもできます。

構成ファイルには、 ApplicationInsights.config または ApplicationInsights.xmlという名前が付けられます。 名前は、アプリケーションの種類によって異なります。 ほとんどのバージョンの SDK をインストールすると、プロジェクトに自動的に追加されます。

既定では、 Add>Application Insights Telemetry をサポートする Visual Studio テンプレート プロジェクトの自動エクスペリエンスを使用すると、 ApplicationInsights.config ファイルがプロジェクト のルート フォルダーに作成されます。 コンパイル後、bin フォルダーにコピーされます。 また、 IIS サーバー上の Application Insights エージェントによって Web アプリにも追加されます。

Web ページに SDK を制御する同等のファイルはありません。

ASP.NET Core アプリケーションでは、特に指示がない限り、Startup.cs クラスの ConfigureServices() メソッドですべての構成変更が行われます。

オプション 1: コードでの構成

次のコードでは、ServerTelemetryChannelがカスタムの場所に設定されたStorageFolder インスタンスを設定します。 このコードは、アプリケーションの先頭 (通常は Global.aspx.cs の Application_Start() メソッド) に追加します。

using Microsoft.ApplicationInsights.Extensibility;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel;
protected void Application_Start()
{
    var serverTelemetryChannel = new ServerTelemetryChannel();
serverTelemetryChannel.StorageFolder = @"d:\temp\applicationinsights";
    serverTelemetryChannel.Initialize(TelemetryConfiguration.Active);
    TelemetryConfiguration.Active.TelemetryChannel = serverTelemetryChannel;
}

オプション 2: ApplicationInsights.configでの構成

ApplicationInsights.config の次のセクションでは、ServerTelemetryChannelをカスタムの場所に設定して構成されたStorageFolder チャネルを示します。

    <TelemetrySinks>
        <Add Name="default">
            <TelemetryProcessors>
                <!-- Telemetry processors omitted for brevity -->
            </TelemetryProcessors>
            <TelemetryChannel Type="Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.ServerTelemetryChannel, Microsoft.AI.ServerTelemetryChannel">
                <StorageFolder>d:\temp\applicationinsights</StorageFolder>
            </TelemetryChannel>
        </Add>
    </TelemetrySinks>

次に示すように、ConfigureServices クラスのStartup.cs メソッドを変更します。

using Microsoft.ApplicationInsights.Channel;
using Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel;

public void ConfigureServices(IServiceCollection services)
{
    // This sets up ServerTelemetryChannel with StorageFolder set to a custom ___location.
    services.AddSingleton(typeof(ITelemetryChannel), new ServerTelemetryChannel() {StorageFolder = @"d:\temp\applicationinsights" });

    services.AddApplicationInsightsTelemetry();
}

ServerTelemetryChannel のオーバーライド

既定のテレメトリ チャネルは ServerTelemetryChannel です。 次の例は、それをオーバーライドする方法を示したものです。

using Microsoft.ApplicationInsights.Channel;

var builder = WebApplication.CreateBuilder(args);

// Use the following to replace the default channel with InMemoryChannel.
// This can also be applied to ServerTelemetryChannel.
builder.Services.AddSingleton(typeof(ITelemetryChannel), new InMemoryChannel() {MaxTelemetryBufferCapacity = 19898 });

builder.Services.AddApplicationInsightsTelemetry();

var app = builder.Build();

各テレメトリ モジュールは、特定の種類のデータを収集し、コア API を使用してデータを送信します。 モジュールは異なる NuGet パッケージによってインストールされ、必要な行も .config ファイルに追加されます。

モジュールを構成、追加、または削除するには、TelemetryModules の セクションを使用します。 次の例を示します。

• DependencyTrackingTelemetryModuleを構成します (W3C ヘッダーインジェクションを有効にします)。
• EventCounterCollectionModuleを構成します (既定値をクリアし、1 つのカウンターを追加します)。
• PerformanceCollectorModuleを削除して、パフォーマンス カウンターコレクションを無効にします。

<ApplicationInsights>
  <TelemetryModules>

    <!-- Dependency tracking -->
    <Add Type="Microsoft.ApplicationInsights.DependencyCollector.DependencyTrackingTelemetryModule, Microsoft.AI.DependencyCollector">
      <!-- Match Core example: enable W3C header injection -->
      <EnableW3CHeadersInjection>true</EnableW3CHeadersInjection>
    </Add>

    <!-- EventCounterCollectionModule: add a single counter (if you use event counters) -->
    <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.EventCounterCollectionModule, Microsoft.AI.PerfCounterCollector">
      <Counters>
        <!-- Mirrors Core example: only collect 'gen-0-size' from System.Runtime -->
        <Add ProviderName="System.Runtime" CounterName="gen-0-size" />
      </Counters>
    </Add>

    <!-- PerformanceCollectorModule (classic Windows performance counters).
         To DISABLE perf-counter collection, do NOT include this module.
         If it already exists in your file, remove or comment it out.
         Example of the line you would remove:
    <Add Type="Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector.PerformanceCollectorModule, Microsoft.AI.PerfCounterCollector" />
    -->

  </TelemetryModules>
</ApplicationInsights>

オプション 1: ConfigureTelemetryModule を使用してテレメトリ モジュールを構成する

既定の TelemetryModule を構成するには、次の例のように、拡張メソッド ConfigureTelemetryModule<T> を IServiceCollection で使用します。

using Microsoft.ApplicationInsights.DependencyCollector;
using Microsoft.ApplicationInsights.Extensibility.PerfCounterCollector;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddApplicationInsightsTelemetry();

// The following configures DependencyTrackingTelemetryModule.
// Similarly, any other default modules can be configured.
builder.Services.ConfigureTelemetryModule<DependencyTrackingTelemetryModule>((module, o) =>
        {
            module.EnableW3CHeadersInjection = true;
        });

// The following removes all default counters from EventCounterCollectionModule, and adds a single one.
builder.Services.ConfigureTelemetryModule<EventCounterCollectionModule>((module, o) =>
        {
            module.Counters.Add(new EventCounterCollectionRequest("System.Runtime", "gen-0-size"));
        });

// The following removes PerformanceCollectorModule to disable perf-counter collection.
// Similarly, any other default modules can be removed.
var performanceCounterService = builder.Services.FirstOrDefault<ServiceDescriptor>(t => t.ImplementationType == typeof(PerformanceCollectorModule));
if (performanceCounterService != null)
{
    builder.Services.Remove(performanceCounterService);
}

var app = builder.Build();

オプション 2: ApplicationInsightsServiceOptions を使用してテレメトリ モジュールを構成する

SDK バージョン 2.12.2 以降では、次の例のように、 ApplicationInsightsServiceOptions を AddApplicationInsightsTelemetryに渡すことで、いくつかの一般的な設定を変更できます。

var builder = WebApplication.CreateBuilder(args);

var aiOptions = new Microsoft.ApplicationInsights.AspNetCore.Extensions.ApplicationInsightsServiceOptions();

// Disables adaptive sampling.
aiOptions.EnableAdaptiveSampling = false;

// Disables live metrics (also known as QuickPulse).
aiOptions.EnableQuickPulseMetricStream = false;

builder.Services.AddApplicationInsightsTelemetry(aiOptions);
var app = builder.Build();

次の表は、ApplicationInsightsServiceOptions の設定の完全な一覧です。

最新の一覧については、ApplicationInsightsServiceOptions での構成可能な設定に関するページを参照してください。

Microsoft.ApplicationInsights.AspNetCore SDK 2.15.0 以降の構成に関する推奨事項

Microsoft.ApplicationInsights.AspNetCore SDK バージョン 2.15.0 以降では、ApplicationInsightsServiceOptions で使用できるすべての設定 (ConnectionString を含む) を構成します。 アプリケーションの IConfiguration インスタンスを使用します。 次の例に示すように、設定は ApplicationInsights セクションの下に記載されている必要があります。 appsettings.json の次のセクションによって、接続文字列が構成され、アダプティブ サンプリングとパフォーマンス カウンターの収集が無効にされます。

{
    "ApplicationInsights": {
    "ConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000",
    "EnableAdaptiveSampling": false,
    "EnablePerformanceCounterCollectionModule": false
    }
}

ASP.NET Core 6.0 の builder.Services.AddApplicationInsightsTelemetry(aiOptions) または ASP.NET Core 3.1 以前の services.AddApplicationInsightsTelemetry(aiOptions) を使った場合、Microsoft.Extensions.Configuration.IConfiguration からの設定をオーバーライドします。

各モジュールの構成ファイルにノードがあります。 モジュールを無効にするには、ノードを削除するか、コメント アウトします。

テレメトリを条件付きで動的に無効にする必要がある場合は、コードの任意の場所で ASP.NET Core の依存関係挿入コンテナーを使用して TelemetryConfiguration インスタンスを解決し、それに DisableTelemetry フラグを設定することができます。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddApplicationInsightsTelemetry();

// any custom configuration can be done here:
builder.Services.Configure<TelemetryConfiguration>(x => x.DisableTelemetry = true);

var app = builder.Build();

前のコード サンプルでは、Application Insights にテレメトリが送信されなくなります。 これにより、自動収集モジュールでテレメトリが収集されなくなることはありません。 特定の自動コレクション モジュールを削除する場合は、 テレメトリ モジュールを参照してください。

テレメトリ初期化子は、テレメトリのすべての項目と共に送信されるコンテキスト プロパティを設定します。

独自の 初期化子を記述 して、コンテキスト プロパティを設定できます。

標準初期化子はすべて、Web パッケージまたは WindowsServer NuGet パッケージによって設定されます。

ASP.NET アプリケーションでテレメトリ初期化子を使用する方法については、「 Application Insights SDK でのテレメトリのフィルター処理と前処理」を参照してください。

次のコードで示すように、新しい TelemetryInitializer を DependencyInjection コンテナーに追加します。 TelemetryInitializer コンテナーに追加された DependencyInjection は、SDK によって自動的に認識されます。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddSingleton<ITelemetryInitializer, MyCustomTelemetryInitializer>();

var app = builder.Build();

テレメトリ初期化子を削除する

既定では、テレメトリ初期化子は存在します。 すべてまたは特定のテレメトリ初期化子を削除するには、 を呼び出した "後AddApplicationInsightsTelemetry()" で、次のサンプル コードを使用します。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddApplicationInsightsTelemetry();

// Remove a specific built-in telemetry initializer
var tiToRemove = builder.Services.FirstOrDefault<ServiceDescriptor>
                    (t => t.ImplementationType == typeof(AspNetCoreEnvironmentTelemetryInitializer));
if (tiToRemove != null)
{
    builder.Services.Remove(tiToRemove);
}

// Remove all initializers
// This requires importing namespace by using Microsoft.Extensions.DependencyInjection.Extensions;
builder.Services.RemoveAll(typeof(ITelemetryInitializer));

var app = builder.Build();

テレメトリ プロセッサは、SDK からポータルに送信される前に、各テレメトリ項目をフィルター処理および変更できます。

ASP.NET アプリケーションでテレメトリ プロセッサを使用する方法については、「 Application Insights SDK でのテレメトリのフィルター処理と前処理」を参照してください。

独自のテレメトリ プロセッサを記述できます。

アダプティブ サンプリング テレメトリ プロセッサ (2.0.0-beta3 から)

この機能は既定で有効になっています。 アプリが大量のテレメトリを送信すると、このプロセッサによってその一部が削除されます。

    <TelemetryProcessors>
      <Add Type="Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.AdaptiveSamplingTelemetryProcessor, Microsoft.AI.ServerTelemetryChannel">
        <MaxTelemetryItemsPerSecond>5</MaxTelemetryItemsPerSecond>
      </Add>
    </TelemetryProcessors>

このパラメーターは、アルゴリズムが達成しようとするターゲットを提供します。 SDK の各インスタンスは個別に動作します。 そのため、サーバーが複数のマシンのクラスターである場合は、それに応じてテレメトリの実際のボリュームが乗算されます。

サンプリングの詳細を確認 します。

固定レート サンプリング テレメトリ プロセッサ (2.0.0-beta1 から)

標準の サンプリング テレメトリ プロセッサ (2.0.1 から) もあります。

    <TelemetryProcessors>
     <Add Type="Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel.SamplingTelemetryProcessor, Microsoft.AI.ServerTelemetryChannel">

     <!-- Set a percentage close to 100/N where N is an integer. -->
     <!-- E.g. 50 (=100/2), 33.33 (=100/3), 25 (=100/4), 20, 1 (=100/100), 0.1 (=100/1000) -->
     <SamplingPercentage>10</SamplingPercentage>
     </Add>
   </TelemetryProcessors>

拡張メソッド TelemetryConfiguration を AddApplicationInsightsTelemetryProcessor で使用することで、カスタム テレメトリ プロセッサを IServiceCollection に追加できます。 テレメトリ プロセッサは、高度なフィルター処理のシナリオで使用します。 次の例を使用してください。

var builder = WebApplication.CreateBuilder(args);

// ...
builder.Services.AddApplicationInsightsTelemetry();
builder.Services.AddApplicationInsightsTelemetryProcessor<MyFirstCustomTelemetryProcessor>();

// If you have more processors:
builder.Services.AddApplicationInsightsTelemetryProcessor<MySecondCustomTelemetryProcessor>();

var app = builder.Build();

標準テレメトリ モジュールを含む、 TelemetryClientのすべてのインスタンスの接続文字列を設定するには、初期化メソッドで次の手順を実行します (ASP.NET サービスのglobal.aspx.csなど)。

using Microsoft.ApplicationInsights.Extensibility;
using Microsoft.ApplicationInsights;

    protected void Application_Start()
    {
        TelemetryConfiguration configuration = TelemetryConfiguration.CreateDefault();
        configuration.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000";
        var telemetryClient = new TelemetryClient(configuration);

特定のイベント セットを別のリソースに送信する場合は、特定のテレメトリ クライアントのキーを設定できます。

    var tc = new TelemetryClient();
    tc.Context.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000";
    tc.TrackEvent("myEvent");
    // ...

新しい接続文字列を取得するには、 Application Insights ポータルで新しいリソースを作成します。

ASP.NET Core で、依存関係挿入 (DI) コンテナーのProgram.csを使用して、アプリケーションの起動時にTelemetryConfigurationで接続文字列を構成します。

using Microsoft.ApplicationInsights.Extensibility;
using Microsoft.ApplicationInsights;

var builder = WebApplication.CreateBuilder(args);

// Add Application Insights
builder.Services.AddApplicationInsightsTelemetry();

var app = builder.Build();

// Resolve TelemetryConfiguration from DI and set the connection string
var config = app.Services.GetRequiredService<TelemetryConfiguration>();
config.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000";

app.Run();

特定のイベントセットを別のリソースに送信する場合は、新しい TelemetryClient インスタンスを作成し、その接続文字列を明示的に設定できます。

using Microsoft.ApplicationInsights;

var tc = new TelemetryClient();
tc.Context.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000";
tc.TrackEvent("myEvent");
// ...

ApplicationInsights.configを使用した構成例

<ApplicationInsights>
    ...
    <ApplicationIdProvider Type="Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId.ApplicationInsightsApplicationIdProvider, Microsoft.ApplicationInsights">
        <ProfileQueryEndpoint>https://dc.services.visualstudio.com/api/profiles/{0}/appId</ProfileQueryEndpoint>
    </ApplicationIdProvider>
    ...
</ApplicationInsights>

コードを使用した構成例

TelemetryConfiguration.Active.ApplicationIdProvider = new ApplicationInsightsApplicationIdProvider();

既定のプロバイダーをオーバーライドするか、その ProfileQueryEndpointをカスタマイズできます。

using Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId;

var builder = WebApplication.CreateBuilder(args);

// Add Application Insights
builder.Services.AddApplicationInsightsTelemetry();

// Replace default provider with custom configuration
builder.Services.AddSingleton<IApplicationIdProvider>(sp =>
    new ApplicationInsightsApplicationIdProvider
    {
        ProfileQueryEndpoint = "https://custom-proxy/api/profiles/{0}/appId"
    });

var app = builder.Build();
app.Run();

ApplicationInsights.configを使用した構成例

<ApplicationInsights>
    ...
    <ApplicationIdProvider Type="Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId.DictionaryApplicationIdProvider, Microsoft.ApplicationInsights">
        <Defined>
            <Type key="InstrumentationKey_1" value="ApplicationId_1"/>
            <Type key="InstrumentationKey_2" value="ApplicationId_2"/>
        </Defined>
        <Next Type="Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId.ApplicationInsightsApplicationIdProvider, Microsoft.ApplicationInsights" />
    </ApplicationIdProvider>
    ...
</ApplicationInsights>

コードを使用した構成例

TelemetryConfiguration.Active.ApplicationIdProvider = new DictionaryApplicationIdProvider{
 Defined = new Dictionary<string, string>
    {
        {"InstrumentationKey_1", "ApplicationId_1"},
        {"InstrumentationKey_2", "ApplicationId_2"}
    }
};

using Microsoft.ApplicationInsights.Extensibility.Implementation.ApplicationId;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddApplicationInsightsTelemetry();

// Register DictionaryApplicationIdProvider
builder.Services.AddSingleton<IApplicationIdProvider>(sp =>
    new DictionaryApplicationIdProvider
    {
        Defined = new Dictionary<string, string>
        {
            { "InstrumentationKey_1", "ApplicationId_1" },
            { "InstrumentationKey_2", "ApplicationId_2" }
        },
        Next = new ApplicationInsightsApplicationIdProvider() // optional fallback
    });

var app = builder.Build();
app.Run();

var requestTelemetry = HttpContext.Current?.Items["Microsoft.ApplicationInsights.RequestTelemetry"] as RequestTelemetry;

if (requestTelemetry != null)
{
    requestTelemetry.Properties["myProp"] = "someData";
}

HttpContext.Features.Get<RequestTelemetry>().Properties["myProp"] = someData

この記事のテンプレートベースの ASP.NET MVC アプリの場合、編集する必要があるファイルは _Layout.cshtml です。 それは、[ビュー]>[共有] の下にあります。 クライアント側の監視を追加するには、_Layout.cshtml を開き、クライアント側の JavaScript (Web) JavaScript SDK 構成に関する記事の JavaScript (Web) SDK ローダーのスクリプトベースのセットアップ手順に従います。

アプリケーションにクライアント側コンポーネントがある場合は、次の手順に従って、構成による JavaScript (Web) SDK ローダー スクリプトの挿入を使用して使用状況テレメトリの収集を開始します。

1. _ViewImports.cshtml で、次のインジェクションを追加します。

   @inject Microsoft.ApplicationInsights.AspNetCore.JavaScriptSnippet JavaScriptSnippet
   

2. _Layout.cshtml で、HtmlHelper セクションの終わりに (ただし、他のスクリプトの前に) <head> を挿入します。 ページからカスタム JavaScript テレメトリを報告する場合は、このスニペットの後に挿入します。

       @Html.Raw(JavaScriptSnippet.FullScript)
   </head>
   

Application Insights SDK for ASP.NET Core バージョン 2.14 以降では、FullScript を使用する代わりに、ScriptBody を使用できます。 コンテンツ セキュリティ ポリシーを設定するために ScriptBody タグをコントロールする必要がある場合は、<script> を使用します。

<script> // apply custom changes to this script tag.
    @Html.Raw(JavaScriptSnippet.ScriptBody)
</script>

上で参照されている .cshtml ファイル名は、既定の MVC アプリケーション テンプレートからのものです。 最終的に、アプリケーションに対するクライアント側の監視を正しく有効にするためには、JavaScript (Web) SDK ローダー スクリプトが、監視するアプリケーションの各ページの <head> セクションにある必要があります。 クライアント側の監視を有効にするために、アプリケーション テンプレートの _Layout.cshtml に JavaScript (Web) SDK ローダー スクリプトを追加します。

プロジェクトに _Layout.cshtml が含まれていない場合でも、アプリ内のすべてのページの を制御する同等のファイルに JavaScript (Web) SDK ローダー スクリプトを追加することで、<head>を追加できます。 または、複数のページに JavaScript (Web) SDK ローダー スクリプトを追加することもできますが、お勧めしません。