使用 Spring Boot Actuator 管理和监视应用

注意

Azure Spring Apps 是 Azure Spring Cloud 服务的新名称。 虽然该服务有新名称,但一些地方仍会使用旧名称,我们仍在更新屏幕截图、视频和图形等资产。

在将新的二进制文件部署到应用后,可能需要检查功能并查看有关正在运行的应用程序的信息。 本文介绍了如何从 Azure Spring Apps 提供的测试终结点访问 API,并公开了用于应用的生产就绪功能。

先决条件

本文假定你有一个可以在 Azure Spring Apps 服务上成功部署和启动的 Spring Boot 2.x 应用程序。 请参阅快速入门:使用 Azure 门户启动 Azure Spring Apps 中的现有应用程序

通过测试终结点验证应用

  1. 转到“应用程序仪表板”并选择你的应用以进入应用概述页。

  2. 在“概述”窗格中,应该会看到“测试终结点” 。 从命令行或浏览器访问此终结点,并观察 API 响应。

  3. 请记录将会在后面部分中用到的测试终结点 URI。

提示

  • 如果该应用返回前端页并通过相对路径引用其他文件,请确认你的测试终结点是以斜杠 (/) 结尾的。 这将确保正确加载 CSS 文件。
  • 如果你从浏览器中查看 API,并且你的浏览器要求你在查看该页之前输入登录凭据,请使用 URL 解码对测试终结点进行解码。 URL 解码将返回具有“https://username:password@cluster-name.test.microservices.azure.cn/app-name/deployment-name”格式的 URL。<><><><><> 请使用这种格式来访问终结点。

添加执行器依赖项

若要将执行器添加到基于 Maven 的项目,请添加“Starter”依赖项:

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

请编译这个新的二进制文件并将它部署到你的应用。

启用生产就绪功能

利用执行器终结点,可以监视应用程序并与之进行交互。 默认情况下,Spring Boot 应用程序公开 healthinfo 终结点,以显示任意应用程序信息和运行状况信息。

若要观察配置以及可配置的环境,还需要启用 envconfiggrops 终结点。

  1. 转到应用“概述”窗格,选择“设置”菜单中的“配置”,转到“环境变量”配置页 。

  2. 采用类似于“key:value”的形式添加以下属性。 此环境将打开 Spring Actuator 终结点“health”。

    management.endpoints.web.exposure.include: health
    
  3. 选择“保存”按钮,应用程序将自动重启并加载新环境变量。

现在可以返回到应用概述窗格,并等待“预配状态”更改为“成功”。 运行的实例将会有多个。

注意

在将应用公开后,这些执行器终结点也会公开。 可通过删除环境变量 management.endpoints.web.exposure.include 来隐藏所有的终结点,并设置 management.endpoints.web.exposure.exclude=*

通过查看执行器终结点来查看应用程序信息

  1. 你现在可以访问 URL "<test-endpoint>/actuator/" 来查看 Spring Boot Actuator 公开的所有终结点。
  2. 访问 URL "<test-endpoint>/actuator/env",可以看到应用使用的活动配置文件,以及所有加载的环境变量。
  3. 如果需要搜索某个特定环境,可访问 URL "<test-endpoint>/actuator/env/{toMatch}" 来查看该环境。

若要查看所有内置的终结点,请参阅公开终结点

后续步骤