`
357029540
  • 浏览: 737166 次
  • 性别: Icon_minigender_1
  • 来自: 重庆
社区版块
存档分类
最新评论

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,修改的路径不起作用,并且原来的原生端点也不能使用。

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。

0
0
分享到:
评论

相关推荐

    Spring Boot Actuator执行器运行原理详解

    在本文中,我们将详细介绍 Spring Boot Actuator 执行器的运行原理,并通过示例代码对其进行说明,以便大家更好地理解和使用它。 一、启用 Spring Boot Actuator 要启用 Spring Boot Actuator,需要在构建配置文件...

    spring-boot-actuator-web-api.pdf

    Spring Boot Actuator是一个为Spring Boot应用程序提供生产级别的功能监控和管理的工具。它提供了一系列API端点,允许我们深入应用程序的内部工作情况,如度量收集、应用健康状况、审计事件、环境信息、Bean信息等。...

    SpringBoot2.0-Actuator监控参数说明 - 最全文档.docx

    ### Spring Boot 2.0 Actuator 监控参数说明 #### 一、Spring Boot 2.0 Actuator 概述 在Spring Boot 2.0中,Actuator模块提供了丰富的健康检查、审计、指标监控等功能,它使得开发人员能够轻松地获取到应用程序的...

    Spring Boot Actuator端点相关原理解析

    * /configprops:描述配置属性(包含默认值)如何注入 Bean * /beans:描述应用程序上下文里全部的 Bean,以及它们的关系 度量端点: * /metrics:报告各种应用程序度量信息,比如内存用量和 HTTP 请求计数 * /...

    spring-boot-2.7.0.zip源码

    5. **Actuator模块**:Spring Boot Actuator提供了丰富的监控和管理端点,帮助开发者了解应用的健康状况、日志、指标等。源码中,这些端点由`Endpoint`接口定义,可以通过HTTP、JMX等方式访问。 6. **条件注解**:...

    第 5-2 课:使⽤ Spring Boot Actuator 监控应⽤1

    Spring Boot Actuator 是一个强大的工具,它为Spring Boot应用程序提供了丰富的监控和管理功能。这个组件允许开发者深入了解应用程序的运行状态,包括内部配置、性能指标、健康检查等关键信息。通过集成Actuator,...

    Spring Boot in Action 英文版

    此外,Spring Boot还允许开发者在运行时覆盖应用的配置属性,这种设计允许开发者在不同的环境(如开发环境和生产环境)中部署相同的应用,而无需修改应用代码。 Spring Boot的初始化可以使用Spring Initializr进行...

    Spring-Boot-Reference-Guide, Spring Boot Reference Guide中文翻译 -《Spring Boot参考指南》.zip

    1. 属性注入:使用@Value注解将配置属性值注入到字段或方法参数中。 2. Profile:通过spring.profiles.active属性切换不同环境的配置。 3. YAML与Properties:YAML提供更友好的格式,但两者可互相转换。 三、Spring...

    《Spring Boot企业级开发教程》配套资料

    这通常包括Spring Boot的基础概念,如起步依赖、配置属性、Spring Boot的Starter POMs,再到高级主题,如微服务架构、云原生应用、Docker容器化等。大纲有助于学习者规划学习进度,确保全面掌握每个知识点。 课后题...

    Spring Boot环境配置

    - **`application.properties`**: 这是Spring Boot默认的配置文件,用于存储应用程序的各种配置属性。例如,数据库连接信息、服务器端口、日志级别等都可以在这里设置。 - **属性引用**: 在配置文件中,我们可以...

    spring-boot-中文参考手册

    Spring Boot支持多种方式的外部配置,包括属性文件(application.properties或application.yml)、环境变量、命令行参数等,方便在不同环境中调整应用配置。 ### 七、Spring Boot Actuator与监控 Actuator提供了...

    详解spring-boot actuator(监控)配置和使用

    Spring Boot Actuator 配置和使用详解 Spring Boot Actuator 是 Spring Boot 框架中的一组组件,提供了一系列的监控和管理接口,帮助开发者快速构建可靠的生产环境。下面我们将详细介绍 Spring Boot Actuator 的...

    spring boot admin demo 源码 java 服务器 监控

    3. **集成步骤**:在你的 Spring Boot 项目中集成 Spring Boot Admin,你需要在 `pom.xml` 文件中添加依赖,然后配置服务器和客户端的属性。客户端需要配置服务发现(例如使用 Eureka 或 Consul),以便服务器能发现...

    spring boot 小实例

    5. **配置管理**:探讨 `application.properties` 或 `application.yml` 文件,了解如何管理和加载配置属性。 6. **Actuator**:Spring Boot Actuator 提供了一组端点,用于监控和管理应用程序,如健康检查、指标...

    Spring Boot 学习笔记完整教程.pdf

    - 自定义属性和配置文件:Spring Boot允许开发者定义自定义的属性文件,并通过@Value注解或Environment对象来加载这些属性。 - 系统启动任务:Spring Boot提供了CommandLineRunner接口,允许开发者在应用启动时执行...

    Spring Boot核心技术 - 笔记.rar

    Spring Boot的核心特性包括自动配置、起步依赖、内嵌Web服务器以及运行时健康检查等。这篇笔记将深入探讨这些关键知识点。 **一、自动配置** Spring Boot的自动配置是其核心功能之一,它允许开发者通过“约定优于...

    Spring Boot Actuator监控器配置及使用解析

    | GET | /configprops | 描述配置属性(包含默认值)如何注入Bean | | GET | /beans | 描述应用程序上下文里全部的Bean,以及它们的关系 | | GET | /dump | 获取线程活动的快照 | | GET | /env | 获取全部环境属性 |...

    spring-boot源码

    6. **环境与配置**:Spring Boot支持命令行参数、属性文件、系统属性、JNDI、YAML等多种方式来加载和管理配置。`Environment`对象包含了所有的配置信息,可以通过`@Value`注解注入到bean中。 7. **条件化bean**:`@...

    Spring Boot Cookbook(2015.09)源码

    6. **4658_06_Code**:可能涉及Spring Boot的外部配置,比如通过application.properties或YAML文件来管理配置,以及如何使用`@Value`注解注入配置属性。 7. **4658_07_Code**:可能讲解了Spring Boot的应用部署,...

    Spring Boot核心技术-笔记-pdf版.pdf

    同时,Spring Boot还提供了强大的配置绑定功能,可以将配置文件中的属性直接注入到Java对象中。 6. **Spring Boot CLI(命令行工具)** Spring Boot提供了命令行接口(CLI),使得开发者可以通过命令行快速创建、...

Global site tag (gtag.js) - Google Analytics