springbootAdmin搭建以及对上一个工程进行改造

àì夳堔傛蜴生んèń 2021-12-10 17:23 353阅读 0赞

# 什么是springbootAdmin #

Spring Boot Admin是一个开源社区项目，用于管理和监控SpringBoot应用程序。 应用程序作为Spring Boot Admin Client向为Spring Boot Admin Server注册（通过HTTP）或使用SpringCloud注册中心（例如Eureka，Consul）发现。 UI是的AngularJs应用程序，展示Spring Boot Admin Client的Actuator端点上的一些监控。

常见的功能或者监控如下：

*  显示健康状况
 *  显示详细信息，例如
    
     *  JVM和内存指标
     *  micrometer.io指标
     *  数据源指标
     *  缓存指标
 *  显示构建信息编号
 *  关注并下载日志文件
 *  查看jvm系统和环境属性
 *  查看Spring Boot配置属性
 *  支持Spring Cloud的postable / env-和/ refresh-endpoint
 *  轻松的日志级管理
 *  与JMX-beans交互
 *  查看线程转储
 *  查看http跟踪
 *  查看auditevents
 *  查看http-endpoints
 *  查看计划任务
 *  查看和删除活动会话（使用spring-session）
 *  查看Flyway / Liquibase数据库迁移
 *  下载heapdump
 *  状态变更通知（通过电子邮件，Slack，Hipchat，……）
 *  状态更改的事件日志（非持久性）

# 快速开始 #

### 创建Spring Boot Admin Server ###

#### 原有版本更改 ####

所有工程的Spring Boot版本为2.1.0 、Spring Cloud版本为Finchley.SR2。
    特别注意:zuul网关springboot版本不能更改，一定要用2.0.4要不然将导致版本冲突。
    亲测有坑，注意避开。

pom文件如下:

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.0.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.dsj</groupId>
        <artifactId>boot-admin</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>boot-admin</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Finchley.SR2</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>de.codecentric</groupId>
                <artifactId>spring-boot-admin-starter-server</artifactId>
                <version>2.1.0</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-security</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-mail</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

配置文件:

spring:
      application:
        name: admin-server
      security:
        user:
          name: dsj #监控页面登录名
          password: 123456 #监控页面登录密码
    server:
      port: 8769
    eureka:
      client:
        serviceUrl:
          defaultZone: http://dsj:123456@localhost:8761/eureka
      instance:
          instance-id: ${spring.cloud.client.ip-address}:${server.port}
          prefer-ip-address: true #显示ip
          health-check-url-path: /actuator/health
    
    management:
      endpoints:
        web:
          exposure:
            include: "*"
      endpoint:
        health:
          show-details: ALWAYS
    spring.mail.host: smtp.126.com
    spring.mail.username: pw***7@126.com
    spring.mail.password: 
    spring.boot.admin.notify.mail.to: pw1914109147@126.com #发给谁
    spring.boot.admin.notify.mail.from: pw1914109147@126.com #谁发送

因为更改了认证方式，所以需要修改配置:创建config包

package com.dsj.bootadmin.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.authentication.SavedRequestAwareAuthenticationSuccessHandler;
    
    @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");
    
            http.authorizeRequests()
                    .antMatchers(adminContextPath + "/assets/**").permitAll()
                    .antMatchers(adminContextPath + "/login").permitAll()
                    .anyRequest().authenticated()
                    .and()
                    .formLogin().loginPage(adminContextPath + "/login").successHandler(successHandler).and()
                    .logout().logoutUrl(adminContextPath + "/logout").and()
                    .httpBasic().and()
                    .csrf().disable();
        }
    }

最后启动类上面加入:

package com.dsj.bootadmin;
    
    import de.codecentric.boot.admin.server.config.EnableAdminServer;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    
    @SpringBootApplication
    @EnableAdminServer
    @EnableEurekaClient
    public class BootAdminApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(BootAdminApplication.class, args);
        }
    
    }

### 搭建admin-client ###

在admin-client的pom文件引入以下的依赖，由于2.1.0采用webflux，引入webflux的起步依赖，引入eureka-client的起步依赖，并引用actuator的起步依赖如下：

也就是我们所有需要监控的服务都是client

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-webflux</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-actuator</artifactId>
            </dependency>

修改配置文件:

#暴露全部的监控信息
    eureka:
      client:
        serviceUrl:
          defaultZone: http://dsj:123456@localhost:8761/eureka
      instance:
          instance-id: ${spring.cloud.client.ip-address}:${server.port}
          prefer-ip-address: true #显示ip
          health-check-url-path: /actuator/health
    management:
      endpoints:
        web:
          exposure:
            include: "*"
      endpoint:
          health:
            show-details: ALWAYS

其实就是加入了

health-check-url-path: /actuator/health
    endpoint:
          health:
            show-details: ALWAYS

注意配置文件格式，到此客户端和服务端都搭建完成。

#### 心得 ####

1,当我们启动看到控制台抛出
    java.lang.IllegalStateException: Calling [asyncError()] is not valid for a request with Async state
    异常时，不要紧张，这个不影响我们正常监控，如果不想看到这个异常我们可以将
    tomcat容器换成jetty，这是tomcat和项目的一个io冲突，社区里面作者已经为我们解答了这个问题
    https://github.com/spring-projects/spring-boot/issues/15057
    2，避免这个异常我们把pom文件稍作修改就行了。
    
        <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-tomcat</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-jetty</artifactId>
            </dependency>
            
    3，遇到下面这个异常也不需要担心。
    org.springframework.web.reactive.function.BodyExtractors$ReadCancellationException: null
    	at org.springframework.web.reactive.function.BodyExtractors.lambda$consumeAndCancel$22(BodyExtractors.java:290) ~[spring-webflux-5.1.2.RELEASE.jar:5.1.2.RELEASE]
    	at org.springframework.web.reactive.function.BodyExtractors$$Lambda$1024/253130959.apply(Unknown Source) ~[na:na]
    	at reactor.core.publisher.FluxMap$MapSubscriber.onNext(FluxMap.java:100) [reactor-core-3.2.2.RELEASE.jar:3.2.2.RELEASE]
    	at reactor.core.publisher.FluxMap$MapSubscriber.onNext(FluxMap.java:114) [reactor-core-3.2.2.RELEASE.jar:3.2.2.RELEASE]
    	at reactor.core.publisher.FluxMap$MapSubscriber.onNext(FluxMap.java:114) [reactor-core-3.2.2.RELEASE.jar:3.2.2.RELEASE]
    	at reactor.netty.channel.FluxReceive.drainReceiver(FluxReceive.java:211) [reactor-netty-0.8.2.RELEASE.jar:0.8.2.RELEASE]
    	at reactor.netty.channel.FluxReceive.onInboundNext(FluxReceive.java:327) [reactor-netty-0.8.2.RELEASE.jar:0.8.2.RELEASE]
    	at reactor.netty.channel.ChannelOperations.onInboundNext(ChannelOperations.java:310) [reactor-netty-0.8.2.RELEASE.jar:0.8.2.RELEASE]
    	at reactor.netty.http.client.HttpClientOperations.onInboundNext(HttpClientOperations.java:538) [reactor-netty-0.8.2.RELEASE.jar:0.8.2.RELEASE]
    	at reactor.netty.channel.ChannelOperationsHandler.channelRead(ChannelOperationsHandler.java:141) [reactor-netty-0.8.2.RELEASE.jar:0.8.2.RELEASE]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:362) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:348) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:340) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.handler.codec.MessageToMessageDecoder.channelRead(MessageToMessageDecoder.java:102) [netty-codec-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:362) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:348) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:340) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.CombinedChannelDuplexHandler$DelegatingChannelHandlerContext.fireChannelRead(CombinedChannelDuplexHandler.java:438) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.handler.codec.ByteToMessageDecoder.fireChannelRead(ByteToMessageDecoder.java:310) [netty-codec-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.handler.codec.ByteToMessageDecoder.fireChannelRead(ByteToMessageDecoder.java:297) [netty-codec-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.handler.codec.ByteToMessageDecoder.callDecode(ByteToMessageDecoder.java:413) [netty-codec-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.handler.codec.ByteToMessageDecoder.channelRead(ByteToMessageDecoder.java:265) [netty-codec-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.CombinedChannelDuplexHandler.channelRead(CombinedChannelDuplexHandler.java:253) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:362) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:348) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.fireChannelRead(AbstractChannelHandlerContext.java:340) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.DefaultChannelPipeline$HeadContext.channelRead(DefaultChannelPipeline.java:1434) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:362) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.AbstractChannelHandlerContext.invokeChannelRead(AbstractChannelHandlerContext.java:348) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.DefaultChannelPipeline.fireChannelRead(DefaultChannelPipeline.java:965) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.nio.AbstractNioByteChannel$NioByteUnsafe.read(AbstractNioByteChannel.java:163) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.nio.NioEventLoop.processSelectedKey(NioEventLoop.java:628) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.nio.NioEventLoop.processSelectedKeysOptimized(NioEventLoop.java:563) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.nio.NioEventLoop.processSelectedKeys(NioEventLoop.java:480) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:442) [netty-transport-4.1.29.Final.jar:4.1.29.Final]
    	at io.netty.util.concurrent.SingleThreadEventExecutor$5.run(SingleThreadEventExecutor.java:884) [netty-common-4.1.29.Final.jar:4.1.29.Final]
    	at java.lang.Thread.run(Thread.java:745) [na:1.8.0_51]
    
    产生原因:是因为spring-security引起的冲突。
    解决办法:
    将pom文件的如下依赖注释：
    
                
                
            
            
    注释SecuritySecureConfig配置类。
    配置文件中将:
    #  security:
    #    user:
    #      name: dsj #认证账户
    #      password: 123456 #认证密码
    注释掉，需要认证可以自己写认证接口，具体还在研究中.