SpringBoot 09 集成Spring Boot Admin实现监控

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

1.Spring Boot Admin能做什么

查看github 上官方描述信息  链接：GitHub Spring boot Admin

• Show health status  （显示健康状态）
• Show details, like （显示详细信息）
  • JVM & memory metrics （JVM和内存指标）
  • micrometer.io metrics （micrometer.io指标）
  • Datasource metrics （数据源指标）
  • Cache metrics （缓存指标）
• Show build-info number （显示构建信息编号）
• Follow and download logfile （下载日志文件）
• View jvm system- & environment-properties （查看JVM和环境属性）
• View Spring Boot Configuration Properties （查看SpringBoot属性）
• Support for Spring Cloud's postable /env- &/refresh-endpoint （支持SpirngCloud）
• Easy loglevel management （轻松的日志管理）
• Interact with JMX-beans （支持JMX-bean 交互）
• View thread dump （查看线程转储视图）
• View http-traces （http跟踪视图）
• View auditevents （审核事件视图）
• View http-endpoints （http端点视图）
• View scheduled tasks （计划任务视图）
• View and delete active sessions ( spring-session 视图)
• View Flyway / Liquibase database migrations （ Flay/Liquibase 迁移信息视图）
• Download heapdump （下载heapdump ）
• Notification on status change (via e-mail, Slack, Hipchat, ...)  （状态变更通知）
• Event journal of status changes (non persistent) （状态变更的事件日志）

2.Spring Boot Adimin如何使用

2.1使用示例

Demo参考信息：

• spring boot 版本：2.6.2
• spring boot admin版本：2.6.0

1. 创建一个Spring boot项目，项目充当 Admin服务器端

向pom依赖中添加依赖spring-boot-starter-web、spring-boot-admin-server、spring-boot-admin-server-ui ，其中spring-boot-admin-server-ui封装了一个Web应用程序，可以通过web页面查看监控信息

<?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 https://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.6.2</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.boot</groupId>
    <artifactId>demo-actuator</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo-actuator</name>
    <description>Spring Boot + Actuator Admin</description>
    <properties>
        <java.version>11</java.version>
    </properties>
    <dependencies>
        <!-- WEB应用 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- 开启监控Actuator-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- 引入Spring Boot Admin-->
        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-server</artifactId>
            <version>2.6.0</version>
        </dependency>
        <!-- 引入Spring Boot Admin SERVICE UI 封装了一个Web应用程序-->
        <dependency>
            <groupId>de.codecentric</groupId>
            <artifactId>spring-boot-admin-server-ui</artifactId>
            <version>2.6.0</version>
        </dependency>
        <!-- ENE 引入Spring Boot Admin-->
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2.创建启动主类，使用@EnableAdminServer开启Admin 监控

import de.codecentric.boot.admin.server.config.EnableAdminServer;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;

@EnableAdminServer  //开启Admin监控
@SpringBootApplication(scanBasePackages = {"com.boot.actuator"})
public class AdminApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(AdminApplication.class).run(args);
    }
}

 @EnableAdminServer注解通过@Import导入配置类AdminServerMarkerConfiguration，对象中定义了一个静态内部类Marker并将它声明为bean

自动配置类AdminServerAutoConfiguration对象中

通过注解@ConditionalOnBean(AdminServerMarkerConfiguration.Marker.class)实现了自动配置@ConditionalOnBean作用就是当容器中存在此类型组件，就进行组件注入

通过注解@ImportAutoConfiguration 导入了 AdminServerWebConfiguration和

AdminServerInstanceWebClientConfiguration加载Web应用

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({AdminServerMarkerConfiguration.class})
public @interface EnableAdminServer {

}

@Configuration(proxyBeanMethods = false)
@Conditional(SpringBootAdminServerEnabledCondition.class)
@ConditionalOnBean(AdminServerMarkerConfiguration.Marker.class)
@EnableConfigurationProperties(AdminServerProperties.class)
@ImportAutoConfiguration({ AdminServerInstanceWebClientConfiguration.class, AdminServerWebConfiguration.class })
@AutoConfigureAfter({ WebClientAutoConfiguration.class })
@Lazy(false)
public class AdminServerAutoConfiguration {

}

  Springboot Admin Server配置项信息如下

3. 创建spring boot项目， 用于当做Spring boot Admin Client，并在依赖中增加依赖spring boot admin客户端依赖。

    <dependency>
        <groupId>de.codecentric</groupId>
        <artifactId>spring-boot-admin-starter-client</artifactId>
        <version>2.6.0</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

4. application.properties增加配置，显示所有端点并设置要注册的 admin server访问url

默认情况下，大多数端点并不公开，* 公开了所有的端点,对于生产需要考虑公开的端点
management.endpoints.web.exposure.include=*

#要注册的Spring Boot管理服务器的URL
spring.boot.admin.client.url=http://localhost:7001

#要注册的服务的名称
spring.boot.admin.client.instance.name=Redis Server

 Springboot Admin Client 配置选项信息如下

5.启动两个项目，

访问 http://localhost:7001/applications  其中7001是Admin服务器端的端口号，参考信息如下

2.2参考源码

链接：Demo源码信息

2.3常见问题

1.找不到方法ManagementServerProperties.getBasePath()Ljava/lang/String

java.lang.NoSuchMethodError: org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties.getBasePath()Ljava/lang/String;
	at de.codecentric.boot.admin.client.registration.ServletApplicationFactory.getManagementContextPath(ServletApplicationFactory.java:86) ~[spring-boot-admin-client-2.6.0.jar:2.6.0]
	at de.codecentric.boot.admin.client.registration.ServletApplicationFactory.getManagementBaseUrl(ServletApplicationFactory.java:77) ~[spring-boot-admin-client-2.6.0.jar:2.6.0]
	at de.codecentric.boot.admin.client.registration.DefaultApplicationFactory.getHealthUrl(DefaultApplicationFactory.java:154) ~[spring-boot-admin-client-2.6.0.jar:2.6.0]

处理方式：Spring Boot 的版本和Spring Boot Adim的版本不匹配， 

见：找不到方法:ManagementServerProperties.getBasePath()Ljava/lang/String

前一篇：SpringBoot 08 集成swagger2简化API开发及问题