Actuator

官网地址：
https://docs.spring.io/spring-boot/docs/2.5.6/reference/html/actuator.html

目的

• 监控并管理应用程序

访问方式

• HTTP
• JMX Java Management Extensions(Java管理扩展)的缩写

依赖

• spring-boot-starter-actuator

一些常用 Endpoint

如何访问 Actuator Endpoint

HTTP 访问

• /actuator/

端口与路径

• management.server.address=
• management.server.port=
• management.endpoints.web.base-path=/actuator
• management.endpoints.web.path-mapping.=路径

开启 Endpoint

• management.endpoint..enabled=true
• management.endpoints.enabled-by-default=false

暴露 Endpoint

• management.endpoints.jmx.exposure.exclude=
• management.endpoints.jmx.exposure.include=*
• management.endpoints.web.exposure.exclude=
• management.endpoints.web.exposure.include=info, health

完整版Endpoint

官网地址：
https://docs.spring.io/spring-boot/docs/2.5.6/reference/html/actuator.html#actuator.endpoints

Actuator endpoints允许您监视应用程序并与之交互。Spring Boot包括许多内置endpoints，并允许您添加自己的endpoints。例如，health endpoint提供基本应用程序health信息。

可以通过HTTP或JMX启用或禁用每个endpoint并公开(使其远程访问)。当一个endpoint同时启用和公开时，它就被认为是可用的。内置endpoint只有在可用时才会自动配置。大多数应用程序选择通过HTTP进行公开，其中endpoint的ID加上/actuator前缀被映射到一个URL。例如，默认情况下，health endpoint映射到/actuator/health。

要了解更多关于Actuator’s endpoints及其请求和响应格式的信息，可参考单独的API文档(HTML or PDF)。

如果你的应用程序是一个web应用程序(Spring MVC, Spring WebFlux，或Jersey)，你可以使用以下附加endPoints:

启用 EndPoints

缺省情况下，除shutdown外的所有endpoints都是启用的。通过配置可启用endpoint，使用它的management.endpoint.<id>.enabled属性。下面的例子启用了shutdown endpoint:

management.endpoint.shutdown.enabled=true

如果您更喜欢选择加入endpoint而不是选择退出endpoint，可将
management.endpoints.enabled-by-default属性设置为false，再将单个endpoint启用的属性设置为true。下面的示例启用info endpoint并禁用所有其他endpoints:

management.endpoints.enabled-by-default=false
management.endpoint.info.enabled=true

这会从应用程序上下文中完全删除禁用的endpoint。如果您只想更改暴露endpoint的技术，请使用include和exclude属性。

暴露 EndPoints

由于endpoints可能包含敏感信息，应仔细考虑何时公开它们。下表显示了内置endpoints的默认公开。

要更改公开的endpoints，请使用以下特定于技术的include和exclude属性:

include属性列出了公开的endpoints的id。exclude属性列出不应公开的endpoints的id。exclude属性优先于include属性。包含和排除属性都可以使用endpoint id列表进行配置。

例如，要停止通过JMX公开所有endpoints，而只公开health and info endpoints，可使用以下属性:

management.endpoints.jmx.exposure.include=health,info

*可以用来选择所有endpoints。例如，要通过HTTP公开除env和beans endpoints外的所有内容，请使用以下属性:

management.endpoints.web.exposure.include=*
management.endpoints.web.exposure.exclude=env,beans

*在YAML中有特殊含义，所以如果您想包含(或排除)所有endpoints，请务必添加引号。

如果您的应用程序是公开的，我们强烈建议您也保护您的endpoints。

如果您想在endpoints暴露时实现自己的策略，可以注册一个EndpointFilter bean