springboot技术专题「开发实战系列」一起搭建属于自己的springbootadmin的技术要素

author author     2022-12-27     594

关键词:

SpringBoot Admin的介绍说明

SpringBoot Admin是开源社区孵化的项目,用于对SpringBoot应用的管理和监控。SpringBoot Admin 分为服务端(spring-boot-admin-server)和客户端(spring-boot-admin-client),服务端和客户端之间采用http通讯方式实现数据交互;

单体项目中需要整合spring-boot-admin-client才能让应用被监控。在SpringCloud项目中,spring-boot-admin-server 是直接从注册中心抓取应用信息,不需要每个微服务应用整合spring-boot-admin-client就可以实现应用的管理和监控。

SpringBoot Admin的技术分析

Spring Boot提供的监控接口,例如:/health、/info等等,实际上除了之前提到的信息,还有其他信息业需要监控:当前处于活跃状态的会话数量、当前应用的并发数、延迟以及其他度量信息。

了解如何利用Spring-boot-admin对应用信息进行可视化,如何添加度量信息。

【SpringBoot技术专题】「开发实战系列」一起搭建属于自己的SpringBoot

准备

官方入门指南:​​https://codecentric.github.io/spring-boot-admin/current/​

官网参考链接:​​https://codecentric.github.io/spring-boot-admin/2.2.4/​

Github地址在:​​https://github.com/codecentric/spring-boot-admin​​ 它在Spring Boot Actuator的基础上提供简洁的可视化WEB UI。

首先在start.spring.io中创建简单的admin应用,主要步骤如下:

  1. 在Ops组选项中选择Actuator
  2. 选择Generate Project下载应用
  3. 使用IDEA打开工程,在pom.xml文件中添加下列依赖
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server</artifactId>
<version>2.2.4</version>
</dependency>
<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-server-ui</artifactId>
<version>2.2.4</version>
</dependency>

如果springboot版本是2.2.10.RELEASE,那么springboot admin 也要用2.2.x版

  1. 在SpringBootAdminWebApplication.java文件中添加@EnableAdminServer注解
@SpringBootApplication
@EnableAdminServer
public class SpringBootAdminWebApplication
public static void main(String[] args)
SpringApplication.run(SpringBootAdminWebApplication.class, args);

  1. 在application.properties文件中添加如下配置
server.port = 8090
spring.application.name=Spring Boot Admin Web
spring.boot.admin.url=http://localhost:$server.port
spring.jackson.serialization.indent_output=true
endpoints.health.sensitive=false
  1. 启动Admin Server应用后,现在可以添加针对应用的度量信息了。
定制化自己的Indicator

在Spring Boot应用的健康监控中,我们可以定制自己的Health Indicator,用来监控四个数据库接口的健康状态,这次我将利用spring-boot-admin对这些信息进行可视化管理。

在服务模块下添加代码,首先在建立下添加SampleCountMetrics类:

public class SampleCountMetrics implements PublicMetrics 
private Collection<CrudRepository> repositories;
public SampleCountMetrics(Collection<CrudRepository> repositories)
this.repositories = repositories;

@Override
public Collection<Metric<?>> metrics()
List<Metric<?>> metrics = new LinkedList<>();
for (CrudRepository repository: repositories)
String name =
DbCountRunner.getRepositoryName(repository.getClass());
String metricName = "properties.datasource." + name;
metrics.add(new Metric(metricName, repository.count()));

return metrics;

在Configuration定义对应的Bean,由Spring Boot完成自动注册

@Bean
public PublicMetrics sampleCountMetrics(Collection<CrudRepository> repositories)
return new SampleCountMetrics(repositories);

访问​​http://localhost​​:port/metrics,可以看到SampleCountMetrics已经添加到metrics列表中了。

总结分析

Spring Boot Admin就是将Spring Boot Actuator中提供的endpoint信息可视化表示,在应用(被监控)的这一端,只需要进行一点配置即可。

部署Admin Client端服务

<dependency>
<groupId>de.codecentric</groupId>
<artifactId>spring-boot-admin-starter-client</artifactId>
<version>2.2.4</version>
</dependency>

在应用下的application.properties中配置下列属性值

spring.application.name=@project.description@
server.port=8080
spring.boot.admin.url=http://localhost:8090

开放端点用于SpringBoot Admin的监控

management.endpoints.web.exposure.include: *

spring-boot-admin-starter-client,作为客户端,用于与Spring Boot Admin Web的服务器沟通;

spring.boot.client.admin.url=http:localhost:8090用于将当前应用注册到Spring Boot Admin。

【SpringBoot技术专题】「开发实战系列」一起搭建属于自己的SpringBoot

如果希望通过Web控制系统的日志级别,则需要在应用中添加Jolokia JMX库(org.jolokia:jolokia-core),同时在项目资源目录下添加logback.xml文件,内容如下:

<configuration>
<include resource="org/springframework/boot/logging/logback/base.xml"/>
<jmxConfigurator/>
</configuration>


然后再次启动应用,然后在Spring Boot Admin的页面中查看LOGGING

Spring Boot Admin的目的是什么

Spring Boot提供的度量工具功能强大且具备良好的扩展性,除了我们配置的SampleCountMetrics,还监控应用的其他信息,例如内存消耗、线程数量、系统时间以及http会话数量。

gague和counter的定制

gague和counter度量通过GagueService和CountService实例提供,这些实例可以导入到任何Spring管理的对象中,用于度量应用信息。

例如,我们可以统计某个方法的调用次数,如果要统计所有RESTful接口的调用次数,则可以通过AOP实现,在调用指定的接口之前,首先调用counterService.increment("objectName.methodName.invoked");,某个方法被调用之后,则对它的统计值+1。

在pom文件中添加AOP依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>

应用中添加Aspect组件,表示在每个Controller的方法调用之前,首先增加调用次数。

@Aspect
@Component
public class ServiceMonitor
@Autowired
private CounterService counterService;
@Before("execution(* com.xx.xx.xx.*.*(..))")
public void countServiceInvoke(JoinPoint joinPoint)
counterService.increment(joinPoint.getSignature() + "");

在application.properties中设置打开AOP功能:spring.aop.auto=true

如果希望统计每个接口的调用时长,则需要借助GagueService来实现,同样使用AOP实现,则需要环绕通知:在接口调用之前,利用long start = System.currentTimeMillis();,在接口调用之后,计算耗费的时间,单位是ms,然后使用gugeService.submit(latency)更新该接口的调用延时。

在ServiceMonitor类中添加对应的监控代码

@Autowired
private GaugeService gaugeService;
@Around("execution(* com.xx.xx.xx.*.*(..))")
public void latencyService(ProceedingJoinPoint pjp) throws Throwable
long start = System.currentTimeMillis();
pjp.proceed();
long end = System.currentTimeMillis();
gaugeService.submit(pjp.getSignature().toString(), end - start);

然后在Spring Boot Admin后台可以看到对应接口的调用延迟

这两个service可以应付大多数应用需求,如果需要监控其他的度量信息,则可以定制我们自己的Metrics,例如在之前的例子中我们要统计四个数据库接口的调用状态,则我们定义了SampleCountMetrics,该类实现了PublishMetrics,在这个类中我们统计每个数据库接口的记录数量。

PublishMetrics这个接口只有一个方法:Collection<Metric<?>> metrics();,在该方法中定义具体的监控信息;该接口的实现类需要在配置文件中通过@Bean注解,让Spring Boot在启动过程中初始化,并自动注册到MetricsEndpoint处理器中,这样每次有访问/metrics的请求到来时,就会执行对应的metrics方法。

安全性

admin-server端安全加固
下面开始具体的改造
admin-server 添加Spring Security 相关依赖
<!--springboot admin 安全相关-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
admin-server 设置账号和密码

在application.yml配置账号和密码

# 配置一个账号和密码
spring:
security:
user:
name: admin
password: root123456
admin-server 添加一个Spring Security 配置类
@Configuration
public class SecuritySecureConfig extends WebSecurityConfigurerAdapter
private final String adminContextPath;
public SecuritySecureConfig(AdminServerProperties adminServerProperties)
this.adminContextPath = adminServerProperties.getContextPath();

@Override
protected void configure(HttpSecurity http) throws Exception
SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
successHandler.setTargetUrlParameter("redirectTo");
successHandler.setDefaultTargetUrl(adminContextPath + "/");
http.authorizeRequests()
//1.配置所有静态资源和登录页可以公开访问
.antMatchers(adminContextPath + "/assets/**").permitAll()
.antMatchers(adminContextPath + "/login").permitAll()
.anyRequest().authenticated()
.and()
//2.配置登录和登出路径
.formLogin().loginPage(adminContextPath + "/login").successHandler(successHandler).and()
.logout().logoutUrl(adminContextPath + "/logout").and()
//3.开启http basic支持,admin-client注册时需要使用
.httpBasic().and()
.csrf()
//4.开启基于cookie的csrf保护
.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
//5.忽略这些路径的csrf保护以便admin-client注册
.ignoringAntMatchers(
adminContextPath + "/instances",
adminContextPath + "/actuator/**"
);

admin-server 安全加固后访问测试

再次访问​​http://localhost​​:port/ ,发现需要登录

【SpringBoot技术专题】「开发实战系列」一起搭建属于自己的SpringBoot

当我们输入正确的账号密码登录后,情况如下图

【SpringBoot技术专题】「开发实战系列」一起搭建属于自己的SpringBoot

  • 这个时候的应用数居然变成了0了,在我们没进行安全加固时是有一个admin-client应用的,为什么就不见了?
  • 原因是添加了账号密码认证后,admin-client端也需要配置下 admin-server的账号和密码。
admin-client 端设置 admin-server的账号密码

admin-client 注册到 admin-server时,admin-server端有个http Basic认证,通过了认证后 admin-client才能注册到 admin-server上。
admin-client的application.yml中配置访问密码配置可参考下面代码

spring:
application:
name: admin-client # 给client应用取个名字
boot:
admin:
client:
url: http://localhost:port #这里配置admin server 的地址
# 配置 admin-server的账号和密码
username: admin
password: root123456
再次访问 admin-server 管理后台

当我们登录后,终于再次看到了我们的admin-client这个应用

【SpringBoot技术专题】「开发实战系列」一起搭建属于自己的SpringBoot

admin-client端的安全

admin-client端如果把actuator 端点都暴露出来,是非常不安全的。因此我们可以添加Spring Security对admin-client 也进行安全加固。

下面所有操作均在admin-client中进行

添加Spring Security依赖
<!--spring security-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
yml中需要设置client的账号和密码

本次演示的admin-client的相关yml配置参考下面代码

spring:
application:
name: admin-client # 给client应用取个名字
boot:
admin:
client:
url: http://localhost:23333 #这里配置admin server 的地址
# 配置 admin-server的账号和密码
username: admin
password: root123456
instance:
metadata:
# 这里配置admin-client的账号和密码
user.name: $spring.security.user.name
user.password: $spring.security.user.password
# admin-client 的用户名和密码
security:
user:
name: clientAdmin
password: 123456
添加Spring Security 配置类

为何要到配置?因为Spring Security不配置时会把所有请求都拦截的,而我们这里只需要拦截监控端点/actuator/**即可。同时,官网中提到admin-server访问admin-client时,也是采用http Basic认证方式的;因此需要配置Spring Security支持Http Basic认证方式。

@Configuration
@Slf4j
public class SpringSecurityActuatorConfig extends WebSecurityConfigurerAdapter
public SpringSecurityActuatorConfig()
log.info("SpringSecurityActuatorConfig... start");

@Override
protected void configure(HttpSecurity http) throws Exception
// 这个配置只针对 /actuator/** 的请求生效
http.antMatcher("/actuator/**")
// /actuator/下所有请求都要认证
.authorizeRequests().anyRequest().authenticated()
// 启用httpBasic认证模式,当springboot admin-client 配置了密码时,
// admin-server走httpbasic的认证方式来拉取client的信息
.and().httpBasic()
// 禁用csrf
.and().csrf().disable();


当访问admin-client的监控端点 ​​http://localhost​​:port/actuator/health 时,发现需要进行http Basic认证;这也证明了我们的认证拦截只拦截了监控端点。效果如下图:

【SpringBoot技术专题】「开发实战系列」一起搭建属于自己的SpringBoot

存在的问题

通过上面的一通配置,admin-client 添加 Spring Security 对actuator的端点进行安全认证的功能是实现了,但也存在着问题。

当我们项目本来就是使用SpringSecurity 安全框架进行认证和授权时。上述的配置就要做修改了。因为我们一般都不用HttpBasic认证,而是用的表单登录认证。也就出现了配置多个Spring Security的问题。虽然有这个问题,但是网上还是有解决方案的。

这个方案是在Spring Security官方文档里面找到的:​​https://docs.spring.io/spring-security/site/docs/5.3.5.RELEASE/reference/html5/#multiple-httpsecurity​

/**
* 表单登录认证方式配置,由于没有指定Order,所以默认是最大2147483647,数值越大,优先级越低
* @author ZENG.XIAO.YAN
* @Date 2020-11-11
* @version 1.0
*/
@Configuration
public static class FormLoginWebSecurityConfigurerAdapter extends WebSecurityConfigurerAdapter

public FormLoginWebSecurityConfigurerAdapter()
log.info("FormLoginWebSecurityConfigurerAdapter... start");


@Override
protected void configure(HttpSecurity http) throws Exception
http.authorizeRequests()
.anyRequest().authenticated()
.and()
.formLogin();

springboot技术专题「实战开发系列」带你一同探索shiro整合jwt授权和认证实战开发(代码片段)

本章介绍一下常用的认证框架Shiro结合springboot以及集合jwt快速带您开发完成一个认证框架机制。Maven配置依赖<dependency> <groupId>org.apache.shiro</groupId> <artifactId>shiro-spring</artifactId> <version>1.3.2 查看详情

springboot技术专题「开发实战系列」全面梳理和分析一下相关的web核心配置(代码片段)

SpringBoot提供的自动配置分析WebMvcAutoConfiguration及WebMvcProperties的源码,发现SpringBoot为我们提供了如下自动配置功能。自动配置ViewResolver。(1)ContentNegotiatingViewResolver:这是一个特殊的ViewResolver,ContentNego 查看详情

springboot技术专题「开发实战系列」动态化quartz任务调度机制+实时推送任务数据到前端(代码片段)

前提介绍SpringBoot2.0整合quartz实现多定时任务动态配置,实现任务增删改,生成Cron表达式动态化任务调度添加依赖包<!--quartz--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boo 查看详情

springboot实战专题「开发实战系列」从零开始教你舒服的使用redistemplate操作redis数据

SpringBoot快速操作Redis数据在SpringBoot框架中提供了spring-boot-starter-data-redis的依赖组件进行操作Redis服务,当引入了该组件之后,只需要配置Redis的配置即可进行链接Redis服务并且进行操作Redis服务数据。针对于不同的版本有了不同的... 查看详情

springboot实战专题「开发实战系列」从零开始教你舒服的使用redistemplate操作redis数据(代码片段)

SpringBoot快速操作Redis数据在SpringBoot框架中提供了spring-boot-starter-data-redis的依赖组件进行操作Redis服务,当引入了该组件之后,只需要配置Redis的配置即可进行链接Redis服务并且进行操作Redis服务数据。针对于不同的版本有... 查看详情

springboot技术专题「jwt技术专区」带你一同开发springsecurity整合jwt授权和认证实战指南(代码片段)

JWT基本概念JWT,即JSONWebTokens(RFC7519),是一个广泛用于验证RESTAPIs的标准。虽说是一个新兴技术,但它却得以迅速流行。JWT的验证过程是:前端(客户端)首先发送一些凭证来登录(我们编写... 查看详情

springboot实战开发全套教程,让开发像搭积木一样简单!github星标已上10w+!

前言先说一下,这份教程在github上面星标已上10W,下面我会一一给大家举例出来全部内容,原链接后面我会发出来!首先我讲一下接下来我们会讲到的知识和技术,对比讲解了多种同类技术的使用手日区别,大家可以根据自己的... 查看详情

java技术专题「原理分析系列」分析反射底层原理及基础开发实战(代码片段)

Java代码基础结构Java代码都在类内或者接口内访问修饰符【class/interface/enum】类名成员变量构造方法成员方法Annotation注解Class字节码在内存中分布Class字节码和Java代码Class类相关方法Class:Class.forName(StringpackageNameAndClassName)throwsClassNo... 查看详情

ci/cd技术专题「jenkins实战系列」总结归纳jenkins的安装使用和配置流程介绍(代码片段)

...git提交代码Jenkins自动化将项目部署在Linux服务器。Jenkins技术原理篇版本控制服务Jenki 查看详情

《springboot入门及前后端分离项目实践》系列介绍

课程计划课程地址点这里本课程是一个SpringBoot技术栈的实战类课程,课程共分为3个部分,前面两个部分为基础环境准备和相关概念介绍,第三个部分是SpringBoot项目实践开发。SpringBoot介绍、前后端分离、API规范等内容旨在让读... 查看详情

ci/cd技术专题「jenkins实战系列」全流程介绍jenkins环境搭建+基础部署配置(windows->linux)(代码片段)

背景在实际开发中,我们经常要一边开发一边测试,当然这里说的测试并不是程序员对自己代码的单元测试,而是同组程序员将代码提交后,由测试人员测试;前后端分离后,经常会修改接口,然后重... 查看详情

ci/cd技术专题「jenkins实战系列」jenkins实现自动化部署+自动化合并其他分支(代码片段)

...的安装以及部署到Linux环境的案例和基本配置,【CI/CD技术专题】「Jenkins实战系列」(1)全流程介绍Jenkins环境搭建+基础部署配置(Windows->Linux),接下来,会针对于相关的J 查看详情

springboot知识体系实战-前言

...:就像每本书都有前言一样,接下来我也为我即将分享的SpringBoot知识体系实战系列文章做一个前言介绍。作为现在微服务体系主流的框架,我想诸位都知晓SpringBoot,SpringCloud,打开Spring官网(官网链接)会发现SpringBoot已经是Spri... 查看详情

redis实战专题「技术提升系列」彻底分析探究redission实现分布式锁的点点滴滴(代码片段)

Redission的简介Redission为Redis官网分布式解决方案官网:Redisson:RedisJavaclientwithfeaturesofIn-MemoryDataGrid快速入门:https://github.com/redisson/redisson#quick-startgithub的Redission系列:https://githu 查看详情

mysql技术专题「问题实战系列」mysql报错gotanerrorreadingcommunicationpackets问题分析指南(代码片段)

文章目录前因背景官方解释Aborted_connects:Aborted_clients:Aborted_connectsORAborted_clients:临时配置解决办法设置最大包大小查看包大小永久配置解决办法从以下几个方面考虑:TIME_WAIT的处理方案网络问题分析mysql的参数... 查看详情

ci/cd技术专题「jenkins实战系列」jenkinsfile+dockerfile实现自动部署(代码片段)

每日一句没有人会因学问而成为智者。学问或许能由勤奋得来,而机智与智慧却有懒于天赋。前提概要Jenkins下用DockerFile自动部署Java项目,项目的部署放心推向容器化时代机制。本节需要对jenkinsfile有点了解,对dockerf... 查看详情

ci/cd技术专题「jenkins实战系列」重塑jenkins服务进行自动合并的方案实现(纠正错误)

前言介绍本篇文章主要针对于之前的Jenkins在构建分支的时候,进行自动合并其他分支的纠正和专题介绍,如果想要了解更多的说明,可以参考一下官方文档:Jenkins的Git合并官方介绍(英文版)、【Jenkins官... 查看详情

shardingsphere技术专题「shardingjdbc实战阶段」springboot之整合shardingjdbc实现分库分表(javaconfig方式)(代码片段)

前提介绍ShardingSphere介绍ShardingSphere是一套开源的分布式数据库中间件解决方案组成的生态圈,它由Sharding-JDBC、Sharding-Proxy和Sharding-Sidecar(计划中)这3款相互独立的产品组成。他们均提供标准化的数据分片、分布式事... 查看详情