【SpringBoot】Spring Boot Admin 微服務應用監控

本文轉載自查看原文 2020-06-06 00:17 556 Java/ SpringBoot/ Spring

一、什么是Spring Boot Admin？

　　Spring Boot Admin是一個開源社區項目，用於管理和監控SpringBoot應用程序。應用程序作為Spring Boot Admin Client向為Spring Boot Admin Server注冊（通過HTTP）或使用SpringCloud注冊中心（例如Eureka，Consul）發現。 UI是的Vue.js應用程序，展示Spring Boot Admin Client的Actuator端點上的一些監控。服務端采用Spring WebFlux + Netty的方式。

　　Spring Boot Admin為注冊的應用程序提供以下功能：

顯示健康狀況
顯示詳細信息，例如
JVM和內存指標
micrometer.io指標
數據源指標
緩存指標
顯示構建信息編號
關注並下載日志文件
查看jvm system-和environment-properties
查看Spring Boot配置屬性
支持Spring Cloud的postable / env-和/ refresh-endpoint
輕松的日志級管理
與JMX-beans交互
查看線程轉儲
查看http-traces
查看auditevents
查看http-endpoints
查看計划任務
查看和刪除活動會話（使用spring-session）
查看Flyway / Liquibase數據庫遷移
下載heapdump
狀態變更通知（通過電子郵件，Slack，Hipchat，......）
狀態更改的事件日志（非持久性）

二、入門

1. 創建 Spring Boot Admin Server

　　這里我們創建一個admin-server模塊來作為監控中心演示其功能。

　　1.1、新建一個SpringBoot項目，

　　1.2、引入spring-boot-admin-server依賴

 1 <!-- spring-boot-admin -->
 2 <dependency>
 3     <groupId>de.codecentric</groupId>
 4     <artifactId>spring-boot-admin-starter-server</artifactId>
 5     <version>2.2.3</version>
 6 </dependency>
 7 
 8 <dependency>
 9     <groupId>org.springframework.boot</groupId>
10     <artifactId>spring-boot-starter-web</artifactId>
11 </dependency>

　　　　完整pom如下：

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <project xmlns="http://maven.apache.org/POM/4.0.0"
 3          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5     <modelVersion>4.0.0</modelVersion>
 6 
 7     <groupId>org.example</groupId>
 8     <artifactId>test-springboot-admin-server</artifactId>
 9     <version>1.0-SNAPSHOT</version>
10 
11     <parent>
12         <groupId>org.springframework.boot</groupId>
13         <artifactId>spring-boot-starter-parent</artifactId>
14         <version>2.2.5.RELEASE</version>
15     </parent>
16 
17     <properties>
18         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
19         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
20         <java.version>1.8</java.version>
21     </properties>
22 
23     <dependencies>
24 
25         <!-- spring-boot-admin -->
26         <dependency>
27             <groupId>de.codecentric</groupId>
28             <artifactId>spring-boot-admin-starter-server</artifactId>
29             <version>2.2.3</version>
30         </dependency>
31 
32         <dependency>
33             <groupId>org.springframework.boot</groupId>
34             <artifactId>spring-boot-starter-web</artifactId>
35         </dependency>
36 
37         <dependency>
38             <groupId>org.springframework.boot</groupId>
39             <artifactId>spring-boot-starter-test</artifactId>
40             <scope>test</scope>
41         </dependency>
42 
43     </dependencies>
44 
45 
46     <!-- SpringBoot打包插件，可以將代碼打包成一個可執行的jar包 -->
47     <build>
48         <plugins>
49             <plugin>
50                 <groupId>org.springframework.boot</groupId>
51                 <artifactId>spring-boot-maven-plugin</artifactId>
52             </plugin>
53         </plugins>
54     </build>
55 </project>

View Code

　　1.3、編輯配置文件application.yml

1 spring:
2   application:
3     name: admin-server
4 server:
5   port: 9301

　　1.4、編輯啟動類

1 @EnableAdminServer
2 @SpringBootApplication
3 public class Application {
4     public static void main(String[] args) {
5         SpringApplication.run(Application.class, args);
6     }
7 }

　　1.5、啟動項目，訪問地址：http://localhost:9301/

2. 創建 Spring Boot Admin Server

　　2.1、新建一個SpringBoot項目，

　　2.2、引入spring-boot-admin-client依賴

 1 <!-- spring-boot-admin -->
 2 <dependency>
 3     <groupId>de.codecentric</groupId>
 4     <artifactId>spring-boot-admin-starter-client</artifactId>
 5     <version>2.2.3</version>
 6 </dependency>
 7 
 8 <dependency>
 9     <groupId>org.springframework.boot</groupId>
10     <artifactId>spring-boot-starter-web</artifactId>
11 </dependency>

　　　　完整pom如下：

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <project xmlns="http://maven.apache.org/POM/4.0.0"
 3          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5     <modelVersion>4.0.0</modelVersion>
 6 
 7     <groupId>org.example</groupId>
 8     <artifactId>test-springboot-admin-client</artifactId>
 9     <version>1.0-SNAPSHOT</version>
10     <parent>
11         <groupId>org.springframework.boot</groupId>
12         <artifactId>spring-boot-starter-parent</artifactId>
13         <version>2.2.5.RELEASE</version>
14     </parent>
15 
16     <properties>
17 
18         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
19         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
20         <java.version>1.8</java.version>
21     </properties>
22 
23     <dependencies>
24 
25         <!-- spring-boot-admin -->
26         <dependency>
27             <groupId>de.codecentric</groupId>
28             <artifactId>spring-boot-admin-starter-client</artifactId>
29             <version>2.2.3</version>
30         </dependency>
31 
32         <dependency>
33             <groupId>org.springframework.boot</groupId>
34             <artifactId>spring-boot-starter-web</artifactId>
35         </dependency>
36 
37         <dependency>
38             <groupId>org.springframework.boot</groupId>
39             <artifactId>spring-boot-starter-actuator</artifactId>
40         </dependency>
41 
42         <dependency>
43             <groupId>org.springframework.boot</groupId>
44             <artifactId>spring-boot-starter-test</artifactId>
45             <scope>test</scope>
46         </dependency>
47 
48     </dependencies>
49 
50 
51     <!-- SpringBoot打包插件，可以將代碼打包成一個可執行的jar包 -->
52     <build>
53         <plugins>
54             <plugin>
55                 <groupId>org.springframework.boot</groupId>
56                 <artifactId>spring-boot-maven-plugin</artifactId>
57             </plugin>
58         </plugins>
59     </build>
60 
61 </project>

View Code

　　2.3、編輯配置文件application.yml

 1 spring:
 2   application:
 3     name: admin-client
 4   boot:
 5     admin:
 6       client:
 7         url: http://localhost:9301 #配置admin-server地址
 8 server:
 9   port: 9305
10 management:
11   endpoints:
12     web:
13       exposure:
14         include: '*'
15   endpoint:
16     health:
17       show-details: always
18 logging:
19   file: admin-client.log  #添加開啟admin的日志監控

　　2.4、編輯啟動類

1 @SpringBootApplication
2 public class Application {
3     public static void main(String[] args) {
4         SpringApplication.run(Application.class, args);
5     }
6 }

　　2.5、啟動項目，繼續訪問admin-server的Web地址：http://localhost:9301/

監控信息演示

訪問如下地址打開Spring Boot Admin的主頁：http://localhost:9301（同上）
選中admin-client客戶端查看，監控信息概覽
度量指標信息，比如JVM、Tomcat及進程信息；
環境變量信息，比如系統屬性、系統環境變量以及應用配置信息；
查看所有創建的Bean信息；
查看應用中的所有配置信息；

查看日志信息，需要添加以下配置才能開啟；

1 logging:
2   file: admin-client.log  #添加開啟admin的日志監控

查看JVM信息；
查看可以訪問的Web端點；

一、集成 Eureka

　　1、創建Eureka服務，參考：【SpringCloud】快速入門（一）

　　2、修改admin-server

　　　　在pom.xml中添加相關依賴：

1 <dependency>
2     <groupId>org.springframework.cloud</groupId>
3     <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
4 </dependency>

　　　　在application-eureka.yml中進行配置，只需添加注冊中心配置即可：

 1 spring:
 2   application:
 3     name: admin-server
 4 server:
 5   port: 9301
 6 eureka:
 7   client:
 8     register-with-eureka: true
 9     fetch-registry: true
10     service-url:
11       defaultZone: http://localhost:8761/eureka/

　　　　在啟動類上添加@EnableDiscoveryClient來啟用服務注冊功能：

1 @EnableDiscoveryClient
2 @EnableAdminServer
3 @SpringBootApplication
4 public class Application {
5     public static void main(String[] args) {
6         SpringApplication.run(Application.class, args);
7     }
8 }

　　3、修改admin-client，

　　　　在pom.xml中添加相關依賴：同上

　　　　在application-eureka.yml中進行配置，只需添加注冊中心配置即可，且去掉配置spring.boot.admin.client.url屬性

 1 spring:
 2   application:
 3     name: admin-client
 4 #  boot:
 5 #    admin:
 6 #      client:
 7 #        url: http://localhost:9301 #配置admin-server地址
 8 server:
 9   port: 9305
10 management:
11   endpoints:
12     web:
13       exposure:
14         include: '*'
15   endpoint:
16     health:
17       show-details: always
18 
19 eureka:
20   client:
21     register-with-eureka: true
22     fetch-registry: true
23     service-url:
24       defaultZone: http://localhost:8761/eureka/
25 
26 logging:
27   file: admin-client.log  #添加開啟admin的日志監控

　　　　在啟動類上添加@EnableDiscoveryClient來啟用服務注冊功能：

1 @EnableDiscoveryClient
2 @SpringBootApplication
3 public class Application {
4     public static void main(String[] args) {
5         SpringApplication.run(Application.class, args);
6     }
7 }

　　4、功能演示

　　　　啟動Eureka注冊中心，啟動admin-server、admin-client

　　　　1）查看注冊中心發現服務均已注冊：http://localhost:8761

　　　　2）查看Spring Boot Admin 主頁發現可以看到服務信息：http://localhost:9301

四、集成 Spring Security

　　這里我們創建一個admin-server模塊來與Spring Security集成

　　1、新建一個SpringBoot項目

　　2、pom引入Spring Security依賴

　　　　完整pom如下：

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <project xmlns="http://maven.apache.org/POM/4.0.0"
 3          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5     <modelVersion>4.0.0</modelVersion>
 6 
 7     <groupId>org.example</groupId>
 8     <artifactId>test-springboot-admin-sc-server</artifactId>
 9     <version>1.0-SNAPSHOT</version>
10 
11     <parent>
12         <groupId>org.springframework.boot</groupId>
13         <artifactId>spring-boot-starter-parent</artifactId>
14         <version>2.2.5.RELEASE</version>
15     </parent>
16 
17     <properties>
18         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
19         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
20         <java.version>1.8</java.version>
21     </properties>
22 
23     <dependencies>
24 
25         <dependency>
26             <groupId>org.springframework.boot</groupId>
27             <artifactId>spring-boot-starter-security</artifactId>
28         </dependency>
29 
30         <dependency>
31             <groupId>org.springframework.cloud</groupId>
32             <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
33             <version>2.2.2.RELEASE</version>
34         </dependency>
35 
36         <!-- spring-boot-admin -->
37         <dependency>
38             <groupId>de.codecentric</groupId>
39             <artifactId>spring-boot-admin-starter-server</artifactId>
40             <version>2.2.3</version>
41         </dependency>
42 
43         <dependency>
44             <groupId>org.springframework.boot</groupId>
45             <artifactId>spring-boot-starter-web</artifactId>
46         </dependency>
47 
48         <dependency>
49             <groupId>org.springframework.boot</groupId>
50             <artifactId>spring-boot-starter-test</artifactId>
51             <scope>test</scope>
52         </dependency>
53 
54     </dependencies>
55 
56 
57     <!-- SpringBoot打包插件，可以將代碼打包成一個可執行的jar包 -->
58     <build>
59         <plugins>
60             <plugin>
61                 <groupId>org.springframework.boot</groupId>
62                 <artifactId>spring-boot-maven-plugin</artifactId>
63             </plugin>
64         </plugins>
65     </build>
66 
67 </project>

View Code

　　3、編輯配置文件application.yml

 1 spring:
 2   application:
 3     name: admin-security-server
 4   security: # 配置登錄用戶名和密碼
 5     user:
 6       name: admin
 7       password: 123456
 8   boot:  # 不顯示admin-security-server的監控信息
 9     admin:
10       discovery:
11         ignored-services: ${spring.application.name}
12 
13 server:
14   port: 9302
15 
16 eureka:
17   client:
18     register-with-eureka: true
19     fetch-registry: true
20     service-url:
21       defaultZone: http://localhost:8761/eureka/

　　4、編輯主啟動類

1 @EnableDiscoveryClient
2 @EnableAdminServer
3 @SpringBootApplication
4 public class Application {
5     public static void main(String[] args) {
6         SpringApplication.run(Application.class, args);
7     }
8 }

　　5、編輯配置類

 1 @Configuration
 2 public class SecuritySecureConfig extends WebSecurityConfigurerAdapter {
 3     private final String adminContextPath;
 4 
 5     public SecuritySecureConfig(AdminServerProperties adminServerProperties) {
 6         this.adminContextPath = adminServerProperties.getContextPath();
 7     }
 8 
 9     @Override
10     protected void configure(HttpSecurity http) throws Exception {
11         SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
12         successHandler.setTargetUrlParameter("redirectTo");
13         successHandler.setDefaultTargetUrl(adminContextPath + "/");
14 
15         http.authorizeRequests()
16                 //1.配置所有靜態資源和登錄頁可以公開訪問
17                 .antMatchers(adminContextPath + "/assets/**").permitAll()
18                 .antMatchers(adminContextPath + "/login").permitAll()
19                 .anyRequest().authenticated()
20                 .and()
21                 //2.配置登錄和登出路徑
22                 .formLogin().loginPage(adminContextPath + "/login").successHandler(successHandler).and()
23                 .logout().logoutUrl(adminContextPath + "/logout").and()
24                 //3.開啟http basic支持，admin-client注冊時需要使用
25                 .httpBasic().and()
26                 .csrf()
27                 //4.開啟基於cookie的csrf保護
28                 .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
29                 //5.忽略這些路徑的csrf保護以便admin-client注冊
30                 .ignoringAntMatchers(
31                         adminContextPath + "/instances",
32                         adminContextPath + "/actuator/**"
33                 );
34     }
35 }

　　6、測試

　　　　1）啟動Eureka注冊中心，啟動admin-server、admin-client、admin-security-server

　　　　2）訪問admin-security-server地址：http://localhost:9302/

　　　　3）輸入用戶名/密碼（admin/123456）訪問，效果如下：

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 Spring Boot Admin對Springboot服務進行監控 spring cloud微服務快速教程之（六）應用監控 spring boot admin spring boot 2.0.3+spring cloud （Finchley）8、微服務監控Spring Boot Admin 微服務架構之spring boot admin Springboot度量指標監控與健康檢查和可視化監控應用Spring Boot Admin Spring Boot2.0之Admin-UI分布式微服務監控中心物聯網架構成長之路(30)-Spring Boot Admin微服務WebUI監控微服務：整合 Spring Boot Admin - 釘釘預警微服務：整合 Spring Boot Admin - 客戶端搭建微服務：整合 Spring Boot Admin - 開啟Security安全認證