在 Azure 应用服务中为 Tomcat、JBoss 或 Java SE 应用配置 APM 平台

本文介绍如何将部署在 Azure 应用服务上的 Java 应用程序连接到 Azure Monitor Application Insights、New Relic 和 AppDynamics 应用程序性能监视（APM）平台。

Azure 应用服务在完全托管服务上以三种类型运行 Java Web 应用程序：

• Java Standard Edition （SE）。 Java SE 可以运行部署为 Java 存档（JAR）包的应用，其中包含嵌入式服务器，例如 Spring Boot、Quarkus、Dropwizard 或具有嵌入式 Tomcat 或 Jetty 服务器的应用。
• Tomcat。 内置的 Tomcat 服务器可以运行部署为 Web 应用程序存档 （WAR） 包的应用。
• JBoss Enterprise 应用程序平台（EAP）：内置的 JBoss EAP 服务器可以运行部署为 WAR 或企业存档（EAR）包的应用。 在一组定价层（包括免费、高级 v3 和独立 v2）中，Linux 应用支持此选项。

注意

应用服务上的 JBoss EAP 现在支持自带许可证（BYOL）计费。 BYOL 使现有 Red Hat 订阅的客户能够将这些许可证直接应用到 Azure 应用服务上的 JBoss EAP 部署。 有关详细信息，请参阅 JBoss EAP 在应用服务上使用 BYOL 的支持。

配置 Application Insights

Azure Monitor Application Insights 是云原生应用程序监视服务。 它使你能够观察故障、瓶颈和使用模式，以提高应用程序性能并减少平均解决时间（MTTR）。 可以为 Node.js 或 Java 应用启用监视、自动收集日志、指标和分布式跟踪。 使用 Application Insights 无需在应用中手动包含 SDK。 若要详细了解可用于配置代理的应用设置，请查看 Application Insights 文档。

Azure 门户

若要从 Azure 门户启用 Application Insights，请在左侧菜单中选择“ 监视>Application Insights”。 选择 “打开 Application Insights”。

默认情况下，使用与 Web 应用同名的新 Application Insights 资源。 可以选择使用现有的 Application Insights 资源，或更改名称。 选择底部的“应用”。

Azure CLI

若要使用 Azure CLI 启用，需要创建 Application Insights 资源并设置几个应用设置，将 Application Insights 连接到 Web 应用。

1. 启用 Application Insights 扩展。

   az extension add -n application-insights
   

2. 使用下面的 CLI 命令创建 Application Insights 资源。 请将占位符替换为你的资源名称及其所属组。

   az monitor app-insights component create --app <resource-name> -g <resource-group> --location westus2  --kind web --application-type web
   

   记下 connectionString 和 instrumentationKey 的值。 在下一步中需要这些值。

   注意

   要检索其他位置的列表，请运行 az account list-locations。

3. 将检测密钥、连接字符串和监视代理版本作为 Web 应用上的应用设置进行设置。 将 <instrumentationKey> 和 <connectionString> 替换为上一步中的值。

   Linux

   az webapp config appsettings set -n <webapp-name> -g <resource-group> --settings "APPINSIGHTS_INSTRUMENTATIONKEY=<instrumentationKey>" "APPLICATIONINSIGHTS_CONNECTION_STRING=<connectionString>" "ApplicationInsightsAgent_EXTENSION_VERSION=~3" "XDT_MicrosoftApplicationInsights_Mode=default"
   

   Windows操作系统

   az webapp config appsettings set -n <webapp-name> -g <resource-group> --settings "APPINSIGHTS_INSTRUMENTATIONKEY=<instrumentationKey>" "APPLICATIONINSIGHTS_CONNECTION_STRING=<connectionString>" "ApplicationInsightsAgent_EXTENSION_VERSION=~3" "XDT_MicrosoftApplicationInsights_Mode=default" "XDT_MicrosoftApplicationInsights_Java=1"
   

配置 NewRelic

若要配置 New Relic，请执行以下操作：

Linux

注意

最新的 New Relic 文档列出了高达 7.x 的 JBoss EAP 支持。 尚不支持 JBoss EAP 8.x。

1. 在 NewRelic.com 创建新的 Relic 帐户。

2. 从 New Relic 下载 Java 代理。

3. 复制你的许可证密钥，稍后需要用它来配置代理。

4. 通过 SSH 登录到应用服务实例，并创建新目录 /home/site/wwwroot/apm。

5. 将解压缩的 New Relic Java 代理文件上传到 /home/site/wwwroot/apm 下的目录中。 代理的文件应位于 /home/site/wwwroot/apm/newrelic 中。

6. 在 /home/site/wwwroot/apm/newrelic/newrelic.yml 修改 YAML 文件。 将占位符许可证值替换为许可证密钥。

7. 在 Azure 门户中，浏览到你在应用服务中的应用程序并创建一个新的应用程序设置。

   创建一个名为 JAVA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/newrelic/newrelic.jar 的环境变量。

   创建一个名为 CATALINA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/newrelic/newrelic.jar 的环境变量。

Windows操作系统

1. 在 NewRelic.com 创建新的 Relic 帐户。

2. 从 New Relic 下载 Java 代理。 它具有类似于 newrelic-java-x.x.x.zip 的文件名。

3. 复制你的许可证密钥，稍后需要用它来配置代理。

4. 通过 SSH 登录到应用服务实例，并创建新目录 /home/site/wwwroot/apm。

5. 将解压缩的 New Relic Java 代理文件上传到 /home/site/wwwroot/apm 下的目录中。 代理的文件应位于 /home/site/wwwroot/apm/newrelic 中。

6. 在 /home/site/wwwroot/apm/newrelic/newrelic.yml 修改 YAML 文件。 将占位符许可证值替换为许可证密钥。

7. 在 Azure 门户中，浏览到你在应用服务中的应用程序并创建一个新的应用程序设置。

   创建一个名为 JAVA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/newrelic/newrelic.jar 的环境变量。

   创建一个名为 CATALINA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/newrelic/newrelic.jar 的环境变量。

注意

如果你已有 JAVA_OPTS 的环境变量，请将 -javaagent:/... 选项追加到当前值的末尾。

注意

如果你已有 CATALINA_OPTS 的环境变量，请将 -javaagent:/... 选项追加到当前值的末尾。

配置 AppDynamics

配置 AppDynamics：

Linux

1. 在 AppDynamics.com 创建 AppDynamics 帐户。

2. 从 AppDynamics 网站下载 Java 代理。 文件名类似于 AppServerAgent-x.x.x.xxxxx.zip。

3. 通过 SSH 登录到应用服务实例，并创建新目录 /home/site/wwwroot/apm。

4. 将 Java 代理文件上传到 /home/site/wwwroot/apm 下的一个目录中。 代理的文件应位于 /home/site/wwwroot/apm/appdynamics 中。

5. 在 Azure 门户中，浏览到你在应用服务中的应用程序并创建一个新的应用程序设置。

   创建一个名为 JAVA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/appdynamics/javaagent.jar -Dappdynamics.agent.applicationName=<app-name> 的环境变量，其中，<app-name> 是你的应用服务名称。 如果你已有 JAVA_OPTS 的环境变量，请将 -javaagent:/... 选项追加到当前值的末尾。

   创建一个名为 CATALINA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/appdynamics/javaagent.jar -Dappdynamics.agent.applicationName=<app-name> 的环境变量，其中，<app-name> 是你的应用服务名称。 如果你已有 CATALINA_OPTS 的环境变量，请将 -javaagent:/... 选项追加到当前值的末尾。

Windows操作系统

1. 在 AppDynamics.com 创建 AppDynamics 帐户。

2. 从 AppDynamics 网站下载 Java 代理。 文件名类似于 AppServerAgent-x.x.x.xxxxx.zip。

3. 使用 Kudu 控制台创建新目录 /home/site/wwwroot/apm。

4. 将 Java 代理文件上传到 /home/site/wwwroot/apm 下的一个目录中。 代理的文件应位于 /home/site/wwwroot/apm/appdynamics 中。

5. 在 Azure 门户中，浏览到你在应用服务中的应用程序并创建一个新的应用程序设置。

   创建一个名为 JAVA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/appdynamics/javaagent.jar -Dappdynamics.agent.applicationName=<app-name> 的环境变量，其中，<app-name> 是你的应用服务名称。 如果你已有 JAVA_OPTS 的环境变量，请将 -javaagent:/... 选项追加到当前值的末尾。

   创建一个名为 CATALINA_OPTS 且值为 -javaagent:/home/site/wwwroot/apm/appdynamics/javaagent.jar -Dappdynamics.agent.applicationName=<app-name> 的环境变量，其中，<app-name> 是你的应用服务名称。 如果你已有 CATALINA_OPTS 的环境变量，请将 -javaagent:/... 选项追加到当前值的末尾。

配置 Datadog

Linux

配置选项因你的组织使用的 Datadog 站点而异。 请参阅官方的适用于 Azure 的 Datadog 集成文档

Windows操作系统

配置选项因你的组织使用的 Datadog 站点而异。 请参阅官方的适用于 Azure 的 Datadog 集成文档

配置 Dynatrace

Linux

Dynatrace 提供了一个 Azure 原生 Dynatrace 服务。 若要使用 Dynatrace 监控 Azure 应用服务，请参阅 Azure 的 Dynatrace 官方文档。

Windows操作系统

Dynatrace 提供了一个 Azure 原生 Dynatrace 服务。 若要使用 Dynatrace 监控 Azure 应用服务，请参阅 Azure 的 Dynatrace 官方文档。

相关内容

请访问面向 Java 开发人员的 Azure 中心查找 Azure 快速入门、教程和 Java 参考文档。

• 应用服务 Linux 常见问题解答
• 环境变量和应用设置参考