你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

如何使用 Elastic APM Java 代理监视 Spring Boot 应用

项目
10/01/2024

注意

从 2025 年 3 月中旬开始，基本、标准和企业计划将弃用，停用期为三年。建议过渡到 Azure 容器应用。有关详细信息，请参阅 Azure Spring Apps 停用公告。

从 2024 年 9 月 30 日开始，标准消耗和专用计划将弃用，六个月后将完全关闭。建议过渡到 Azure 容器应用。有关详细信息，请参阅将 Azure Spring Apps 标准消耗和专用计划迁移到 Azure 容器应用。

本文适用于：✔️ 基本/标准层 ❌ Enterprise 层

本文将介绍如何使用 Elastic APM 代理监视在 Azure Spring Apps 中运行的 Spring Boot 应用程序。

使用 Elastic Observability 解决方案，可以实现统一的可观测性，从而实现以下目的：

使用 Elastic APM Java 代理并将持久性存储与 Azure Spring Apps 配合使用来监视应用。
使用诊断设置将 Azure Spring Apps 日志发送到 Elastic。有关详细信息，请参阅使用诊断设置通过 Elastic (ELK) 分析日志。

以下视频介绍如何使用 Elastic 为 Spring Boot 应用程序实现统一的可观测性。

先决条件

部署 Spring Petclinic 应用程序

本文使用 Spring Petclinic 示例来演练所需的步骤。使用以下步骤部署示例应用程序：

按照使用 Azure Spring Apps 和 MySQL 部署 Spring Boot 应用中的步骤操作，直到到达部署 Spring Boot 应用程序并设置环境变量部分。

通过以下命令使用用于 Azure CLI 的 Azure Spring Apps 扩展，以创建要在 Azure Spring Apps 中运行的应用程序：

az spring app create \
   --resource-group <your-resource-group-name> \
   --service <your-Azure-Spring-Apps-instance-name> \
   --name <your-app-name> \
   --is-public true

为 Azure Spring Apps 启用自定义持久性存储

使用以下步骤启用自定义持久性存储：

按照如何在 Azure Spring Apps 中启用自己的持久性存储中的步骤操作。

使用以下 Azure CLI 命令为 Azure Spring Apps 应用添加持久性存储。

az spring app append-persistent-storage \
   --resource-group <your-resource-group-name> \
   --service <your-Azure-Spring-Apps-instance-name> \
   --name <your-app-name> \
   --persistent-storage-type AzureFileVolume \
   --share-name <your-Azure-file-share-name> \
   --mount-path <unique-mount-path> \
   --storage-name <your-mounted-storage-name>

激活 Elastic APM Java 代理

在继续操作之前，需要准备好 Elastic APM 服务器连接信息（已假设你在 Azure 上部署了 Elastic）。有关详细信息，请参阅如何部署和管理 Microsoft Azure 上的 Elastic。若要获取此信息，请执行以下步骤：

在Azure 门户中，转到 Elastic 部署的“概述”页，然后选择“管理 Elastic Cloud 部署”。
在 Elastic Cloud 控制台上的你的部署下，选择“APM & Fleet”部分，以获取 Elastic APM 服务器终结点和机密令牌。
从 Maven Central 下载 Elastic APM Java 代理。
将 Elastic APM 代理上传到之前启用的自定义持久性存储。转到“Azure 文件共享”并选择“上传”以添加代理 JAR 文件。

获得 Elastic APM 终结点和机密令牌后，请在部署应用程序时使用以下命令激活 Elastic APM Java 代理。占位符 <agent-location> 表示 Elastic APM Java 代理的装载存储位置。

az spring app deploy \
    --name <your-app-name> \
    --artifact-path <unique-path-to-your-app-jar-on-custom-storage> \
    --jvm-options='-javaagent:<elastic-agent-location>' \
    --env ELASTIC_APM_SERVICE_NAME=<your-app-name> \
          ELASTIC_APM_APPLICATION_PACKAGES='<your-app-package-name>' \
          ELASTIC_APM_SERVER_URL='<your-Elastic-APM-server-URL>' \
          ELASTIC_APM_SECRET_TOKEN='<your-Elastic-APM-secret-token>'

自动预配

还可以使用 Terraform、Bicep 或 Azure 资源管理器模板（ARM 模板）运行预配自动化管道。此管道可以提供完整的无干预体验，用于检测和监视你创建和部署的任何新应用程序。

使用 Terraform 自动预配

若要在 Terraform 模板中配置环境变量，请将以下代码添加到模板中，并将“<...>”占位符替换为自己的值。有关详细信息，请参阅管理活动的 Azure Spring Apps 部署。

resource "azurerm_spring_cloud_java_deployment" "example" {
  ...
  jvm_options = "-javaagent:<elastic-agent-location>"
  ...
    environment_variables = {
      "ELASTIC_APM_SERVICE_NAME"="<your-app-name>",
      "ELASTIC_APM_APPLICATION_PACKAGES"="<your-app-package>",
      "ELASTIC_APM_SERVER_URL"="<your-Elastic-APM-server-URL>",
      "ELASTIC_APM_SECRET_TOKEN"="<your-Elastic-APM-secret-token>"
  }
}

使用 Bicep 文件自动完成预配

若要在 Bicep 文件中配置环境变量，请将以下代码添加到该文件，并将 <...> 占位符替换为你自己的值。有关详细信息，请参阅 Microsoft.AppPlatform Spring/apps/deployments。

deploymentSettings: {
  environmentVariables: {
    ELASTIC_APM_SERVICE_NAME='<your-app-name>',
    ELASTIC_APM_APPLICATION_PACKAGES='<your-app-package>',
    ELASTIC_APM_SERVER_URL='<your-Elastic-APM-server-URL>',
    ELASTIC_APM_SECRET_TOKEN='<your-Elastic-APM-secret-token>'
  },
  jvmOptions: '-javaagent:<elastic-agent-location>',
  ...
}

使用 ARM 模板自动预配

若要在 ARM 模板中配置环境变量，请将以下代码添加到模板中，并将“<...>”占位符替换为自己的值。有关详细信息，请参阅 Microsoft.AppPlatform Spring/apps/deployments。

"deploymentSettings": {
  "environmentVariables": {
    "ELASTIC_APM_SERVICE_NAME"="<your-app-name>",
    "ELASTIC_APM_APPLICATION_PACKAGES"="<your-app-package>",
    "ELASTIC_APM_SERVER_URL"="<your-Elastic-APM-server-URL>",
    "ELASTIC_APM_SECRET_TOKEN"="<your-Elastic-APM-secret-token>"
  },
  "jvmOptions": "-javaagent:<elastic-agent-location>",
  ...
}

升级 Elastic APM Java 代理

若要规划升级，请参阅升级版本（适用于 Azure 上的 Elastic Cloud）以及重大更改（适用于 APM）。升级 APM 服务器后，将 Elastic APM Java 代理 JAR 文件上传到自定义永久性存储中。然后，使用更新后的 JVM 选项重启应用，该选项指向升级后的 Elastic APM Java 代理 JAR。