关于Spring Boot Admin获取Actuator端点监控地址配置及management.health健康指标器的相关分析及注意事项

2023-10-22 08:20
文章标签 java 分析 配置 spring 地址 注意事项 相关 指标 boot 获取 监控 健康 admin management health 端点 actuator

本文主要是介绍关于Spring Boot Admin获取Actuator端点监控地址配置及management.health健康指标器的相关分析及注意事项，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

最近在使用Spring Boot Admin的时候发现(以下简称SBA)，使用eureka的注册中心的时候sba可以正常获取到服务的管理地址和健康检测地址，而换了Nacos作为注册中的时候，sba中的服务管理地址和健康检测地址是错误的。如图

一般来说正常的
服务访问地址是：http://IP:${server.port}/${server.servlet.context-path},
服务管理地址是：http://IP:${management.server.port}/${management.server.servlet.context-path}/${management.endpoints.web.base-path},其中这里management.endpoints.web.base-path默认为/actuator,
健康检测地址是：http://IP:${management.server.port}/${management.server.servlet.context-path}/${management.endpoints.web.base-path}/health

例如一个服务的如果设置
management.server.port = 30000
management.server.servlet.context-path = /sba
服务管理地址为：http://127.0.0.1:30000/sba/actuator,
健康检测地址为：http://127.0.0.1:30000/sba/actuator/health,

如果management.endpoints.web.base-path = /act
服务管理地址为：http://127.0.0.1:30000/sba/act,
健康检测地址为：http://127.0.0.1:30000/sba/act/health,

这是从应用程序的使用角度来说的，也就是通过上面的配置就可以在对应的配置地址访问到端点监控数据。

而通常来说我们是不配置management.server.servlet.context-path和management.endpoints.web.base-path的，所以对于管理地址来说，就是简单的http://IP:${management.server.port}/actuator

哪么问题来了，为何使用Nacos作为注册中心的时候，sba取到的地址有问题呢？这样我们就只能从sba的角度来查看了，我们首先来看一下sba的自动配置类AdminServerDiscoveryAutoConfiguration，de.codecentric.boot.admin.server.cloud.config.AdminServerDiscoveryAutoConfiguration

@Bean@ConditionalOnMissingBean({ ServiceInstanceConverter.class })@ConfigurationProperties(prefix = "spring.boot.admin.discovery.converter")public DefaultServiceInstanceConverter serviceInstanceConverter() {return new DefaultServiceInstanceConverter();}@Configuration(proxyBeanMethods = false)@ConditionalOnMissingBean({ ServiceInstanceConverter.class })@ConditionalOnBean(EurekaClient.class)public static class EurekaConverterConfiguration {@Bean@ConfigurationProperties(prefix = "spring.boot.admin.discovery.converter")public EurekaServiceInstanceConverter serviceInstanceConverter() {return new EurekaServiceInstanceConverter();}}@Configuration(proxyBeanMethods = false)@ConditionalOnMissingBean({ ServiceInstanceConverter.class })@ConditionalOnBean(KubernetesDiscoveryClient.class)public static class KubernetesConverterConfiguration {@Bean@ConfigurationProperties(prefix = "spring.boot.admin.discovery.converter")public KubernetesServiceInstanceConverter serviceInstanceConverter() {return new KubernetesServiceInstanceConverter();}}

可以看出来，这里包含了实例的转换器，这里有一个de.codecentric.boot.admin.server.cloud.discovery.DefaultServiceInstanceConverter 我们首先来看一下，DefaultServiceInstanceConverter为其默认Converter，EurekaServiceInstanceConverter 和 KubernetesServiceInstanceConverter都继承于DefaultServiceInstanceConverter，作为Eureka和Kubernetes实现，我们来分析一下DefaultServiceInstanceConverter里是如何获取到服务实例的地址的。

public class DefaultServiceInstanceConverter implements ServiceInstanceConverter {private static final Logger LOGGER = LoggerFactory.getLogger(DefaultServiceInstanceConverter.class);private static final String KEY_MANAGEMENT_SCHEME = "management.scheme";private static final String KEY_MANAGEMENT_ADDRESS = "management.address";private static final String KEY_MANAGEMENT_PORT = "management.port";private static final String KEY_MANAGEMENT_PATH = "management.context-path";private static final String KEY_HEALTH_PATH = "health.path";/*** Default context-path to be appended to the url of the discovered service for the* managment-url.*/private String managementContextPath = "/actuator";/*** Default path of the health-endpoint to be used for the health-url of the discovered* service.*/private String healthEndpointPath = "health";// 注册服务实例的名称，健康检测地址，管理地址，服务地址，metadata数据@Overridepublic Registration convert(ServiceInstance instance) {LOGGER.debug("Converting service '{}' running at '{}' with metadata {}", instance.getServiceId(),instance.getUri(), instance.getMetadata());return Registration.create(instance.getServiceId(), getHealthUrl(instance).toString()).managementUrl(getManagementUrl(instance).toString()).serviceUrl(getServiceUrl(instance).toString()).metadata(getMetadata(instance)).build();}// 这里就是拼接管理地址和健康检测路径，http://192.168.14.240:2429/actuator/healthprotected URI getHealthUrl(ServiceInstance instance) {return UriComponentsBuilder.fromUri(getManagementUrl(instance)).path("/").path(getHealthPath(instance)).build().toUri();}// 这里取的是健康检测地址，首先从服务实例的MetaData中的health.path取，取不到默认值是healthprotected String getHealthPath(ServiceInstance instance) {String healthPath = instance.getMetadata().get(KEY_HEALTH_PATH);if (!isEmpty(healthPath)) {return healthPath;}return this.healthEndpointPath;}protected URI getManagementUrl(ServiceInstance instance) {URI serviceUrl = this.getServiceUrl(instance);String managementScheme = this.getManagementScheme(instance);String managementHost = this.getManagementHost(instance);int managementPort = this.getManagementPort(instance);UriComponentsBuilder builder;if (serviceUrl.getHost().equals(managementHost) && serviceUrl.getScheme().equals(managementScheme)&& serviceUrl.getPort() == managementPort) {builder = UriComponentsBuilder.fromUri(serviceUrl);}else {builder = UriComponentsBuilder.newInstance().scheme(managementScheme).host(managementHost);if (managementPort != -1) {builder.port(managementPort);}}return builder.path("/").path(getManagementPath(instance)).build().toUri();}// 这里取的是Scheme的内容，首先从服务实例的MetaData中的management.scheme取，取不到就是instance.getUri().getScheme()默认的httpprivate String getManagementScheme(ServiceInstance instance) {String managementServerScheme = instance.getMetadata().get(KEY_MANAGEMENT_SCHEME);if (!isEmpty(managementServerScheme)) {return managementServerScheme;}return getServiceUrl(instance).getScheme();}// 这里取的是管理主机地址，也是从MeatData中management.address取，取不到用的就是instance.getUri().getHost()protected String getManagementHost(ServiceInstance instance) {String managementServerHost = instance.getMetadata().get(KEY_MANAGEMENT_ADDRESS);if (!isEmpty(managementServerHost)) {return managementServerHost;}return getServiceUrl(instance).getHost();}// 这里取的是管理端口号，也是从MeatData中management.port取，取不到用的就是instance.getUri().getPort()，实例端口protected int getManagementPort(ServiceInstance instance) {String managementPort = instance.getMetadata().get(KEY_MANAGEMENT_PORT);if (!isEmpty(managementPort)) {return Integer.parseInt(managementPort);}return getServiceUrl(instance).getPort();}// 这里取的是管理路径，也是从MeatData中management.context-path取，取不到用的就是使用默认值/actuatorprotected String getManagementPath(ServiceInstance instance) {String managementPath = instance.getMetadata().get(DefaultServiceInstanceConverter.KEY_MANAGEMENT_PATH);if (!isEmpty(managementPath)) {return managementPath;}return this.managementContextPath;}// 这里取到的是 IP:端口号 htpp://instance.host:instance.portprotected URI getServiceUrl(ServiceInstance instance) {return instance.getUri(); }protected Map<String, String> getMetadata(ServiceInstance instance) {return (instance.getMetadata() != null) ? instance.getMetadata() : emptyMap();}public void setManagementContextPath(String managementContextPath) {this.managementContextPath = managementContextPath;}public String getManagementContextPath() {return this.managementContextPath;}public void setHealthEndpointPath(String healthEndpointPath) {this.healthEndpointPath = healthEndpointPath;}public String getHealthEndpointPath() {return this.healthEndpointPath;}}

所以sba 会获取 instance的name、managementUrl、healthUrl、serviceUrl、metadata数据，这些地址都是首先从metadata数据中获取并进行组装，主要的涉及到配置的重点参数包含如下三个，

KEY_MANAGEMENT_PORT = "management.port";  这个参数不需要特殊配置，因为注册中心使用的时候会自动配置进入metadata，重点在于下面的两个参数上

KEY_MANAGEMENT_PATH = "management.context-path";

KEY_HEALTH_PATH = "health.path";

那么只要保持这些参数使用了正确的配置，那么让sba获取到完美的管理地址、健康检测地址就变得轻松容易了。

如果你使用的是eureka作为注册中心，erueka中如何配置呢

eureka:instance:metadata-map:management.context-path: ${management.endpoints.web.base-path:/actuator}health.path: /health

如果你使用的是Nacos作为注册中心，Nacos中如何配置呢

spring:cloud:nacos:discovery:metadata:management.context-path: ${management.endpoints.web.base-path:/actuator}health.path: /health

因为开始已经说了服务管理地址是：http://IP:${management.server.port}/${management.server.servlet.context-path}/${management.endpoints.web.base-path},其中这里management.endpoints.web.base-path默认为/actuator, 所以management.context-path 就要跟随 management.endpoints.web.base-path走

这里有一个特别特别重要的点，就是在sba时候，内部默认是没有对 management.server.servlet.context-path 进行特殊的处理，所以使用sba的时候，切记，不要设置management.server.servlet.context-path，而且用处也不是很大只要不配置就可以了，也不要配置成management.server.servlet.context-path=/ 这种形式。如果你说你特别想用，哪只能去改写自己实现一个继承DefaultServiceInstanceConverter 并完成自动配置，以便完成sba对 management.server.servlet.context-path 的处理逻辑也是可以实现的，不过这里就不做过多讲解了，因为没必要浪费这样的精力去搞这件事。

到此我们只需要考虑如何为sba实现正确的配置了。

下面我们反过来再说，为何配置文件中metadata中不配置management.context-path的时候，Nacos为何无法支持呢，因为从上面的源码可以看到取 getManagementPath 的时候，优先级是先从metadata中取得，如果没有配置，那么取的就是默认的 /actuator，但是Nacos中初始化的时候却偏偏设置了management.context-path，nacos注册中心可以说是对metadata填充的还是比较全面的了，我们从com.alibaba.cloud.nacos.registry.NacosRegistration这个类中可以看到，com.alibaba.cloud.nacos.registry.NacosRegistration.init() ，在init初始化方法中，

if (null != managementPort) {metadata.put(MANAGEMENT_PORT, managementPort.toString());String contextPath = env.getProperty("management.server.servlet.context-path");String address = env.getProperty("management.server.address");if (!StringUtils.isEmpty(contextPath)) {metadata.put(MANAGEMENT_CONTEXT_PATH, contextPath);}if (!StringUtils.isEmpty(address)) {metadata.put(MANAGEMENT_ADDRESS, address);}
}

management.context-path 被 management.server.servlet.context-path 给覆盖掉了，这样取到的地址就少了一层目录

例如假设如下设置：

management.server.port = 30000
management.server.servlet.context-path = /sba
management.endpoints.web.base-path = /act

按设置来说 metadata中的management.context-path = ${management.endpoints.web.base-path:/actuator} 也就是 metadata中的 management.context-path = /act，sba生成的管理地址是 http://127.0.0.1:30000/sba/act 

如果此时不设置management.endpoints.web.base-path，sba管理地址是 http://127.0.0.1:30000/sba/actuator

如果此时不设置management.server.servlet.context-path，sba管理地址是http://127.0.0.1:30000/actuator

但是如果此时设置了management.server.servlet.context-pathNacos会把metadata中的management.context-path覆盖

所以对于Nacos来说

例如假设只设置了management.server.servlet.context-path = /sba

那么从服务角度来说管理地址正确的应该是 http://127.0.0.1:30000/sba/actuator，
而从sba角度来说地址是http://127.0.0.1:30000/sba，所以sba生成地址就不正常了因此取不到管理地址及健康检测地址

归纳起来总结为：
sba管理地址为：http://127.0.0.1:30000/${management.context-path} 
由于nacos中metadata中的management.context-path = management.server.servlet.context-path  地址就变为了 http://127.0.0.1:30000/${management.server.servlet.context-path}
而服务的实际地址是 http://127.0.0.1:30000/${management.server.servlet.context-path}/${management.endpoints.web.base-path:/actuator}， 这就是nacos的问题所在。

上面只是解释了应用Nacos会出现sba取错地址问题的原因，说了很多，可能你已经迷糊了，但只要记住几点，设置如下几个参数的时候要注意。

1、management.server.servlet.context-path 尽量不要设置，设置了就会影响sba的使用除非你自己处理sba。这样nacos就不会把metadata中的management.context-path覆盖，为第三步正常使用management.context-path奠定了条件

2、management.endpoints.web.base-path 尽量不要设置，默认即可 /actuator 也挺好的，但是设置了也不影响，只是第三步要跟随设置

3、配置的时候一定要且仅仅设置metadata中的management.context-path 和 health.path两项即可

metadata:
          management.context-path: ${management.endpoints.web.base-path:/actuator}
          health.path: /health

这样就可以保证在Spring Boot Admin中即便使用不同注册中心都可以取到和服务匹配的管理地址和健康检测地址啦！

 

 

 

 

 

 

 

这篇关于关于Spring Boot Admin获取Actuator端点监控地址配置及management.health健康指标器的相关分析及注意事项的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/260230。

相关文章

Java五子棋之坐标校正

Java五子棋之坐标校正

上篇针对了Java项目中的解构思维，在这篇内容中我们不妨从整体项目中拆解拿出一个非常重要的五子棋逻辑实现：坐标校正，我们如何使漫无目的鼠标点击变得有序化和可控化呢？ 目录 一、从鼠标监听到获取坐标 1.MouseListener和MouseAdapter 2.mousePressed方法 二、坐标校正的具体实现方法 1.关于fillOval方法 2.坐标获取 3.坐标转换 4.坐
阅读更多...
Spring Cloud：构建分布式系统的利器

Spring Cloud：构建分布式系统的利器

引言 在当今的云计算和微服务架构时代，构建高效、可靠的分布式系统成为软件开发的重要任务。Spring Cloud 提供了一套完整的解决方案，帮助开发者快速构建分布式系统中的一些常见模式（例如配置管理、服务发现、断路器等）。本文将探讨 Spring Cloud 的定义、核心组件、应用场景以及未来的发展趋势。 什么是 Spring Cloud Spring Cloud 是一个基于 Spring
阅读更多...
Linux 安装、配置Tomcat 的HTTPS

Linux 安装、配置Tomcat 的HTTPS

Linux 安装 、配置Tomcat的HTTPS 安装Tomcat 这里选择的是 tomcat 10.X ,需要Java 11及更高版本 Binary Distributions ->Core->选择 tar.gz包 下载、上传到内网服务器 /opt 目录tar -xzf 解压将解压的根目录改名为 tomat-10 并移动到 /opt 下, 形成个人习惯的路径 /opt/tomcat-10
阅读更多...
RecastNavigation之Poly相关类

RecastNavigation之Poly相关类

Poly分成正常的Poly 和 OffMeshPoly。 正常的Poly 又分成 原始的Poly 和 Detail化的Poly，本文介绍这两种。 Poly的边分成三种类型： 1. 正常边：有tile内部的poly与之相邻 2.border边：没有poly与之相邻 3.Portal边：与之相邻的是外部tile的poly   由firstLink索引 得到第一个连接的Poly  通
阅读更多...
Javascript高级程序设计(第四版)--学习记录之变量、内存

Javascript高级程序设计(第四版)--学习记录之变量、内存

原始值与引用值 原始值：简单的数据即基础数据类型，按值访问。 引用值：由多个值构成的对象即复杂数据类型，按引用访问。 动态属性 对于引用值而言，可以随时添加、修改和删除其属性和方法。 let person = new Object();person.name = 'Jason';person.age = 42;console.log(person.name,person.age);//'J
阅读更多...
java8的新特性之一（Java Lambda表达式）

java8的新特性之一（Java Lambda表达式）

1：Java8的新特性 Lambda 表达式： 允许以更简洁的方式表示匿名函数（或称为闭包）。可以将Lambda表达式作为参数传递给方法或赋值给函数式接口类型的变量。 Stream API： 提供了一种处理集合数据的流式处理方式，支持函数式编程风格。 允许以声明性方式处理数据集合（如List、Set等）。提供了一系列操作，如map、filter、reduce等，以支持复杂的查询和转
阅读更多...
uniapp接入微信小程序原生代码配置方案（优化版）

uniapp接入微信小程序原生代码配置方案（优化版）

uniapp项目需要把微信小程序原生语法的功能代码嵌套过来，无需把原生代码转换为uniapp，可以配置拷贝的方式集成过来 1、拷贝代码包到src目录 2、vue.config.js中配置原生代码包直接拷贝到编译目录中 3、pages.json中配置分包目录，原生入口组件的路径 4、manifest.json中配置分包，使用原生组件 5、需要把原生代码包里的页面修改成组件的方
阅读更多...
Java面试八股之怎么通过Java程序判断JVM是32位还是64位

Java面试八股之怎么通过Java程序判断JVM是32位还是64位

怎么通过Java程序判断JVM是32位还是64位 可以通过Java程序内部检查系统属性来判断当前运行的JVM是32位还是64位。以下是一个简单的方法： public class JvmBitCheck {public static void main(String[] args) {String arch = System.getProperty("os.arch");String dataM
阅读更多...
详细分析Springmvc中的@ModelAttribute基本知识（附Demo）

详细分析Springmvc中的@ModelAttribute基本知识（附Demo）

目录 前言1. 注解用法1.1 方法参数1.2 方法1.3 类 2. 注解场景2.1 表单参数2.2 AJAX请求2.3 文件上传 3. 实战4. 总结 前言 将请求参数绑定到模型对象上，或者在请求处理之前添加模型属性 可以在方法参数、方法或者类上使用 一般适用这几种场景： 表单处理：通过 @ModelAttribute 将表单数据绑定到模型对象上预处理逻辑：在请求处理之前
阅读更多...
eclipse运行springboot项目，找不到主类

eclipse运行springboot项目，找不到主类

解决办法尝试了很多种，下载sts压缩包行不通。最后解决办法如图： help--->Eclipse Marketplace--->Popular--->找到Spring Tools 3---->Installed。
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2