通过

适用于 Azure 云服务的 Application Insights

  • 项目

Application Insights 可以通过将 Application Insights SDK 提供的数据与云服务提供的 Azure 诊断数据合并，来监视 Azure 云服务应用的可用性、性能、故障和使用情况。 通过收到的有关应用在现实中的性能和有效性的反馈，可以针对每个开发生命周期确定合理的设计方向。

“概述”仪表板

注意

对检测密钥引入的支持将于 2025 年 3 月 31 日结束。 检测密钥引入功能将会继续工作，但我们将不再为该功能提供更新或支持。 转换为连接字符串，以利用新功能。

先决条件

开始前，需要具备：

  • 一个 Azure 订阅。

    使用 Windows、XBox Live 或其他 Microsoft 云服务的 Microsoft 帐户登录。

  • Microsoft Azure Tools 2.9 或更高版本。

  • Developer Analytics Tools 7.10 或更高版本。

快速入门

使用 Application Insights 监视云服务的最快、最简单方法是将服务发布到 Azure 时选择 Application Insights 选项。

示例“诊断设置”页

此选项可在运行时检测应用，提供监视请求所需的全部遥测数据、Web 角色中的异常和依赖项。 它还可以辅助角色中的性能计数器。 应用生成的所有诊断跟踪也会发送到 Application Insights。

如果只需此选项，则操作到此完成。

后续步骤是通过应用查看指标和使用 Analytics 查询数据。

若要在浏览器中监视性能，还可能需要设置可用性测试并将代码添加到网页。

下一部分将介绍以下附加选项：

  • 通过不同的组件发送数据，以及在单独的资源上生成配置。
  • 通过应用添加自定义遥测。

使用 Application Insights 检测的示例应用

在此示例应用中，Application Insights 已添加到某个云服务，该服务包含 Azure 中托管的两个辅助角色。

下一部分介绍如何以相同的方式改编你自己的云服务项目。

规划资源和资源组

应用中的遥测数据在 Application Insights 类型的 Azure 资源中进行存储、分析和显示。

每个资源属于一个资源组。 资源组用于管理成本、向团队成员授予访问权限，以及在单个协调式事务中部署更新。 例如，可以编写一个脚本，以通过一个操作部署 Azure 云服务及其 Application Insights 监视资源。

组件的资源

建议将维度属性添加到标识其源角色的每个遥测项。 在此方法中，异常等指标图表通常显示不同角色的计数汇总，但你可根据需要按角色标识符将图表分段。 还可以按同一个维度筛选搜索结果。 使用这种备选方法可以方便一次性查看所有信息，但同时可能导致在角色之间产生一定的混淆。

浏览器遥测数据通常包含在与服务器端 Web 角色相同的资源中。

可将不同组件的 Application Insights 资源放在一个资源组中。 使用此方法可以轻松统一管理这些资源。

将开发、测试和生产隔开

要开发适合下一功能的自定义事件但上一版本仍有效，可将开发遥测数据发送到独立的 Application Insights 资源。 否则，可能很难在实时站点的所有流量中找到测试遥测数据。

为了避免这种情况，可以单独为系统的每个生成配置或“堆栈”（开发、测试、生产等）创建资源。 将每个生成配置的资源放在独立的资源组中。

若要将遥测数据发送到相应的资源，可以设置 Application Insights SDK，使其根据生成配置选择不同的检测密钥。

了解如何为不同的阶段动态设置检测密钥。

为每个角色创建 Application Insights 资源

如果你决定为每个角色单独创建资源（也许是为每个生成配置单独创建资源集），最简单的方法是在 Application Insights 门户中创建这些资源。 若要创建大量的资源，可将创建过程自动化。

  1. 在 Azure 门户中，选择“新建”>“开发人员服务”>“Application Insights”。

    “Application Insights”窗格

  2. 在“应用程序类型”下拉列表中，选择“ASP.NET Web 应用程序” 。

每个资源由检测密钥标识。 以后若要手动配置或验证 SDK 的配置，可能需要使用此密钥。

为每个角色设置 Azure 诊断

设置此选项可以使用 Application Insights 监视应用。 对于 Web 角色，此选项可提供性能监视、警报、诊断以及使用情况分析。 对于其他角色，可以搜索和监视 Azure 诊断信息，例如重启、性能计数器和对 System.Diagnostics.Trace 的调用。

  1. 在 Visual Studio 解决方案资源管理器中，在“<YourCloudService>”>“角色”下面，打开每个角色的属性。

  2. 在“配置”中，选中“将诊断数据发送到 Application Insights”复选框，然后选择前面创建的 Application Insights 资源。

如果决定对每个生成配置使用不同的 Application Insights 资源，请先选择该配置。

配置 Application Insights

这相当于将 Application Insights 检测密钥插入到名为 ServiceConfiguration.*.cscfg 的文件。 下面是示例代码。

若要改变发送到 Application Insights 的诊断信息级别，可以直接编辑 .cscfg 文件。

在每个项目中安装 SDK

使用此选项可将自定义的业务遥测添加到任何角色。 使用该选项可以更细致地分析应用的用法和性能。

在 Visual Studio 中，为每个云应用项目配置 Application Insights SDK。

  1. 若要配置 Web 角色，请右键单击项目，并选择“配置 Application Insights”或“添加”>“Application Insights 遥测”。

  2. 配置辅助角色：

    a. 右键单击项目，并选择“管理 NuGet 包”。

    b. 添加适用于 Windows Server 的 Application Insights。

  3. 将 SDK 配置为向 Application Insights 资源发送数据：

    a. 在适当的启动函数中，通过 .cscfg 文件中的配置设置指定检测密钥：

        TelemetryConfiguration configuration = TelemetryConfiguration.CreateDefault();
    configuration.InstrumentationKey = RoleEnvironment.GetConfigurationSettingValue("APPINSIGHTS_INSTRUMENTATIONKEY");
    var telemetryClient = new TelemetryClient(configuration);

    b. 针对应用中的每个角色重复“步骤 a”。 参阅示例：

  4. 将 ApplicationInsights.config 文件设置为始终复制到输出目录。

    .config 文件中的消息会询问是否要将检测密钥放在该处。 但是，对于云应用，最好是通过 .cscfg 文件设置检测密钥。 此方法可确保在门户中正确识别角色。

设置状态监视器以收集完整的 SQL 查询（可选）

仅当你希望在 .NET Framework 上捕获完整的 SQL 查询时，才需要此步骤。

  1. 在 \*.csdef 文件中为每个角色添加启动任务，如下所示

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

  2. 下载 InstallAgent.bat 和 InstallAgent.ps1，将它们放入每个角色项目的 AppInsightsAgent 文件夹中。 确保通过 Visual Studio 文件属性或生成脚本将它们复制到输出目录。

  3. 在所有辅助角色上添加环境变量：

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

运行并发布应用

  1. 运行应用并登录到 Azure。

  2. 打开前面创建的 Application Insights 资源。

    搜索中会显示每个数据点，指标资源管理器中会显示聚合数据。

  3. 添加更多遥测数据（请参阅以下部分），然后发布应用以获取实时诊断和使用情况反馈。

如果没有数据，请执行以下操作：

  1. 若要查看各个事件，请打开搜索磁贴。
  2. 在应用中打开各个页面，以生成一些遥测数据。
  3. 等待几秒，然后单击“刷新”。

查看 Azure 诊断事件

可以在 Application Insights 中的以下位置找到 Azure 诊断信息：

  • 性能计数器显示为自定义指标。
  • Windows 事件日志显示为跟踪和自定义事件。
  • 应用程序日志、ETW 日志和所有诊断基础结构日志均显示为跟踪。

若要查看性能计数器和事件计数，请打开指标资源管理器并添加以下图表：

Azure 诊断数据

若要在 Azure 诊断发送的各种跟踪日志中进行搜索，请使用搜索或 Analytics 查询。 例如，假设某个未经处理的异常导致角色崩溃和回收。 该信息会在应用程序通道的 Windows 事件日志中显示。 可使用搜索来查看 Windows 事件日志错误，并获取异常的完整堆栈跟踪。 这样有助于找到问题的根本原因。

Azure 诊断搜索

其他遥测数据

以下部分从应用的不同层面介绍如何获取其他遥测数据。

从辅助角色跟踪请求

在 Web 角色中，请求模块会自动收集有关 HTTP 请求的数据。 有关如何覆盖默认收集行为的示例，请参阅示例 MVCWebRole。

可以像跟踪 HTTP 请求一样捕获辅助角色调用的性能。 在 Application Insights 中，请求遥测类型用于测量一个单位的可计时且可独立成功/失败的命名服务器端工作。 尽管 SDK 可以自动捕获 HTTP 请求，但你也可以插入自己的代码来跟踪针对辅助角色发出的请求。

请参阅报告请求的两个检测示例辅助角色：

异常

有关如何从不同的 Web 应用类型收集未经处理的异常的信息，请参阅在 Application Insights 中监视异常。

该示例 Web 角色包含 MVC5 和 Web API 2 控制器。 可使用以下处理程序捕获这两个控制器的未经处理的异常：

对于辅助角色，可通过两种方式跟踪异常：

  • 使用 TrackException(ex)。
  • 如果已添加 Application Insights 跟踪侦听程序 NuGet 包，可按此示例所示，使用 System.Diagnostics.Trace 来记录异常。

性能计数器

默认收集以下计数器：

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

对于 Web 角色，还将收集以下计数器：

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

可以通过编辑 ApplicationInsights.config 来指定其他自定义或其他 Windows 性能计数器，如以下示例所示。

性能计数器

辅助角色的关联遥测数据

若要获得丰富的诊断体验，可以查看请求失败或长时间延迟的原因。 使用 Web 角色，SDK 可在相关遥测数据之间自动设置关联。

若要获取辅助角色的此视图，可以使用自定义遥测初始值设定项为所有遥测设置一个通用的 Operation.Id 上下文属性。 这样，延迟或失败问题是否由依赖项或代码造成便一目了然。

方法如下：

  • 按此示例所示，将 correlationId 设置到 CallContext 中。 本例使用请求 ID 作为 correlationId。
  • 添加自定义 TelemetryInitializer 实现，将 Operation.Id 设置为前面所设置的 correlationId。 有关示例，请参阅 ItemCorrelationTelemetryInitializer。
  • 添加自定义遥测初始值设定项。 可按此示例所示，在 ApplicationInsights.config 文件或代码中执行此操作。

客户端遥测数据

若要获取基于浏览器的遥测数据（例如页面查看次数、页面加载时间或脚本异常）以及在页面脚本中编写自定义遥测，请参阅将 JavaScript SDK 添加到网页。

可用性测试

为确保应用处于活动状态且能够做出响应，请设置 Web 测试。

统一显示所有信息

若要获得系统的整体视图，可在一个仪表板中将关键的监视图表一起显示。 例如，可以固定每个角色的请求和失败次数。

如果系统使用其他 Azure 服务（例如流分析），也可以包含这些服务的监视图表。

如果有客户端移动应用，请使用 App Center。 在 Analytics 中创建查询来显示事件计数，并将事件固定到仪表板。

示例

该示例监视包含一个 Web 角色和两个辅助角色的服务。

在 Azure 云服务中运行时发生“找不到方法”异常

生成的项目是否面向 .NET LTS？ 在 Azure 云服务角色中不会自动支持较早版本。 请先在每个角色上安装 .NET LTS，然后再运行你的应用。

后续步骤