Toepassingsinstellingen Insights voor uw ASP.NET website

Artikel
11/03/2021
7 minuten om te lezen

Met deze procedure configureert u ASP.NET web-app voor het verzenden van telemetrie naar de application Insights-functie van de Azure Monitor service. Het werkt voor ASP.NET apps die worden gehost op uw eigen on-premises IIS-servers of in de cloud.

Notitie

Er is een op OpenTelemetry gebaseerde .NET-preview-aanbieding beschikbaar. Meer informatie.

Vereisten

Als u Application Insights wilt toevoegen aan uw ASP.NET-website, moet u het volgende doen:

Installeer de nieuwste versie van Visual Studio 2019 voor Windows met de volgende workloads:
- ASP.NET-ontwikkeling en webontwikkeling
- Azure-ontwikkeling
Maak een gratis Azure-account als u nog geen Azure-abonnement hebt.
Maak een application Insights resource op basis van een werkruimte.

Belangrijk

U wordt aangeraden verbindingsreeksen via instrumentatiesleutels te gebruiken. Nieuwe Azure-regio's vereisen het gebruik van verbindingsreeksen in plaats van instrumentatiesleutels.

Een connection string identificeert de resource die u wilt koppelen aan uw telemetriegegevens. U kunt hiermee ook de eindpunten wijzigen die door uw resource worden gebruikt als bestemming voor uw telemetrie. U moet de gegevens kopiëren connection string toevoegen aan de code van uw toepassing of aan een omgevingsvariabele.

Een eenvoudige web ASP.NET-app maken

Open Visual Studio 2019.
Selecteer Bestand > Nieuw > Project.
Selecteer ASP.NET C# voor webtoepassing (.NET Framework).
Voer een projectnaam in en selecteer vervolgens Maken.
Selecteer MVC > Maken.

Toepassings Insights toevoegen

In deze sectie wordt u begeleid bij het automatisch toevoegen van application Insights aan een web-app op basis van ASP.NET sjabloon. Vanuit uw ASP.NET web-app-project in Visual Studio:

Selecteer Project > Add Application Insights Telemetry Application Insights > Sdk (local) > Next > Finish > Close.
Open het ApplicationInsights.config bestand.
Voeg </ApplicationInsights> vóór de afsluitende tag een regel toe die de instrumentatiesleutel voor uw Application Insights bevat. U vindt uw instrumentatiesleutel in het overzichtsvenster van de zojuist gemaakte Application Insights-resource die u hebt gemaakt als onderdeel van de vereisten voor dit artikel.
```
<InstrumentationKey>your-instrumentation-key-goes-here</InstrumentationKey>
```
Selecteer Project > NuGet-pakketten beheren > Updates. Werk vervolgens elk Microsoft.ApplicationInsights NuGet-pakket bij naar de nieuwste stabiele release.
Voer uw toepassing uit door IIS Express. Er wordt ASP.NET eenvoudige app geopend. Wanneer u door de pagina's op de site bladert, wordt telemetrie verzonden naar Application Insights.

Toepassings Insights toevoegen

In deze sectie wordt u begeleid bij het handmatig toevoegen van application Insights aan een web-app op ASP.NET sjabloon. In deze sectie wordt ervan uitgenomen dat u een web-app gebruikt op basis van de standaard-MVC-web-app-sjabloon voor het ASP.NET Framework.

Voeg de volgende NuGet-pakketten en hun afhankelijkheden toe aan uw project:
In sommige gevallen wordt hetApplicationInsights.config automatisch voor u gemaakt. Als het bestand al aanwezig is, gaat u verder met stap 4.

Als deze niet automatisch wordt gemaakt, moet u deze zelf maken. Maak op hetzelfde niveau in uw project als het bestand Global.asax een nieuw bestand met de naamApplicationInsights.config.

Kopieer de volgende XML-configuratie naar het zojuist gemaakte bestand:

<?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>Microsoft.Azure.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>
     </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
 -->
 <InstrumentationKey>your-instrumentation-key-here</InstrumentationKey>
</ApplicationInsights>

Voeg </ApplicationInsights> vóór de afsluitende tag uw instrumentatiesleutel toe voor uw Application Insights-resource. U vindt uw instrumentatiesleutel in het overzichtsvenster van de zojuist gemaakte Application Insights-resource die u hebt gemaakt als onderdeel van de vereisten voor dit artikel.
```
<InstrumentationKey>your-instrumentation-key-goes-here</InstrumentationKey>
```

Maak op hetzelfde niveau van uw project als het ApplicationInsights.config-bestand een map met de naam ErrorHandler met een nieuw C#-bestand met de naam AiHandleErrorAttribute.cs. De inhoud van het bestand ziet er als volgende uit:

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);
        }
    }
}

Open in App_Start map FilterConfig.cs en wijzig dit in het voorbeeld:

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());
        }
    }
}

Als Web.config is bijgewerkt, slaat u deze stap over. Werk het bestand anders als volgt bij:

<?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>

U hebt nu toepassingsbewaking aan serverzijde geconfigureerd. Als u uw web-app hebt uitgevoerd, ziet u dat de telemetrie wordt weergegeven in Application Insights.

Bewaking aan clientzijde toevoegen

De vorige secties boden richtlijnen voor methoden voor het automatisch en handmatig configureren van bewaking aan serverzijde. Als u bewaking aan de clientzijde wilt toevoegen, gebruikt u de JavaScript SDK aan de clientzijde. U kunt de transacties aan de clientzijde van een webpagina bewaken door een JavaScript-fragment toe te voegen vóór de afsluitende tag van de </head> HTML van de pagina.

Hoewel het mogelijk is om het fragment handmatig toe te voegen aan de header van elke HTML-pagina, raden we u aan het fragment toe te voegen aan een primaire pagina. Met deze actie wordt het fragment op alle pagina's van een site geplaatst.

Voor de op sjablonen gebaseerde ASP.NET MVC-app uit dit artikel is het bestand dat u moet bewerken _Layout.cshtml. U vindt deze onder Gedeelde > weergaven. Als u bewaking aan de clientzijde wilt toevoegen, opent u _Layout.cshtml en volgt u de installatie-instructies op basis van fragmenten uit het artikel over JavaScript SDK-configuratie aan clientzijde.

Problemen oplossen

Er is een bekend probleem in de huidige versie van Visual Studio 2019: het opslaan van de instrumentatiesleutel in een gebruikersgeheim wordt verbroken voor .NET Framework-apps. De sleutel moet uiteindelijk worden gehard in hetapplicationinsights.config om deze fout te kunnen omdraaien. Dit artikel is ontworpen om dit probleem volledig te voorkomen door geen gebruik te maken van gebruikersgeheimen.

Opensource-SDK

Lees en draag bij aan de code.

Raadpleeg de opmerkingen bij de release voor de meest recente updates en oplossingen voor fouten.

Volgende stappen

Voeg synthetische transacties toe om te testen of uw website overal ter wereld beschikbaar is met beschikbaarheidsbewaking.
Configureer steekproeven om de kosten voor telemetrieverkeer en gegevensopslag te verlagen.

Toepassingsinstellingen Insights voor uw ASP.NET website

Beoordeel uw ervaring

Vereisten

Een eenvoudige web ASP.NET-app maken

Toepassings Insights toevoegen

Toepassings Insights toevoegen

Bewaking aan clientzijde toevoegen

Problemen oplossen

Opensource-SDK

Volgende stappen