通过 HTTP 进行监控和管理

如果您正在开发 Web 应用程序,Spring Boot Actuator 会自动将所有已启用的端点配置为通过 HTTP 公开。默认约定是使用id前缀为/actuator作为 URL 路径。 例如health公开为/actuator/health.spring-doc.cadn.net.cn

Spring MVC、Spring WebFlux 和 Jersey 原生支持 Actuator。如果 Jersey 和 Spring MVC 都可用,则使用 Spring MVC。
Jackson 是获取 API 文档中记录的正确 JSON 响应所需的依赖项。

自定义管理端点路径

有时,自定义管理终结点的前缀很有用。例如,您的应用程序可能已经使用/actuator用于其他目的。您可以使用management.endpoints.web.base-path属性来更改管理终结点的前缀,如以下示例所示:spring-doc.cadn.net.cn

management.endpoints.web.base-path=/manage
management:
  endpoints:
    web:
      base-path: "/manage"

前面的application.properties示例将端点从/actuator/{id}/manage/{id}(例如,/manage/info).spring-doc.cadn.net.cn

除非管理端口已配置为使用不同的 HTTP 端口公开端点management.endpoints.web.base-path相对于server.servlet.context-path(对于 servlet Web 应用程序)或spring.webflux.base-path(对于响应式 Web 应用程序)。 如果management.server.port已配置,management.endpoints.web.base-path相对于management.server.base-path.

如果要将端点映射到其他路径,可以使用management.endpoints.web.path-mapping财产。spring-doc.cadn.net.cn

以下示例重新映射/actuator/health/healthcheck:spring-doc.cadn.net.cn

management.endpoints.web.base-path=/
management.endpoints.web.path-mapping.health=healthcheck
management:
  endpoints:
    web:
      base-path: "/"
      path-mapping:
        health: "healthcheck"

自定义管理服务器端口

对于基于云的部署,使用默认 HTTP 端口公开管理终结点是明智的选择。但是,如果应用程序在自己的数据中心内运行,则可能更愿意使用其他 HTTP 端口来公开终结点。spring-doc.cadn.net.cn

您可以将management.server.port属性来更改 HTTP 端口,如以下示例所示:spring-doc.cadn.net.cn

management.server.port=8081
management:
  server:
    port: 8081
在 Cloud Foundry 上,默认情况下,应用程序仅在端口 8080 上接收 HTTP 和 TCP 路由的请求。如果要在 Cloud Foundry 上使用自定义管理端口,则需要显式设置应用程序的路由以将流量转发到自定义端口。

配置特定于管理的 SSL

当配置为使用自定义端口时,您还可以使用各种management.server.ssl.*性能。 例如,这样做可以让管理服务器通过 HTTP 可用,而主应用程序使用 HTTPS,如以下属性设置所示:spring-doc.cadn.net.cn

server.port=8443
server.ssl.enabled=true
server.ssl.key-store=classpath:store.jks
server.ssl.key-password=secret
management.server.port=8080
management.server.ssl.enabled=false
server:
  port: 8443
  ssl:
    enabled: true
    key-store: "classpath:store.jks"
    key-password: "secret"
management:
  server:
    port: 8080
    ssl:
      enabled: false

或者,主服务器和管理服务器都可以使用 SSL,但密钥存储不同,如下所示:spring-doc.cadn.net.cn

server.port=8443
server.ssl.enabled=true
server.ssl.key-store=classpath:main.jks
server.ssl.key-password=secret
management.server.port=8080
management.server.ssl.enabled=true
management.server.ssl.key-store=classpath:management.jks
management.server.ssl.key-password=secret
server:
  port: 8443
  ssl:
    enabled: true
    key-store: "classpath:main.jks"
    key-password: "secret"
management:
  server:
    port: 8080
    ssl:
      enabled: true
      key-store: "classpath:management.jks"
      key-password: "secret"

自定义管理服务器地址

您可以通过设置management.server.address财产。 如果您只想在内部或面向作的网络上侦听,或者只想侦听来自localhost.spring-doc.cadn.net.cn

仅当端口与主服务器端口不同时,您才能侦听不同的地址。

以下示例application.properties不允许远程管理连接:spring-doc.cadn.net.cn

management.server.port=8081
management.server.address=127.0.0.1
management:
  server:
    port: 8081
    address: "127.0.0.1"

禁用 HTTP 端点

如果不想通过 HTTP 公开端点,可以将管理端口设置为-1,如以下示例所示:spring-doc.cadn.net.cn

management.server.port=-1
management:
  server:
    port: -1

您也可以使用management.endpoints.web.exposure.exclude属性,如以下示例所示:spring-doc.cadn.net.cn

management.endpoints.web.exposure.exclude=*
management:
  endpoints:
    web:
      exposure:
        exclude: "*"