Spring Boot Admin -Actuator 图形化管理工具

Spring Boot Admin

概述

之前学习了Spring Boot Actuator的特性，它能够是开发者很便捷的监控系统的各种指标，但是有一个很大的问题 — 不够直观。今天来学习下Spring Boot Admin。Spring Boot Admin 是一个免费的开源社区项目，用于监控、管理Spring Boot 应用系统。Spring Boot Admin的架构采用客户端 - 服务器模式，客户端通过HTTP协议周期性的向服务端上报自身服务状态，实现监控管理的目的。Spring Boot Admin提供以下特性：

• 显示服务健康状态
• 服务器IO、内存、CPU、数据库、缓存等指标监控
• 显示编译信息
• 跟踪、下载日志文件
• 查看虚拟机 & 系统设置属性
• 查看Spring Boot 配置属性
• 支持Spring Cloud 相关endpoint
• 便捷的日志级别管理
• 与 JMX-beans 进行交互
• 查看、下载 thread dump
• 查看 http-traces
• 查看 审计事件 - auditevents
• 查看 http-endpoints
• 查看 scheduled tasks
• 查看并删除http sessions (using spring-session)
• 状态变更时进行通知、如电子邮件、短信、钉钉
• 状态变更的事件日志

集成服务端

首先需要启动Spring Boot Admin 服务端程序。为此，只需要启动一个简单的Spring Boot项目即可，由于Spring Boot Admin 服务端能够作为servlet、webflux应用运行，因此Spring Boot 应用只需要添加对应的Spring Boot Starter,

<dependency>
    <groupId>de.codecentricgroupId>
    <artifactId>spring-boot-admin-starter-serverartifactId>
    <version>2.7.5version>
dependency>
1
2
3
4
5

使用maven脚本下载依赖

mvn clean install -Dmaven.test.skip=true
1

接下来只需要在启动类上增加**@EnableAdminServer**注解即可

@SpringBootApplication
@EnableAdminServer
public class SpringbootStudyApplication {

	public static void main(String[] args) {
		ConfigurableApplicationContext app = SpringApplication.run(SpringbootStudyApplication.class, args);
		DatabaseProperties bean = app.getBean(DatabaseProperties.class);
		ServerProperties server = app.getBean(ServerProperties.class);
	}
}
1
2
3
4
5
6
7
8
9
10

启动应用程序，在浏览器访问 http://localhost:8090/applications (application.properties文件中配置的端口为: server.port=8090)

由于目前尚未注册客户端，因此没有任何数据展示出来。

注册客户端

向Spring Boot Admin 服务端注册应用程序，跟服务端启动类似，普通的Spring Boot 应用程序也只需要引入Spring Boot Admin Client starter 依赖即可。

添加依赖

<dependency>
    <groupId>de.codecentricgroupId>
    <artifactId>spring-boot-admin-starter-clientartifactId>
    <version>2.7.5version>
dependency>
1
2
3
4
5

启动客户端

启动Spring Boot Admin 客户端需要在Spring Boot application.properties配置文件中,添加以下配置：

spring.boot.admin.client.url=http://localhost:8090  
management.endpoints.web.exposure.include=* 
# 设置服务名称 方便识别
spring.application.name=Spring-Boot-Admin-Client
1
2
3
4

注意：启动Spring Boot Admin Client 只需要做以上两步即可，不需要在程序添加额外的注解

运行客户端

运行客户端后，重新打开服务端地址，可以看到客户端已经注册上了

客户端集群

客户端多个节点集群部署时，Spring Boot Admin 根据服务名称自动进行分组，因此从Spring Boot Admin UI界面可以很清晰的看出实例的个数。使用IDEA工具或以下命令将客户端启动多次

# 第一次启动
java -jar target/spring-boot-admin-client-0.0.1-SNAPSHOT.jar --server.port=8081

# 第二次启动
java -jar target/spring-boot-admin-client-0.0.1-SNAPSHOT.jar --server.port=8082
1
2
3
4
5

从上面的截图中，可以一目了然的看出服务名称、实例个数、运行时长。

Spring Boot Admin 也支持Spring Cloud 微服务体系中服务发现、注册机制，客户端注册流程甚至不需要单独引入Client 依赖，这里就不做过多的介绍，请参考官方文档。

功能介绍

日志报表

系统监控

配置参数

现在来介绍下Spring Boot Admin 服务端、客户端相关的配置参数，这对开发者进行定制服务、参数调优很有帮助

客户端参数

Spring Boot Admin 客户端向服务端注册，并周期性的发送HTTP POST请求来确保客户端系统处于健康状态。

服务端参数

系统安全

有多种方式解决分布式web应用程序中的身份验证、授权问题。Spring Boot Admin没有提供默认的方式。可以通过集成Spring Security，让Spring Boot Admin UI管理界面提供了简单的登录、注销功能。

服务端设置

添加依赖

<dependency>
			<groupId>org.springframework.bootgroupId>
			<artifactId>spring-boot-starter-securityartifactId>
			<version>2.7.5version>
		dependency>
1
2
3
4
5

新增配置

# 在application.properties文件新增以下配置
spring.security.user.name=admin
spring.security.user.password=admin
1
2
3

Spring Security 代码

@Configuration(proxyBeanMethods = false)
public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {

  private final AdminServerProperties adminServer;

  private final SecurityProperties security;

  public SecuritySecureConfig(AdminServerProperties adminServer, SecurityProperties security) {
    this.adminServer = adminServer;
    this.security = security;
  }

  @Override
  protected void configure(HttpSecurity http) throws Exception {
    SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
    successHandler.setTargetUrlParameter("redirectTo");
    successHandler.setDefaultTargetUrl(this.adminServer.path("/"));

    http.authorizeRequests(
        (authorizeRequests) -> authorizeRequests.antMatchers(this.adminServer.path("/assets/**")).permitAll() 
            .antMatchers(this.adminServer.path("/actuator/info")).permitAll()
            .antMatchers(this.adminServer.path("/actuator/health")).permitAll()
            .antMatchers(this.adminServer.path("/login")).permitAll().anyRequest().authenticated() 
    ).formLogin(
        (formLogin) -> formLogin.loginPage(this.adminServer.path("/login")).successHandler(successHandler).and() 
    ).logout((logout) -> logout.logoutUrl(this.adminServer.path("/logout"))).httpBasic(Customizer.withDefaults()) 
        .csrf((csrf) -> csrf.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()) 
            .ignoringRequestMatchers(
                new AntPathRequestMatcher(this.adminServer.path("/instances"),
                    HttpMethod.POST.toString()), 
                new AntPathRequestMatcher(this.adminServer.path("/instances/*"),
                    HttpMethod.DELETE.toString()), 
                new AntPathRequestMatcher(this.adminServer.path("/actuator/**")) 
            ))
        .rememberMe((rememberMe) -> rememberMe.key(UUID.randomUUID().toString()).tokenValiditySeconds(1209600));
  }

  // Required to provide UserDetailsService for "remember functionality"
  @Override
  protected void configure(AuthenticationManagerBuilder auth) throws Exception {
    auth.inMemoryAuthentication().withUser(security.getUser().getName())
        .password("{noop}" + security.getUser().getPassword()).roles("USER");
  }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

客户端设置

Spring Boot Admin 客户端设置比较简单，只需要在注册信息携带账号、密码即可

# 在application.properties 配置文件中添加
spring.boot.admin.client.username=admin
spring.boot.admin.client.password=admin
1
2
3

消息通知

当服务状态变更时，Spring Boot Admin默认支持多种方式进行消息通知，让系统人员第一时间进行处理，下面以发送EMAIL为例:

EMAIL通知

增加依赖

<dependency>
			<groupId>org.springframework.bootgroupId>
			<artifactId>spring-boot-starter-mailartifactId>
			<version>2.7.5version>
		dependency>
1
2
3
4
5

添加配置

#授权码
spring.mail.password=TGLDQKDBEDVSUPWZ
spring.mail.port=25
spring.mail.properties.mail.smtp.auth=true
spring.boot.admin.notify.mail.from=xxx@163.com
spring.boot.admin.notify.mail.to=xxx@163.com
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
1
2
3
4
5
6
7
8

验证结果

当服务端检测到客户端状态从正常到下线时，则触发邮件报警通知：

服务状态设置

spring.boot.admin.notify.mail.ignore-changes="UNKNOWN:UP"
1

Spring Boot Admin 可以通过设置以上参数，忽略指定的状态，从而不触发消息报警机制。以上配置表示客户端上线不发送邮件通知.

Spring Boot Admin 定义的服务状态在源码中有体现：

public final class StatusInfo implements Serializable {
    public static final String STATUS_UNKNOWN = "UNKNOWN";
    public static final String STATUS_OUT_OF_SERVICE = "OUT_OF_SERVICE";
    public static final String STATUS_UP = "UP";
    public static final String STATUS_DOWN = "DOWN";
    public static final String STATUS_OFFLINE = "OFFLINE";
    public static final String STATUS_RESTRICTED = "RESTRICTED";
    //...
}
1
2
3
4
5
6
7
8
9

自定义消息通知

Spring Boot Admin 也预留了接口给开发者自定义消息通知，如国内企业比较流行的钉钉、企业微信通知

public class CustomNotifier extends AbstractEventNotifier {

  private static final Logger LOGGER = LoggerFactory.getLogger(LoggingNotifier.class);

  public CustomNotifier(InstanceRepository repository) {
    super(repository);
  }

  @Override
  protected Mono<Void> doNotify(InstanceEvent event, Instance instance) {
    return Mono.fromRunnable(() -> {
      if (event instanceof InstanceStatusChangedEvent) {
        LOGGER.info("Instance {} ({}) is {}", instance.getRegistration().getName(), event.getInstance(),
            ((InstanceStatusChangedEvent) event).getStatusInfo().getStatus());
      }
      else {
        LOGGER.info("Instance {} ({}) {}", instance.getRegistration().getName(), event.getInstance(),
            event.getType());
      }
    });
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

参考：

https://blog.csdn.net/caychen/article/details/82887926

https://blog.csdn.net/weixin_37610397/article/details/104064472