Spring Boot Admin的使用(Actuator监控接口)

第一部分 Spring Boot Admin 简介

  • Spring Boot Admin用来管理和监控Spring Boot应用程序。
  • 应用程序向我们的Spring Boot Admin Client注册(通过HTTP)或使用SpringCloud®(例如Eureka,Consul)发现。
  • UI是Spring Boot Actuator端点上的Vue.js应用程序。

Spring Boot Admin 是一个管理和监控Spring Boot 应用程序的开源软件。每个应用都认为是一个客户端,通过HTTP或者使用 Eureka注册到admin server中进行展示,Spring Boot Admin UI部分使用AngularJs将数据展示在前端。

Spring Boot Admin 是一个针对spring-boot的actuator接口进行UI美化封装的监控工具。他可以:在列表中浏览所有被监控spring-boot项目的基本信息、内存信息、JVM信息、垃圾回收信息、各种配置信息(比如数据源、缓存列表和命中率)等,还可以直接修改logger的level。

admin-server 服务端(admin-server)

服务端:是指Spring Boot Admin这个应用(通常就是指监控服务器),一个服务端可以监控多个客户端。

客户端

客户端是:被服务端监控的对象(通常就是指你的业务系统)。

第二部分 快速入门

本部分将为您展示SpringBoot ADMIN 的简单应用。

服务端配置(admin-server)

步骤一:搭建springboot maven项目

搭建一个基于SpringBoot的项目。注意您所使用的SpringBoot版本。

步骤二:配置pom.xml文件

     <dependency>             <groupId>de.codecentric</groupId>             <artifactId>spring-boot-admin-starter-server</artifactId>             <version>2.3.1</version>       </dependency>  

步骤三:application.properties中配置端口号

此端口号指的是你所搭建的服务器所使用的的版本号,如果服务端和客户端在同一台机器上,注意端口号的设置,以防端口出现冲突的情况。

server.port=8099  

步骤四:主启动类上加注解@EnableAdminServer

@SpringBootApplication  @EnableAdminServer  public class DemoApplication {      public static void main(String[] args) {         SpringApplication.run(DemoApplication.class, args);     }  }  

步骤五:启动项目

访问:http://127.0.0.1:8099/applications。监控首页显示如下

Spring Boot Admin的使用(Actuator监控接口)

客户端配置(admin-client)

步骤一:在客户端项目(也就是需要监控的springboot项目)中添加jar包

加入Security安全框架的jar包,加入jar需注意版本的问题。有些springboot版本,可能会自动引入失>败。如图:

Spring Boot Admin的使用(Actuator监控接口)

出现这种情况需指定security的版本号,找个适合你springboot版本的security。

具体如下:

     <!--security-->         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-security</artifactId>             <version>2.4.1</version>         </dependency>  

引入 spring-boot-admin-starter-client

  <!--admin server 监控-->         <dependency>             <groupId>de.codecentric</groupId>             <artifactId>spring-boot-admin-starter-client</artifactId>             <version>2.4.1</version>         </dependency>  

步骤二:在启动配置文件中配置如下 application.properties

#开放端点用于SpringBoot Admin的监控  management.endpoints.web.exposure.include=* # 给client应用取个名字  spring.boot.admin.client.instance.name=zxfdemo #这里配置admin server 的地址  spring.boot.admin.client.url=http://localhost:8099 #这里配置admin client 的地址(客户端应用程序)  spring.boot.admin.client.instance.service-url=http://localhost:8080 

步骤四:测试效果

Spring Boot Admin的使用(Actuator监控接口) Spring Boot Admin的使用(Actuator监控接口) Spring Boot Admin的使用(Actuator监控接口)

spring security 安全加固

SpringBoot Admin的管理后台如果没密码就能访问,那实在太不安全了,所以需要引入一个安全加固的jar包。spring-boot-starter-security

Spring Security是一个功能强大且高度可定制的身份验证和访问控制框架。提供了完善的认证机制和方法级的授权功能。是一款非常优秀的权限管理框架。它的核心是一组过滤器链,不同的功能经由不同的过滤器。此处就是想通过一个小案例将Spring Security整合到SpringBoot中去。要实现的功能就是在认证服务器上登录,然后获取Token,再访问资源服务器中的资源。

服务端配置(admin-server)

服务端配置修改

1. 服务端添加Spring Security 相关依赖

添加Spring Security 相关依赖

 <!-- security-->         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-security</artifactId>             <version>2.4.1</version>         </dependency> 

2. 服务端设置账号密码

spring.security.user.name=zxf spring.security.user.password=123456 

3.添加一个Spring Security 配置类

package com.example.springadmintest.config;  import de.codecentric.boot.admin.server.config.AdminServerProperties; import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter; import org.springframework.security.web.csrf.CookieCsrfTokenRepository;  /**  * 配置security验证页面指向SpringBootAdmin提供的UI界面  *  *  */ @Configuration public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {      private final String contextPath;      public SecuritySecureConfig(AdminServerProperties adminServerProperties) {         this.contextPath = adminServerProperties.getContextPath();     }      @Override     protected void configure(HttpSecurity http) throws Exception {         // 跨域设置,SpringBootAdmin客户端通过instances注册,见InstancesController         http.csrf().csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())                 .ignoringAntMatchers(contextPath + "/instances");          http.authorizeRequests().antMatchers(contextPath + "/assets/**").permitAll(); // 静态资源         http.authorizeRequests().anyRequest().authenticated(); // 所有请求必须通过认证          // 整合spring-boot-admin-server-ui         http.formLogin().loginPage("/login").permitAll();         http.logout().logoutUrl("/logout").logoutSuccessUrl("/login");          // 启用basic认证,SpringBootAdmin客户端使用的是basic认证         http.httpBasic();     } }  

4.登录页面展示

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

Spring Boot Admin的使用(Actuator监控接口)

客户端配置(admin-client)

客户端配置

1.客户端添加Spring Security 相关依赖

 <!-- security-->         <dependency>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-starter-security</artifactId>             <version>2.4.1</version>         </dependency> 

2. 客户端设置账号密码

 # 配置 admin-client 地址 spring.boot.admin.client.instance.service-url=http://localhost:8080 #配置 admin-server地址 spring.boot.admin.client.url=http://localhost:8099 # 配置 admin-server的账号 spring.boot.admin.client.username=zxf # 配置 admin-server的密码 spring.boot.admin.client.password=123456 #配置 admin-server的密码 spring.security.user.name=zxf #配置 admin-client的密码 spring.security.user.password=123456 #若在核心配置文件中未添加 management.security.enabled=false 配置, # 将会导致用户在访问部分监控地址时访问受限,报401未授权错误。 management.security.enabled=false #监控中心配置, 允许监控所有接口 management.endpoints.web.exposure.include=*  

3. 客户端添加Spring Security 配置类

package com.cachedemo.controller;  import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;  @Configuration public class SecurityPermitAllConfig extends WebSecurityConfigurerAdapter {     @Override     protected void configure(HttpSecurity http) throws Exception {         http.authorizeRequests().anyRequest().permitAll()                 .and().csrf().disable();     } }  

所有配置完成测试结果

Spring Boot Admin的使用(Actuator监控接口)
Spring Boot Admin的使用(Actuator监控接口)
Spring Boot Admin的使用(Actuator监控接口)
Spring Boot Admin的使用(Actuator监控接口)
版权声明:玥玥 发表于 2021-05-05 22:49:27。
转载请注明:Spring Boot Admin的使用(Actuator监控接口) | 女黑客导航