Application Insights 中 .NET 的计数器

Windows 提供了各种性能计数器，例如用于收集处理器、内存和磁盘使用统计信息的计数器。 你还可以定义自己的性能计数器。

如果应用程序在本地主机或具有管理访问权限的虚拟机上的 Internet 信息服务器 (IIS) 下运行，则应用程序支持性能计数器收集。 作为 Azure Web 应用运行的应用程序无法直接访问性能计数器，但 Application Insights 会收集一部分可用的计数器。

通过将应用程序池服务帐户添加到性能监视器用户组来为其授予监视性能计数器的权限。

net localgroup "Performance Monitor Users" /add "IIS APPPOOL\NameOfYourPool"

“指标”窗格显示了一组默认的性能计数器。

ASP.NET Web 应用程序的默认计数器：

• % 进程\处理器时间
• % Process\Processor Time Normalized
• Memory\可用字节
• ASP.NET Requests/Sec
• .NET Common Language Runtime (CLR) Exceptions Thrown / sec
• ASP.NET 应用程序请求执行时间
• 进程\私有字节
• Process\IO Data Bytes/sec
• ASP.NET Applications\Requests In Application Queue
• Processor(_Total)\% Processor Time

ASP.NET Core Web 应用程序的默认计数器：

• % Process\Processor Time
• % Process\Processor Time Normalized
• 内存\可用字节数
• 进程\专用字节
• Process\IO Data Bytes/sec
• Processor(_Total)\% Processor Time

如果你需要的性能计数器未包括在指标列表中，则你可以添加它。

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 维度。

若要收集系统性能计数器并将其发送到 Application Insights，可以改编以下代码片段：

    var perfCollectorModule = new PerformanceCollectorModule();
    perfCollectorModule.Counters.Add(new PerformanceCounterCollectionRequest(
      @"\Process([replace-with-application-process-name])\Page Faults/sec", "PageFaultsPerfSec"));
    perfCollectorModule.Initialize(TelemetryConfiguration.Active);

或者，可以执行与所创建自定义指标相同的操作：

    var perfCollectorModule = new PerformanceCollectorModule();
    perfCollectorModule.Counters.Add(new PerformanceCounterCollectionRequest(
      @"\Sales(photo)\# Items Sold", "Photo sales"));
    perfCollectorModule.Initialize(TelemetryConfiguration.Active);

在 Program.cs 中于 WebApplication.CreateBuilder() 方法之后配置 PerformanceCollectorModule：

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

后续各节讨论 ASP.NET 和 Application Insights 计数。

部署到 Azure Web 应用的 ASP.NET 和 ASP.NET Core 应用程序在特殊的沙盒环境中运行。 部署到 Azure 应用服务的应用程序可以利用 Windows 容器，也可以在沙盒环境中托管。 如果在 Windows 容器中部署应用程序，则可在容器映像中使用所有标准性能计数器。

沙盒环境不允许直接访问系统性能计数器。 但是，有限的一部分计数器将作为环境变量公开，如作为环境变量公开的性能计数器中所述。 在此环境中，只有一部分计数器可用。 有关完整列表，请参阅作为环境变量公开的性能计数器。

适用于 ASP.NET 和 ASP.NET Core 的 Application Insights SDK 会检测代码是部署到 Web 应用还是非 Windows 容器。 这种检测决定了它是在沙盒环境中还是利用标准收集机制（在 Windows 容器或虚拟机上托管时）来收集性能计数器。

对 ASP.NET Core 中性能计数器的支持是有限的：

• 如果应用程序在 Azure Web 应用 (Windows) 中运行，SDK 2.4.1 及更高版本将收集性能计数器。
• 如果应用程序在 Windows 中运行，并且面向 NETSTANDARD2.0 或更高版本，则 SDK 2.7.1 版和更高版本将收集性能计数器。
• 对于面向 .NET Framework 的应用程序，所有版本的 SDK 都支持性能计数器。
• SDK 2.8.0 和更高版本在 Linux 中支持 CPU/内存计数器。 在 Linux 中不支持其他计数器。 若要获取 Linux（和其他非 Windows 环境）中的系统计数器，请使用事件计数器。

EventCounter 是用于发布和使用计数器或统计信息的 .NET/.NET Core 机制。 所有 OS 平台（Windows、Linux 和 macOS）都支持 EventCounters。 可以将其视为 PerformanceCounters 的跨平台等效版本，而 PerformanceCounters 仅在 Windows 系统中受支持。

虽然用户可以根据需要发布任何自定义事件计数器，但默认情况下，.NET 会发布一组此类计数器。 该文档指导你完成在 Azure Application Insights 中收集和查看事件计数器（系统定义的或用户定义的）所需的步骤。

Application Insights 支持使用 EventCounterCollectionModule 来收集 EventCounters，新发布的 NuGet 包 Microsoft.ApplicationInsights.EventCounterCollector 中包含该模块。 使用 EventCounterCollectionModule 或 WorkerService 时，将自动启用 。 EventCounterCollectionModule 以 60 秒的不可配置收集频率收集计数器。 收集 EventCounters 时，不需要具备特殊的权限。 对于 ASP.NET Core 应用程序，你还需要添加 Microsoft.ApplicationInsights.AspNetCore 包。

dotnet add package Microsoft.ApplicationInsights.EventCounterCollector
dotnet add package Microsoft.ApplicationInsights.AspNetCore

从 AspNetCore SDK 或 WorkerService SDK 的 2.15.0 版本开始，默认情况下不收集任何计数器。 模块本身已启用，因此用户可向其添加所需的计数器以收集它们。

若要获取由 .NET 运行时发布的常用计数器列表，请参阅可用计数器文档。

以下示例介绍如何添加/删除计数器。 使用 AddApplicationInsightsTelemetry() 或 AddApplicationInsightsWorkerService() 启用 Application Insights 遥测收集后，此自定义将作为应用程序服务配置的一部分完成。 下面是 ASP.NET Core 应用程序的示例代码。 对于其他类型的应用程序，请参阅此文档。

using Microsoft.ApplicationInsights.Extensibility.EventCounterCollector;
using Microsoft.Extensions.DependencyInjection;

builder.Services.ConfigureTelemetryModule<EventCounterCollectionModule>(
        (module, o) =>
        {
            // Removes all default counters, if any.
            module.Counters.Clear();

            // Adds a user defined counter "MyCounter" from EventSource named "MyEventSource"
            module.Counters.Add(
                new EventCounterCollectionRequest("MyEventSource", "MyCounter"));

            // Adds the system counter "gen-0-size" from "System.Runtime"
            module.Counters.Add(
                new EventCounterCollectionRequest("System.Runtime", "gen-0-size"));
        }
    );

可以使用 ApplicationInsightsServiceOptions 禁用 EventCounterCollectionModule。

以下示例使用 ASP.NET Core SDK。

using Microsoft.ApplicationInsights.AspNetCore.Extensions;
using Microsoft.Extensions.DependencyInjection;

var applicationInsightsServiceOptions = new ApplicationInsightsServiceOptions();
applicationInsightsServiceOptions.EnableEventCounterCollectionModule = false;
builder.Services.AddApplicationInsightsTelemetry(applicationInsightsServiceOptions);

类似的方法也可用于 WorkerService SDK，但必须更改命名空间，如以下示例中所示。

using Microsoft.ApplicationInsights.AspNetCore.Extensions;
using Microsoft.Extensions.DependencyInjection;

var applicationInsightsServiceOptions = new ApplicationInsightsServiceOptions();
applicationInsightsServiceOptions.EnableEventCounterCollectionModule = false;
builder.Services.AddApplicationInsightsTelemetry(applicationInsightsServiceOptions);

可以在 Log Analytics 中搜索并显示性能计数器报告。

PerformanceCounters 架构公开每个性能计数器的 category、counter 名称和 instance 名称。 在每个应用程序的遥测中，将仅看到该应用程序的计数器。 例如，若要查看哪些计数器可用：

performanceCounters | summarize count(), avg(value) by category, instance, counter

此处的 Instance 是指性能计数器实例，而不是角色或服务器计算机实例。 通常，性能计数器实例名称会按进程或应用程序的名称对计数器（如处理器时间）进行分段。

若要获取最近一段时间内可用内存的图表：

performanceCounters | where counter == "Available Bytes" | summarize avg(value), min(value) by bin(timestamp, 1h) | render timechart

与其他遥测一样，performanceCounters 也有一个列 cloud_RoleInstance ，用于指示您的应用正在其上运行的主机服务器实例的标识。 例如，要比较应用在不同计算机上的性能：

performanceCounters | where counter == "% Processor Time" and instance == "SendMetrics" | summarize avg(value) by cloud_RoleInstance, bin(timestamp, 1d)

你可以在 Log Analytics 的“customMetrics”表中搜索和显示事件计数器报表。

例如，运行以下查询，以查看收集了哪些计数器并可用于查询：

customMetrics | summarize avg(value) by name

若要在最近一段时间内获取特定计数器（例如：ThreadPool Completed Work Item Count）的图表，请运行以下查询。

customMetrics 
| where name contains "System.Runtime|ThreadPool Completed Work Item Count"
| where timestamp >= ago(1h)
| summarize  avg(value) by cloud_RoleInstance, bin(timestamp, 1m)
| render timechart

与其他遥测类似，customMetrics 也有一个列 cloud_RoleInstance，指示应用运行所在主机服务器实例的身份。 上述查询显示每个实例的计数器值，并可用于比较不同服务器实例的性能。

• Exception rate：“异常率”是系统性能计数器。 CLR 会对所有引发的已处理和未经处理异常进行计数，并将总采样间隔除以间隔长度。 Application Insights SDK 会收集此结果，并将其发送到门户。
• Exceptions：异常指标根据图表的采样间隔对门户收到的 TrackException 报告进行计数。 它仅包括在代码中编写 TrackException 调用的已处理异常。 它不包括所有未经处理的异常。

实时指标不显示事件计数器。 使用 Metric Explorer 或 Analytics 来查看遥测数据。

ASP.NET Core 的 Application Insights 扩展尚不支持此功能。