Spring Boot Admin微服務應用監(jiān)控的實現(xiàn)

更新時間：2019年10月31日 10:28:10 作者：MacroZheng

這篇文章主要介紹了Spring Boot Admin微服務應用監(jiān)控，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

Spring Boot Admin 可以對SpringBoot應用的各項指標進行監(jiān)控，可以作為微服務架構(gòu)中的監(jiān)控中心來使用，本文將對其用法進行詳細介紹。

Spring Boot Admin 簡介

SpringBoot應用可以通過Actuator來暴露應用運行過程中的各項指標，Spring Boot Admin通過這些指標來監(jiān)控SpringBoot應用，然后通過圖形化界面呈現(xiàn)出來。Spring Boot Admin不僅可以監(jiān)控單體應用，還可以和Spring Cloud的注冊中心相結(jié)合來監(jiān)控微服務應用。

Spring Boot Admin 可以提供應用的以下監(jiān)控信息：

監(jiān)控應用運行過程中的概覽信息；
度量指標信息，比如JVM、Tomcat及進程信息；
環(huán)境變量信息，比如系統(tǒng)屬性、系統(tǒng)環(huán)境變量以及應用配置信息；
查看所有創(chuàng)建的Bean信息；
查看應用中的所有配置信息；
查看應用運行日志信息；
查看JVM信息；
查看可以訪問的Web端點；
查看HTTP跟蹤信息。

這里我們創(chuàng)建一個admin-server模塊來作為監(jiān)控中心演示其功能。

在pom.xml中添加相關(guān)依賴：

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

在application.yml中進行配置：

spring:
 application:
 name: admin-server
server:
 port: 9301

在啟動類上添加@EnableAdminServer來啟用admin-server功能：

@EnableAdminServer
@SpringBootApplication
public class AdminServerApplication {

 public static void main(String[] args) {
 SpringApplication.run(AdminServerApplication.class, args);
 }

}

創(chuàng)建admin-client模塊

這里我們創(chuàng)建一個admin-client模塊作為客戶端注冊到admin-server。

在pom.xml中添加相關(guān)依賴：

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

在application.yml中進行配置：

spring:
 application:
 name: admin-client
 boot:
 admin:
 client:
 url: http://localhost:9301 #配置admin-server地址
server:
 port: 9305
management:
 endpoints:
 web:
 exposure:
 include: '*'
 endpoint:
 health:
 show-details: always
logging:
 file: admin-client.log #添加開啟admin的日志監(jiān)控

啟動admin-server和admin-client服務。

監(jiān)控信息演示

訪問如下地址打開Spring Boot Admin的主頁： http://localhost:9301

點擊wallboard按鈕，選擇admin-client查看監(jiān)控信息；

監(jiān)控信息概覽；

度量指標信息，比如JVM、Tomcat及進程信息；

環(huán)境變量信息，比如系統(tǒng)屬性、系統(tǒng)環(huán)境變量以及應用配置信息；

查看所有創(chuàng)建的Bean信息；

查看應用中的所有配置信息；

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

logging:
 file: admin-client.log #添加開啟admin的日志監(jiān)控

查看JVM信息；

查看可以訪問的Web端點；

查看HTTP跟蹤信息；

結(jié)合注冊中心使用

Spring Boot Admin結(jié)合Spring Cloud 注冊中心使用，只需將admin-server和注冊中心整合即可，admin-server 會自動從注冊中心獲取服務列表，然后挨個獲取監(jiān)控信息。這里以Eureka注冊中心為例來介紹下該功能。

修改admin-server 在pom.xml中添加相關(guān)依賴：

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

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

spring:
 application:
 name: admin-server
server:
 port: 9301
eureka:
 client:
 register-with-eureka: true
 fetch-registry: true
 service-url:
  defaultZone: http://localhost:8001/eureka/

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

@EnableDiscoveryClient
@EnableAdminServer
@SpringBootApplication
public class AdminServerApplication {

 public static void main(String[] args) {
  SpringApplication.run(AdminServerApplication.class, args);
 }

}

修改admin-client

在pom.xml中添加相關(guān)依賴：

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

在application-eureka.yml中進行配置，刪除原來的admin-server地址配置，添加注冊中心配置即可：

spring:
 application:
 name: admin-client
server:
 port: 9305
management:
 endpoints:
 web:
  exposure:
  include: '*'
 endpoint:
 health:
  show-details: always
logging:
 file: admin-client.log #添加開啟admin的日志監(jiān)控
eureka:
 client:
 register-with-eureka: true
 fetch-registry: true
 service-url:
  defaultZone: http://localhost:8001/eureka/

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

@EnableDiscoveryClient
@SpringBootApplication
public class AdminClientApplication {

 public static void main(String[] args) {
  SpringApplication.run(AdminClientApplication.class, args);
 }

}

功能演示

啟動eureka-server，使用application-eureka.yml配置啟動admin-server，admin-client；

查看注冊中心發(fā)現(xiàn)服務均已注冊： http://localhost:8001/

查看Spring Boot Admin 主頁發(fā)現(xiàn)可以看到服務信息： http://localhost:9301

添加登錄認證

我們可以通過給admin-server添加Spring Security支持來獲得登錄認證功能。

創(chuàng)建admin-security-server模塊

在pom.xml中添加相關(guān)依賴：

<dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
 <groupId>de.codecentric</groupId>
 <artifactId>spring-boot-admin-starter-server</artifactId>
 <version>2.1.5</version>
</dependency>
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-security</artifactId>
</dependency>
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
</dependency>

在application.yml中進行配置，配置登錄用戶名和密碼，忽略admin-security-server的監(jiān)控信息：

spring:
 application:
 name: admin-security-server
 security: # 配置登錄用戶名和密碼
 user:
  name: macro
  password: 123456
 boot: # 不顯示admin-security-server的監(jiān)控信息
 admin:
  discovery:
  ignored-services: ${spring.application.name}
server:
 port: 9301
eureka:
 client:
 register-with-eureka: true
 fetch-registry: true
 service-url:
  defaultZone: http://localhost:8001/eureka/

對SpringSecurity進行配置，以便admin-client可以注冊：

/**
 * Created by macro on 2019/9/30.
 */
@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");
  successHandler.setDefaultTargetUrl(adminContextPath + "/");

  http.authorizeRequests()
    //1.配置所有靜態(tài)資源和登錄頁可以公開訪問
    .antMatchers(adminContextPath + "/assets/**").permitAll()
    .antMatchers(adminContextPath + "/login").permitAll()
    .anyRequest().authenticated()
    .and()
    //2.配置登錄和登出路徑
    .formLogin().loginPage(adminContextPath + "/login").successHandler(successHandler).and()
    .logout().logoutUrl(adminContextPath + "/logout").and()
    //3.開啟http basic支持，admin-client注冊時需要使用
    .httpBasic().and()
    .csrf()
    //4.開啟基于cookie的csrf保護
    .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
    //5.忽略這些路徑的csrf保護以便admin-client注冊
    .ignoringAntMatchers(
      adminContextPath + "/instances",
      adminContextPath + "/actuator/**"
    );
 }
}

修改啟動類，開啟AdminServer及注冊發(fā)現(xiàn)功能：

@EnableDiscoveryClient
@EnableAdminServer
@SpringBootApplication
public class AdminSecurityServerApplication {

 public static void main(String[] args) {
  SpringApplication.run(AdminSecurityServerApplication.class, args);
 }

}

啟動eureka-server，admin-security-server，訪問Spring Boot Admin 主頁發(fā)現(xiàn)需要登錄才能訪問： http://localhost:9301

使用到的模塊

springcloud-learning
├── eureka-server -- eureka注冊中心
├── admin-server -- admin監(jiān)控中心服務
├── admin-client -- admin監(jiān)控中心監(jiān)控的應用服務
└── admin-security-server -- 帶登錄認證的admin監(jiān)控中心服務

項目源碼地址

https://github.com/macrozheng/springcloud-learning

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: