spring boot actuator部分配置属性说明

针对前篇文章《Spring Boot Actuator监控端点小结》中没有介绍的配置属性说明,我在这里做部分的说明

1. endpoints.shutdown.enabled

在原生端点中,只提供了一个用来关闭应用的端点:/shutdown。我们可以通过如下配置开启它:

endpoints.shutdown.enabled=true

在配置了上述属性之后,只需要访问该应用的/shutdown端点就能实现关闭该应用的远程操作。由于开放关闭应用的操作本身是一件非常危险的事,所以真正在线上使用的时候,我们需要对其加入一定的保护机制,比如:定制Actuator的端点路径、整合Spring Security进行安全校验等。

2.endpoints.enabled

该配置属性用于控制所有的访问原生端点的可用性,设置为false的时候所有的原生端点都不可以访问,设置为true时所有的原生端点可以访问。默认为true。

3.endpoints.{name}.enabled

该配置属性是相对endpoints.enabled来说的,endpoints.enabled是将所有的原生端点的禁止访问,而enedpoints.{name}.enabled属性是针对某个具体的原生端点进行控制,设置为true时该原生端点可以访问,设置为false的时候不可访问,默认为true。

4.endpoints.sensitive

该配置属性用于配置敏感信息,即是否需要授权的操作,如果设置为true,则所有的原生端点都需要授权操作,设置为false则不需要,默认是false,这里需要注意的是如果没有主动设置该值的话,有些原生端点是需要授权才能访问的,如/beans,/env等,当与management.security.enabled一起使用时以management.security.enabled为主。

5.endpoints.{name}.sensitive

该配置属性是相对endpoints.sensitive来说的,endpoints.sensitive是将所有的原生端点进行授权操作,而endpoints.{name}.sensitive是对某个具体的原生端点进行控制,设置为true时该原生端点需要授权操作,设置为false的时候不需要授权访问,具体的默认值需要看具体的原生端点。

6.endpoints.hypermedia.enabled

该配置属性需要在配合使用spring hateoas时才有作用,比如通过使用spring-boot-starter-hateoas或者spring data rest,默认值为false。该原生端点/actuator将返回所有的原生端点的链接,这个地方设置成true或false都能出结果,不知道是否有什么地方没有理解到。

7.endpoints.{name}.path

该配置属性用来修改原生端点的默认路径,需要配合endpoints.{name}.enabled来使用,该属性设置后原来的原生端点路径不再起作用。

8.endpoints.{name}.enabled

该配置属性用于表示修改了path路径后是否起作用,需要配合endpoints.{name}.path来使用,默认值是true,如果设置为false,修改的路径不起作用,并且原来的原生端点也不能使用。

扫描二维码关注公众号,回复: 311387 查看本文章

9.endpoints.cors.allowed-origins

该配置属性用于定义跨域资源共享的授权访问,可以定义多个路径,默认的没有进行配置。

10.endpoints.cors.allowed-methods

该配置属性用于定义可以跨域资源共享访问的方法,如GET,POST等,可以同时定义多个方法。

11.endpoints.health.time-to-live

该配置属性用于设置原生端点/health获取的数据的缓存间隔,默认值为1000ms。

12.management.health.defaults.enabled

该配置属性用于设置HealthIndicator的所有实现类是否可用,这些实现类用于返回其对应的检查属性的health信息,默认值为true。

 

13.management.health.{name}.enabled

该配置属性用于设置某个具体的HealthIndicator的实现类是否可用,默认值为true。

14.management.health.status.order

该配置属性用于设置health状态的顺序,比如在你的实现类中新增了一个FATAL状态,这个时候就可以在配置文件中设置状态顺序为management.health.status.order=FATAL,DOWN,OUT_OF_SERVICE,UP。

15.endpoints.health.mapping.{name}

该配置属性用于指定management.health.status.order中状态的对应HttpStatus.java类中对应的状态,如endpoints.health.mapping.FATAL=503。

16.info.*

该配置属性用于设置原生端点/info的信息,可以通过该路径获取配置后的信息。

17.management.info.git.enabled

该配置属性用于设置是否可以获取git信息,前提条件是配置了git.properties文件或注入了GitProperties的bean。

18.management.info.git.mode

该配置属性用于获取git信息,该信息包含了git.branch,git.commit.id,git.commit.time等信息,属性值有full和simple2种。

19. management.security.enabled

该配置属性用于设置是否需要授权才能访问,默认是true,与endpoints.sensitive一起使用是以前者为主。

20.management.context-path

该配置属性用于修改原生端点的访问路径,比如原生端点/info,在设置management.context-path=/come后,如果还是访问/info就不能起作用了,需要访问/come/info才能正确访问。

21.endpoints.{name}.id

该配置属性用于修改原生端点的访问路径,比如endpoints.info.id=info1,如果还是访问/info就不能起作用了,需要访问/info1才能正确访问。

22.management.port

该配置属性只用于修改endpoint的访问端口号,如果不想使用endpoints,可以将端口号设置为-1。

23.management.address

该配置属性用于修改监控的特定ip地址上的信息。

24.endpoints.jmx.domain

该配置属性用于定义JMX的域名。

25.endpoints.jmx.unique-name

该配置属性用于设置MBean的名字是否唯一,默认为false。

26.endpoints.jmx.enabled

 

该配置属性用于设置是否启用jmx,默认为true。

猜你喜欢

转载自357029540.iteye.com/blog/2392530