Spring-boot-admin配置属性详解

Spring 专栏收录该内容
3 篇文章 0 订阅

使用到了springbootAdmin这个工具,但是有关它们的配置不太理解。下面是我对照着官网的说明以及自己的理解总结的,如果有不正确的地方欢迎大家指正。(我这里只是在springboot中使用了SBA,还没有涉及到其它更加高级的spring cloud等。这里的属性也只是最简单的一些配置属性)

springbootAdmin—client端配置属性详解:

spring.boot.admin.client.enabled:是否启用springbootAdmin客户端,默认为true;

spring.boot.admin.client.url:要注册的server端的url地址。如果要同时在多个server端口注册,则用逗号分隔各个server端的url地址;

spring.boot.admin.client.api-path:默认值是instances。server端获取client信息的路径,默认情况下server通过访问/instances请求来获取到client端的信息。(client端向server端注册,注册成功后server端会给该client创建一个唯一的clientID值。当server端需要获取client的信息,比如health信息时,server端会发送http://111.11.11.1:8080/instances/clientID/actuator/health即可,这里的http://111.11.11.1:8080是client所在服务器的IP地址,instances就是该属性的值)

spring.boot.admin.client.username:如果server端需要进行认证时,该属性用于配置用户名。


spring.boot.admin.client.password:如果server端需要进行认证时,该属性用于配置密码。

spring.boot.admin.client.period:注册时间间隔,单位是毫秒;默认值是10秒钟注册一次。(client通过持续不断地向server端进行注册来保持client端与server端的连接)

spring.boot.admin.client.connect-timeout:注册连接超时时间,单位是毫秒,默认值是5秒。当client向server进行注册时,如果5秒钟没有注册完成则认为本次注册失败;

spring.boot.admin.client.read-timeout:注册读取超时,单位是毫秒,默认值是5秒;

spring.boot.admin.client.auto-registration:是否开启自动注册,默认值是true。

spring.boot.admin.client.auto-deregistration:是否开启自动注销,默认值是null。如果服务端运行在云平台,默认值是true;

spring.boot.admin.client.register-once:默认值为true。如果值为true的话,client只会在一个server端进行注册(按照spring.boot.admin.client.url中设置的server的顺序)。如果该server端宕机,会自动在下一个server端进行注册。如果该属性值为false,则会在所有的server端进行注册;

spring.boot.admin.client.instance.management-url:注册的management-url,如果可用的url不同的话可以重写该值。如果不配置该属性的话,默认该属性值与management-base-url 和 management.context-path两个属性值有关。比如工程中该值为:

managementUrl=http://192.168.200.165:8080/actuator,其中http://192.168.200.165:8080为management-base-url,/actuator是management.context-path(该属性值是spring actuator的属性值);

spring.boot.admin.client.instance.management-base-url:用于计算management-url 的基本URL。该路径值在运行时进行获取并赋值给 base url。如果不配置该属性值的话,默认该属性值与management.port, service-url 以及server.servlet-path有关。比如工程中该值为http://192.168.200.165:8080,其中8080端口是配置的获取actuator信息的端口。192.168.200.165是设置的service-url值,如果没有设置service-url的话,则为配置的server.servlet-path值(项目的启动路径)。

spring.boot.admin.client.instance.health-url:注册的health-url地址,如果可用的url不同可以重写该值。如果不配置该属性的话,默认该属性值与management-url 以及endpoints.health.id有关。比如工程中该值为:healthUrl=http://192.168.200.165:8080/actuator/health,其中http://192.168.200.165:8080/actuator是management-url,health是endpoints.health.id。

spring.boot.admin.client.instance.service-base-url:用于计算service-url 的基本URL。该路径值在运行时进行获取并赋值给 base url。如果不配置该属性值的话,默认该属性值与hostname, server.port有关。比如工程中该值为http://p-v-9:8080,其中8080端口是配置的server.port。p-v-9是client所在服务器的hostname。

spring.boot.admin.client.instance.service-url:注册的service-url值。如果不配置该属性值的话,基于 service-base-url 和 server.context-path进行赋值。比如工程中为http://p-v-9:8080/,其中p-v-9是base-url,/是工程配置的 server.context-path值。(这里要注意的是,当server端与client端不在同一台服务器上的时候,要配置该属性的值。如果不配置的话,server端就会根据默认的命名规则来配置该值,比如http://p-v-9:8080/,如果server使用这个值来获取client的各种性能信息的话是获取不到的);

spring.boot.admin.client.instance.name:客户端工程的名字。默认值是配置的spring.application.name的值,如果没有配置该属性的话,默认值是spring-boot-application;

spring.boot.admin.client.instance.prefer-ip:是否使用注册的ip地址来取代上述各个url中hostname的值,默认值是false(也就是说默认情况下上述各个url中会使用hostname的值,比如我的电脑的hostname为p-v-9)。如果设置了server.address或者management.address的话ip地址就是该值,如果没有设置这两个属性的话ip地址值是InetAddress.getLocalHost()的值。

spring.boot.admin.client.instance.metadata.*:与该应用有关的元数据,以键值对的形式赋值。

 

springbootAdmin—server端配置属性详解:

spring.boot.admin.context-path:server端的访问路径,默认是/。默认情况下server的访问地址是http://**.**.**.**:**/,这里**.**.**.**:**是server所在服务器的ip地址。我们的工程设置该值是springbootAdmin,那么工程的server端访问地址是http://111.11.11.1:8000/springbootAdmin;

spring.boot.admin.monitor.period:更新client端状态的时间间隔,单位是毫秒,默认值是10秒钟;

spring.boot.admin.monitor.status-lifetime:client端状态的生命周期,该生命周期内不会更新client状态。单位是毫秒,默认值是10秒钟;

spring.boot.admin.monitor.connect-timeout:查询client状态信息时的连接超时时间,单位是毫秒,默认是2秒(如果2秒内没有获取到client的状态信息,则认为连接已经断开)。

spring.boot.admin.monitor.read-timeout:查询client状态信息时的读取超时时间,单位是毫秒,默认是2秒(如果2秒内没有获取到client的状态信息,则认为读取失败)。

spring.boot.admin.metadata-keys-to-sanitize:要被过滤掉的元数据(当与正则表达式相匹配时,这些数据会在输出的json数据中过滤掉),默认值是".password$", ".*secret$", ".*key$", ".$token$", ".credentials.", ".*vcap_services$";

spring.boot.admin.probed-endpoints:要获取的client的端点信息,默认是"health", "env", "metrics", "httptrace:trace", "threaddump:dump", "jolokia", "info", "logfile", "refresh", "flyway", "liquibase", "heapdump", "loggers", "auditevents";

spring.boot.admin.instance-proxy.ignored-headers:向client发起请求时不会被转发的headers信息,默认值是"Cookie", "Set-Cookie", "Authorization";

spring.boot.admin.ui.brand:在导航栏中显示的brand值,默认是"<img src="assets/img/icon-spring-boot-admin.svg"><span>Spring Boot Admin</span>";

spring.boot.admin.ui.title:显示的页面标题,默认是"Spring Boot Admin"

  • 3
    点赞
  • 1
    评论
  • 23
    收藏
  • 打赏
    打赏
  • 扫一扫,分享海报

©️2022 CSDN 皮肤主题:大白 设计师:CSDN官方博客 返回首页

打赏作者

Java小飞侠

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值