在 Azure 应用程序服务中为 .NET、Node.js、Python 和 Java 应用程序启用应用程序监视
自动检测（也称为运行时监视）是启用适用于 Azure 应用程序服务的 Application Insights 的最简单方法，无需任何代码更改或高级配置。 根据具体的应用场景，通过手动检测评估是否需要更高级的监视。
重要
如果同时检测到自动检测监视和手动基于 SDK 的检测，则只会采用手动检测设置。 这样安排可防止发送重复数据。 若要了解详细信息，请参阅故障排除。
备注
不支持 APPINSIGHTS_JAVASCRIPT_ENABLED 和 urlCompression 的组合。 有关详细信息，请参阅疑难解答。
在应用程序服务的左侧导航菜单中选择“Application Insights”，然后选择“启用”。
创建新资源，或为此应用程序选择现有 Application Insights 资源。
备注
选择“确定”以创建新资源时，系统将提示你“应用监视设置”。 选择“继续”会将新的 Application Insights 资源链接到应用程序服务。 然后，应用程序服务将重启。
指定要使用哪些资源后，可以选择 Application Insights 根据平台为应用程序收集数据的方式。 ASP.NET 应用监视默认启用，提供两种不同级别的集合，即建议和基本。
下表汇总了为每个路由收集的数据。
Data 建议 基本 添加 CPU、内存和 I/O 使用情况趋势 是 否 收集使用情况趋势，并启用从可用性结果到事务的关联 是 是 收集未经主机进程处理的异常 是 是 提高使用采样时，负载下的 APM 指标准确性 是 是 跨请求/依赖项边界关联微服务 是 否（仅单实例 APM 功能）
从版本 2.8.9 自动升级，无需其他操作。 新的监视位将在后台传送到目标应用程序服务，应用程序重启时会拾取这些位。
若要查看正在运行的扩展的版本，请转到 https://yoursitename.scm.chinacloudsites.cn/ApplicationInsights。
从版本 2.8.9 开始，将使用预装的站点扩展。 如果使用更低的版本，可通过下述两种方法之一进行更新：
通过 Azure 门户启用升级：即使安装了应用程序服务的 Application Insights 扩展，UI 也仅显示“启用”按钮。 在幕后，会移除旧的专用站点扩展。
-
- 设置应用程序设置以启用预装的站点扩展
ApplicationInsightsAgent。 有关详细信息，请参阅通过 PowerShell 启用。 - 手动删除名为 Azure 应用程序服务的 Application Insights 扩展的专用站点扩展。
- 设置应用程序设置以启用预装的站点扩展
如果已从低于 2.5.1 的版本完成升级，请检查是否已从应用程序 bin 文件夹中移除了 ApplicationInsights DLL。 有关详细信息，请参阅疑难解答。
若要配置采样，以前可以通过 applicationinsights.config 文件来控制，现在可以通过具有相应前缀 MicrosoftAppInsights_AdaptiveSamplingTelemetryProcessor 的应用程序设置与之交互。
例如，若要更改初始采样百分比，可以创建名为
MicrosoftAppInsights_AdaptiveSamplingTelemetryProcessor_InitialSamplingPercentage且值为100的应用程序设置。若要禁用采样，请将
MicrosoftAppInsights_AdaptiveSamplingTelemetryProcessor_MinSamplingPercentage设置为值100。支持的设置包括：
MicrosoftAppInsights_AdaptiveSamplingTelemetryProcessor_InitialSamplingPercentageMicrosoftAppInsights_AdaptiveSamplingTelemetryProcessor_MinSamplingPercentageMicrosoftAppInsights_AdaptiveSamplingTelemetryProcessor_EvaluationIntervalMicrosoftAppInsights_AdaptiveSamplingTelemetryProcessor_MaxTelemetryItemsPerSecond
可以选择为 ASP.NET 启用客户端监视。 若要启用客户端监视：
选择“设置”>“配置”。
在“应用程序设置”下，创建新应用程序设置：
- 名称：输入 APPINSIGHTS_JAVASCRIPT_ENABLED。
- 值：输入 true。
保存设置并重启应用。
若要禁用客户端监视，请从“应用程序设置”中移除关联的键值对，或者将值设置为 false。
若要为 Application Insights 启用遥测数据收集，只需设置以下应用程序设置：
| 应用设置名称 | 定义 | Value |
|---|---|---|
| ApplicationInsightsAgent_EXTENSION_VERSION | 用于控制运行时监视的主扩展。 | ~2 |
| XDT_MicrosoftApplicationInsights_Mode | 默认模式下，仅启用基本功能以确保最佳性能。 | default 或 recommended |
| InstrumentationEngine_EXTENSION_VERSION | 控制是否要启用二进制重写引擎 InstrumentationEngine。 此设置会对性能以及冷启动/启动时间造成影响。 |
~1 |
| XDT_MicrosoftApplicationInsights_BaseExtensions | 控制是否要随依赖项调用一起捕获 SQL 和 Azure 表文本。 性能警告：应用程序冷启动时间会受影响。 此设置需要 InstrumentationEngine。 |
~1 |
可以使用 Azure 资源管理器模板来管理和配置 Azure 应用程序服务的应用程序设置。 在使用资源管理器自动化部署新的应用程序服务资源或修改现有资源的设置时，可以使用此方法。
下面是应用程序服务资源的应用程序设置 JSON 的基本结构：
"resources": [
{
"name": "appsettings",
"type": "config",
"apiVersion": "2015-08-01",
"dependsOn": [
"[resourceId('Microsoft.Web/sites', variables('webSiteName'))]"
],
"tags": {
"displayName": "Application Insights Settings"
},
"properties": {
"key1": "value1",
"key2": "value2"
}
}
]
若要创建使用默认 Application Insights 设置的资源管理器模板，请像创建启用了 Application Insights 的新 Web 应用程序一样开始该过程。
使用所需的 Web 应用信息创建新的应用程序服务资源。 在“监视”选项卡上启用 Application Insights。
选择“查看 + 创建”。 然后，选择“下载自动化模板”。
此选项将生成配置了全部所需设置的最新资源管理器模板。
在以下示例中，将 AppMonitoredSite 的所有实例替换为你的站点名称：
备注
如果使用 Windows，请将 ApplicationInsightsAgent_EXTENSION_VERSION 设置为 ~2。 如果使用 Linux，请将 ApplicationInsightsAgent_EXTENSION_VERSION 设置为 ~3。
{
"resources": [
{
"name": "[parameters('name')]",
"type": "Microsoft.Web/sites",
"properties": {
"siteConfig": {
"appSettings": [
{
"name": "APPINSIGHTS_INSTRUMENTATIONKEY",
"value": "[reference('microsoft.insights/components/AppMonitoredSite', '2015-05-01').InstrumentationKey]"
},
{
"name": "APPLICATIONINSIGHTS_CONNECTION_STRING",
"value": "[reference('microsoft.insights/components/AppMonitoredSite', '2015-05-01').ConnectionString]"
},
{
"name": "ApplicationInsightsAgent_EXTENSION_VERSION",
"value": "~2"
}
]
},
"name": "[parameters('name')]",
"serverFarmId": "[concat('/subscriptions/', parameters('subscriptionId'),'/resourcegroups/', parameters('serverFarmResourceGroup'), '/providers/Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]",
"hostingEnvironment": "[parameters('hostingEnvironment')]"
},
"dependsOn": [
"[concat('Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]",
"microsoft.insights/components/AppMonitoredSite"
],
"apiVersion": "2016-03-01",
"location": "[parameters('location')]"
},
{
"apiVersion": "2016-09-01",
"name": "[parameters('hostingPlanName')]",
"type": "Microsoft.Web/serverfarms",
"location": "[parameters('location')]",
"properties": {
"name": "[parameters('hostingPlanName')]",
"workerSizeId": "[parameters('workerSize')]",
"numberOfWorkers": "1",
"hostingEnvironment": "[parameters('hostingEnvironment')]"
},
"sku": {
"Tier": "[parameters('sku')]",
"Name": "[parameters('skuCode')]"
}
},
{
"apiVersion": "2015-05-01",
"name": "AppMonitoredSite",
"type": "microsoft.insights/components",
"location": "China North 2",
"properties": {
"ApplicationId": "[parameters('name')]",
"Request_Source": "IbizaWebAppExtensionCreate"
}
}
],
"parameters": {
"name": {
"type": "string"
},
"hostingPlanName": {
"type": "string"
},
"hostingEnvironment": {
"type": "string"
},
"location": {
"type": "string"
},
"sku": {
"type": "string"
},
"skuCode": {
"type": "string"
},
"workerSize": {
"type": "string"
},
"serverFarmResourceGroup": {
"type": "string"
},
"subscriptionId": {
"type": "string"
}
},
"$schema": "https://schema.management.azure.com/schemas/2014-04-01-preview/deploymentTemplate.json#",
"contentVersion": "1.0.0.0"
}
若要通过 PowerShell 启用应用程序监视，仅须更改基础的应用程序设置。 以下示例为资源组 AppMonitoredRG 中名为 AppMonitoredSite 的网站启用应用程序监视。 它配置要发送到 012345678-abcd-ef01-2345-6789abcd 检测密钥的数据。
备注
建议使用 Azure Az PowerShell 模块与 Azure 交互。 若要开始，请参阅安装 Azure PowerShell。 若要了解如何迁移到 Az PowerShell 模块，请参阅 将 Azure PowerShell 从 AzureRM 迁移到 Az。
备注
如果使用 Windows，请将 ApplicationInsightsAgent_EXTENSION_VERSION 设置为 ~2。 如果使用 Linux，请将 ApplicationInsightsAgent_EXTENSION_VERSION 设置为 ~3。
$app = Get-AzWebApp -ResourceGroupName "AppMonitoredRG" -Name "AppMonitoredSite" -ErrorAction Stop
$newAppSettings = @{} # case-insensitive hash map
$app.SiteConfig.AppSettings | %{$newAppSettings[$_.Name] = $_.Value} # preserve non Application Insights application settings.
$newAppSettings["APPINSIGHTS_INSTRUMENTATIONKEY"] = "012345678-abcd-ef01-2345-6789abcd"; # set the Application Insights instrumentation key
$newAppSettings["APPLICATIONINSIGHTS_CONNECTION_STRING"] = "InstrumentationKey=012345678-abcd-ef01-2345-6789abcd"; # set the Application Insights connection string
$newAppSettings["ApplicationInsightsAgent_EXTENSION_VERSION"] = "~2"; # enable the ApplicationInsightsAgent
$app = Set-AzWebApp -AppSettings $newAppSettings -ResourceGroupName $app.ResourceGroup -Name $app.Name -ErrorAction Stop
本部分提供常见问题的解答。
详细信息取决于项目类型。 以下列表是 Web 应用程序的示例。
将文件添加到项目：
- ApplicationInsights.config
- ai.js
安装 NuGet 包：
- Application Insights API：核心 API
- 适用于 Web 应用程序的 Application Insights API：用于从服务器发送遥测
- 适用于 JavaScript 应用程序的 Application Insights API：用于从客户端发送遥测
包括包中的程序集：
- Microsoft.ApplicationInsights
- Microsoft.ApplicationInsights.Platform
将项目插入：
- Web.config
- packages.config
在客户端和服务器代码中插入代码片段，以使用 Application Insights 资源 ID 初始化它们。 例如，在 MVC 应用中，代码插入到主页 Views/Shared/_Layout.cshtml 中。 仅对于新项目，可手动将 Application Insights 添加到现有项目。
Application Insights 为向应用程序发出的请求收集遥测数据。 如果在 WebApps/WebServer 中发生故障，并且请求未到达用户应用程序，则 Application Insights 不会有任何有关它的遥测数据。
Application Insights 算出的 serverresponsetime 持续时间不一定与 Web 应用观察到的服务器响应时间匹配。 此行为是因为 Application Insights 仅计算实际到达用户应用程序的持续时间。 如果请求在 WebServer 中停滞或排队，则该等待时间将包含在 Web 应用指标中，但不会包含在 Application Insights 指标中。
Application Insights SDK 和代理发送遥测，将其作为 REST 调用引入到引入终结点。 可以使用原始 REST 客户端通过 PowerShell 或使用 curl 命令，测试从 Web 服务器或应用程序主机计算机到引入服务终结点的连接。 请参阅排查 Azure Monitor Application Insights 中缺失应用程序遥测的问题。
备注
使用 ASP.NET 运行时在应用程序服务中创建 Web 应用时，该应用会部署单个静态 HTML 页面作为入门网站。 建议不要排查默认模板的问题。 在排查问题之前部署应用程序。
检查
ApplicationInsightsAgent_EXTENSION_VERSION应用设置是否设置为值~2。浏览到
https://yoursitename.scm.chinacloudsites.cn/ApplicationInsights。
确认“
Application Insights Extension Status”为“Pre-Installed Site Extension, version 2.8.x.xxxx”且正在运行。如果它未运行，请按照启用 Application Insights 监视的说明进行操作。
确认状态源存在并类似于
Status source D:\home\LogFiles\ApplicationInsights\status\status_RD0003FF0317B6_4248_1.json。如果不存在类似的值，则表示应用程序当前未运行或不受支持。 为确保应用程序运行，请尝试手动访问应用程序 URL/应用程序终结点，以提供运行时信息。
确认
IKeyExists为true。 否则，请将APPINSIGHTS_INSTRUMENTATIONKEY和APPLICATIONINSIGHTS_CONNECTION_STRING与检测密钥 GUID 添加到应用程序设置中。确认
AppAlreadyInstrumented、AppContainsDiagnosticSourceAssembly和AppContainsAspNetTelemetryCorrelationAssembly没有任何对应的条目。如果存在其中的任何条目，请从应用程序中删除以下包：
Microsoft.ApplicationInsights、System.Diagnostics.DiagnosticSource和Microsoft.AspNet.TelemetryCorrelation。
使用 ASP.NET 运行时在应用程序服务中创建 Web 应用时，该应用会部署单个静态 HTML 页面作为入门网站。 该静态网页还会在 IIS 中加载 ASP.NET 托管 Web 部件。 此页允许测试无代码服务器端监视，但不支持自动客户端监视。
如果希望在应用程序服务 Web 应用中测试 ASP.NET 的无代码服务器和客户端监视，建议遵循有关创建 ASP.NET Framework Web 应用的官方指南。 之后，按照当前文章中的说明启用监视。
如果在对内容进行编码的情况下使用 APPINSIGHTS_JAVASCRIPT_ENABLED=true，可能会出现如下所示的错误：
- 500 URL 重写错误。
- 发生 500.53 URL 重写模块错误，并出现消息“对 HTTP 响应的内容进行编码('gzip')时，无法应用出站重写规则。”
发生错误是因为 APPINSIGHTS_JAVASCRIPT_ENABLED 应用程序设置设为 true 且同时存在内容编码。 此方案尚不受支持。 解决方法是从应用程序设置中删除 APPINSIGHTS_JAVASCRIPT_ENABLED。 遗憾的是，如果仍然需要客户端/浏览器端 JavaScript 检测，则需要对网页使用手动 SDK 引用。 按照适用于 JavaScript SDK 的手动检测的说明进行操作。
有关 Application Insights 代理/扩展的最新信息，请参阅发行说明。
不支持 PHP 和 WordPress 站点。 目前没有官方支持的可用于在服务器端监视这些工作负荷的 SDK/代理。 若要在 PHP 或 WordPress 站点上跟踪客户端事务，请使用 JavaScript SDK 将客户端 JavaScript 添加到网页。
下表解释了这些值的含义、其根本原因和建议的修复方法。
| 问题值 | 说明 | Fix |
|---|---|---|
AppAlreadyInstrumented:true |
此值表示扩展已检测到 SDK 的某个功能已在应用程序中存在，因此将会回退。 System.Diagnostics.DiagnosticSource、Microsoft.AspNet.TelemetryCorrelation 或 Microsoft.ApplicationInsights 的引用可能会产生此值。 |
删除引用。 其中某些引用是从特定的 Visual Studio 模板默认添加的。 较旧版本的 Visual Studio 可能会添加对 Microsoft.ApplicationInsights 的引用。 |
AppAlreadyInstrumented:true |
之前部署的应用文件夹中存在前述 DLL 也可能会产生此值。 | 清除应用文件夹，以确保删除这些 DLL。 检查本地应用的 bin 目录和应用程序服务资源上的 wwwroot 目录。 若要检查应用程序服务 Web 应用的 wwwroot 目录，请选择高级工具(Kudu)>调试控制台>CMD>home\site\wwwroot。 |
AppContainsAspNetTelemetryCorrelationAssembly: true |
此值表示扩展已检测到对应用程序中的 Microsoft.AspNet.TelemetryCorrelation 的引用，因此将会回退。 |
删除引用。 |
AppContainsDiagnosticSourceAssembly**:true |
此值表示扩展已检测到对应用程序中的 System.Diagnostics.DiagnosticSource 的引用，因此将会回退。 |
对于 ASP.NET，请删除引用。 |
IKeyExists:false |
此值表示应用设置 APPINSIGHTS_INSTRUMENTATIONKEY 中不存在检测密钥。 原因可能是这些值被意外删除，或者你忘记在自动化脚本中设置这些值。 |
确保该设置在应用程序服务的应用程序设置中存在。 |
2.8.44 版自动检测会将 Application Insights SDK 升级到 2.20.0。 Application Insights SDK 通过 System.Diagnostics.DiagnosticSource.dll 间接引用 System.Runtime.CompilerServices.Unsafe.dll。 如果应用程序具有 System.Runtime.CompilerServices.Unsafe.dll 的绑定重定向，且此库不存在于应用程序文件夹中，则可能会引发 System.IO.FileNotFoundException。
若要解决此问题，请从 web.config 文件中删除 System.Runtime.CompilerServices.Unsafe.dll 的绑定重定向条目。 如果应用程序要使用 System.Runtime.CompilerServices.Unsafe.dll，请设置绑定重定向，如下所示：
<dependentAssembly>
<assemblyIdentity name="System.Runtime.CompilerServices.Unsafe" publicKeyToken="b03f5f7f11d50a3a" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.4.1" newVersion="4.0.4.1" />
</dependentAssembly>
可以将应用设置 ApplicationInsightsAgent_EXTENSION_VERSION 的值设为“2.8.37”，这是一种暂时性解决方法。 此设置会触发应用程序服务使用旧的 Application Insights 扩展。 临时缓解措施只能用于应对临时状况。
