Azure 应用服务的应用程序监视和 Java

项目
02/04/2024

无需对代码进行任何修改即可监视在 Azure 应用服务上运行的 Java Web 应用程序。本文将逐步讲解如何启用 Azure Monitor Application Insights 监视，并提供有关如何自动完成大规模部署过程的初步指导。

注意

使用 Spring Boot 本机映像应用程序时，请在 Spring Boot 本机映像 Java 应用程序中使用 Azure Monitor OpenTelemetry Distro/ Application Insights 项目，而不是下面所述的 Application Insights Java 代理解决方案。

启用 Application Insights

为在 Azure 应用服务上运行的 Java 应用程序启用应用程序监视的建议方法是使用 Azure 门户。在 Azure 门户中启用应用程序监视会自动使用 Application Insights 来检测应用程序，并且不需要更改任何代码。可以应用额外的配置，然后根据特定情形的需要来添加自己的自定义遥测。

通过 Azure 门户进行自动检测

只需选择一下即可为在 Azure 应用服务中运行的 Java 应用启用监视，而无需更改代码。集成会添加 Application Insights Java 3.x 并自动收集遥测数据。

有关支持的自动检测方案的完整列表，请参阅支持的环境、语言和资源提供程序。

在应用服务的 Azure 控制面板中，选择“Application Insights”，然后选择“启用”。
选择创建新资源，或为此应用程序选择现有 Application Insights 资源。

注意

选择“确定”来创建新资源时，系统将提示你“应用监视设置” 。选择“继续”会将新的 Application Insights 资源链接到你的应用服务，这样做还会触发应用服务的重新启动。
最后这一步是可选的。指定要使用的资源后，可以配置 Java 代理。如果你不配置 Java 代理，将应用默认配置。

完整的配置集可供使用，你只需粘贴有效的 json 文件即可。排除以预览版提供的连接字符串和任何配置 - 在目前以预览版提供的项推出正式版后，你将能够添加这些项。

通过 Azure 门户修改配置后，APPLICATIONINSIGHTS_CONFIGURATION_FILE 环境变量会自动填充并显示在应用服务设置面板中。此变量包含你在 Azure 门户中 Java 应用的配置文本框中粘贴的完整 json 内容。

启用客户端监视

若要针对 Java 应用程序启用客户端监视，需手动将客户端 JavaScript SDK 添加到应用程序。

自动监视

若要为 Application Insights 启用遥测数据收集，只需设置以下应用程序设置：

Screenshot of App Service Application Settings with available Application Insights settings.

应用程序设置定义

应用设置名称	定义	Value
ApplicationInsightsAgent_EXTENSION_VERSION	用于控制运行时监视的主扩展。	在 Windows 中为 `~2`，或者，在 Linux 中为 `~3`。
XDT_MicrosoftApplicationInsights_Java	标记，用于控制是否包含 Java 代理。	0 或 1（只在 Windows 中适用）。

注意

Profiler 和快照调试器不适用于 Java 应用程序

使用 Azure 资源管理器配置应用服务应用程序设置

可以使用 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 配置了应用程序设置的资源管理器模板的示例，可参阅此模板。具体请参阅从第 238 行开始的部分。

自动创建 Application Insights 资源并链接到新建的应用服务资源

若要创建配置了所有默认 Application Insights 设置的资源管理器模板，请像创建启用了 Application Insights 的新 Web 应用程序一样开始该过程。

使用所需的 Web 应用信息创建新的应用服务资源。在“监视”选项卡上启用 Application Insights。
选择“查看 + 创建”。然后，选择“下载自动化模板”。

此选项将生成配置了全部所需设置的最新资源管理器模板。

在以下示例中，将 AppMonitoredSite 的所有实例替换为你的站点名称：

{
    "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 East 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 启用

若要通过 PowerShell 启用应用程序监视，仅须更改基础的应用程序设置。以下示例为资源组 AppMonitoredRG 中名为 AppMonitoredSite 的网站启用应用程序监视。它配置要发送到 012345678-abcd-ef01-2345-6789abcd 检测密钥的数据。

注意

建议使用 Azure Az PowerShell 模块与 Azure 交互。请参阅安装 Azure PowerShell 以开始使用。若要了解如何迁移到 Az PowerShell 模块，请参阅将 Azure PowerShell 从 AzureRM 迁移到 Az。

$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

故障排除

使用我们的分步指南对在 Azure 应用服务上运行的基于 Java 的应用程序进行故障排除。

检查 ApplicationInsightsAgent_EXTENSION_VERSION 应用设置是否设置为“~2”（在 Windows 上）或“~3”（在 Linux 上）
检查日志文件以确定代理是否已成功启动：浏览到 `https://yoursitename.scm.chinacloudsites.cn/ ，通过 SSH 切换到根目录，日志文件位于 LogFiles/ApplicationInsights 下。
为 Java 应用启用应用程序监视后，可以通过查看实时指标来验证代理是否正常工作 - 即使是在将应用部署到应用服务之前，你也会看到来自环境的一些请求。请记住，只有当你的应用已部署并正在运行时，才能使用完整的遥测数据集。
如果未看到任何错误并且没有遥测数据，请将 APPLICATIONINSIGHTS_SELF_DIAGNOSTICS_LEVEL 环境变量设置为“debug”

Application Insights 中的标准指标与 Azure 应用服务指标之间有何区别？

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 中缺失应用程序遥测的问题。

手动部署最新的 Application Insights Java 版本

Application Insights Java 版本会在应用服务更新过程中自动更新。

如果遇到已在最新版本的 Application Insights Java 中修复的问题，可以手动更新它。

若要手动进行更新，请执行以下步骤：

将 Java 代理 jar 文件上传到应用服务

a. 首先，按照此处的说明获取最新版本的 Azure CLI。

b. 接下来，按照此处的说明获取最新版本的 Application Insights Java 代理。

c. 然后，使用以下命令将 Java 代理 jar 文件部署到应用服务：az webapp deploy --src-path applicationinsights-agent-{VERSION_NUMBER}.jar --target-path java/applicationinsights-agent-{VERSION_NUMBER}.jar --type static --resource-group {YOUR_RESOURCE_GROUP} --name {YOUR_APP_SVC_NAME}。或者，可以使用本指南通过 Maven 插件部署代理。
通过 Azure 门户中的 Application Insights 选项卡禁用 Application Insights。
上传代理 jar 文件后，转到应用服务配置。如果需要使用适用于 Linux 的启动命令，请包含 jvm 参数：

启动命令不支持对 JavaSE 使用 JAVA_OPTS，也不支持对 Tomcat 使用 CATALINA_OPTS。

如果不使用启动命令，请为 JavaSE 创建具有值 -javaagent:{PATH_TO_THE_AGENT_JAR}/applicationinsights-agent-{VERSION_NUMBER}.jar 的新环境变量 JAVA_OPTS，为 Tomcat 创建具有此值的新环境变量 CATALINA_OPTS。
重启应用以应用更改。

注意

如果对 JavaSE 设置 JAVA_OPTS 环境变量或对 Tomcat 设置 CATALINA_OPTS 环境变量，必须在门户中禁用 Application Insights。或者，如果你想要从门户启用 Application Insights，请确保不要在应用服务配置设置中为 JavaSE 设置 JAVA_OPTS 变量或为 Tomcat 设置 CATALINA_OPTS 变量。

发行说明

有关最新的更新和 bug 修复，请参阅发行说明。

后续步骤

使用 Application Insights 监视 Azure Functions。
将 Azure 诊断配置为向 Application Insights 发送数据。
监视服务运行状况指标以确保服务可用且做出快速响应。
接收警报通知。
若要从访问网页的浏览器获取客户端遥测数据，请使用适用于 JavaScript 应用和网页的 Application Insights。
可用性概述