SpringBoot-Admin的使用

vslam 發(fā)布于2019-08-19 10:28 / 3097人閱讀

摘要：端項目依賴添加是為了使應(yīng)用處于啟動狀態(tài)，會自動添加相關(guān)依賴。接下來以作為服務(wù)發(fā)現(xiàn)的示例來進行演示，實際上也可以使用或者。最后是一個用方式監(jiān)聽的使用連接端

【前情提要】Spring Boot Actuator 提供了對單個 Spring Boot 應(yīng)用的監(jiān)控，信息包含應(yīng)用狀態(tài)、內(nèi)存、線程、堆棧等，比較全面的監(jiān)控了 Spring Boot 應(yīng)用的整個生命周期。但是這樣監(jiān)控也有一些問題：第一，所有的監(jiān)控都需要調(diào)用固定的接口來查看，如果全面查看應(yīng)用狀態(tài)需要調(diào)用很多接口，并且接口返回的 JSON 信息不方便運營人員理解；第二，如果 Spring Boot 應(yīng)用集群非常大，每個應(yīng)用都需要調(diào)用不同的接口來查看監(jiān)控信息，操作非常繁瑣低效。在這樣的背景下，就誕生了另外一個開源軟件：Spring Boot Admin。

壹、什么是Spring Boot Admin

Spring Boot Admin 是一個管理和監(jiān)控 Spring Boot 應(yīng)用程序的開源軟件，每個應(yīng)用都認為是一個客戶端，通過 HTTP 或者使用 Eureka 注冊到 admin server 中進行展示，Spring Boot Admin UI 部分使用 Vue.js 將數(shù)據(jù)展示在前端。

Spring Boot Admin 是一個針對 Spring Boot 的 Actuator 接口進行 UI 美化封裝的監(jiān)控工具，它可以在列表中瀏覽所有被監(jiān)控 spring-boot 項目的基本信息、詳細的 Health 信息、內(nèi)存信息、JVM 信息、垃圾回收信息、各種配置信息（比如數(shù)據(jù)源、緩存列表和命中率）等，還可以直接修改 logger 的 level。

值得注意的是 Spring Boot Admin 并不是 Spring Boot 官方出品的開源軟件，但是其軟件質(zhì)量和使用廣泛度都非常的高，并且 Spring Boot Admin 會及時隨著 Spring Boot 的更新而更新，當 Spring Boot 推出 2.X 版本時 Spring Boot Admin 也及時進行了更新。

Spring Boot Admin 2.x 不僅是跟著支持了 Spring Boot 2.x，還在 1.x 的基礎(chǔ)上進行了大量的更新和優(yōu)化:

重新規(guī)劃了項目依賴包，讓項目中更方便的集成 Spring Boot Admin
1.x 前端使用了 Angular.js，2.x 使用 Vue 對界面進行了重寫，界面美觀度提升幅度非常高
提供了支持 Spring Cloud 的組件
其他更新，具體參考：Changes with 2.x

Spring Boot Admin 分為服務(wù)端和客戶端，服務(wù)端其實就是一個監(jiān)控后臺用來匯總展示所有的監(jiān)控信息，客戶端就是我們的應(yīng)用，使用時需要先啟動服務(wù)端，在啟動客戶端的時候打開 Actuator 的接口，并指向服務(wù)端的地址，這樣服務(wù)端會定時讀取相關(guān)信息以達到監(jiān)控的目的。

接下來演示如何使用 Spring Boot Admin 對 Spring Boot 應(yīng)用進行監(jiān)控。

貳、監(jiān)控單體應(yīng)用

先給大家展示如何使用 Spring Boot Admin 監(jiān)控單個 Spring Boot 應(yīng)用。

Admin Server 端 項目依賴


  de.codecentric
  spring-boot-admin-starter-server
  2.1.0


  org.springframework.boot
  spring-boot-starter-web

2.x 下只需要添加此一個包即可，其他組件會自動依賴添加。

配置文件

server.port=8000

服務(wù)端設(shè)置端口為：8000。

啟動類

@EnableAdminServer
@SpringBootApplication
public class AdminServerApplication {

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

完成上面三步之后，啟動服務(wù)端，訪問網(wǎng)址 http://localhost:8000 可以看到以下界面：

因為剛啟動沒有應(yīng)用，因此顯示：No applications registered.，同時根據(jù)上圖也可以看出 applications 頁面會展示項目的應(yīng)用數(shù)、實例數(shù)和狀態(tài)三個信息。

接下來我們構(gòu)建一個客戶端，并注冊到服務(wù)端。

Admin Client 端 項目依賴


  
    de.codecentric
    spring-boot-admin-starter-client
    2.1.0
  
  
    org.springframework.boot
    spring-boot-starter-web

添加 spring-boot-starter-web 是為了使應(yīng)用處于啟動狀態(tài)，spring-boot-admin-starter-client 會自動添加 Actuator 相關(guān)依賴。

配置文件

server.port=8001
spring.application.name=Admin Client
spring.boot.admin.client.url=http://localhost:8000  
management.endpoints.web.exposure.include=*

spring.boot.admin.client.url 配置 Admin Server 的地址
management.endpoints.web.exposure.include=* 打開客戶端 Actuator 的監(jiān)控

啟動類

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

配置完成之后，啟動 Client 端，Admin 服務(wù)端會自動檢查到客戶端的變化，并展示其應(yīng)用：

頁面會展示被監(jiān)控的服務(wù)列表，點擊項目名稱會進入此應(yīng)用的詳細監(jiān)控信息：

通過上圖可以看出，Spring Boot Admin 以圖形化的形式展示了應(yīng)用的各項信息，這些信息大多都來自于 Spring Boot Actuator 提供的接口。利用圖形化的形式很容易看到應(yīng)用的各項參數(shù)變化，甚至有些頁面還可以進行一些操作，比如改變打印日志的級別等。

點擊 journal 頁面可以看到應(yīng)用狀態(tài)變化的歷史過程：

點擊第一個菜單 wallboard 可以以更形象的方式查看應(yīng)用數(shù)量啟動的時間等。

叁、監(jiān)控微服務(wù)

如果我們使用的是單個 Spring Boot 應(yīng)用，就需要在每一個被監(jiān)控的應(yīng)用中配置 Admin Server 的地址信息；如果應(yīng)用都注冊在 Eureka 中就不需要再對每個應(yīng)用進行配置，Spring Boot Admin 會自動從注冊中心抓取應(yīng)用的相關(guān)信息。

如果使用了 Spring Cloud 的服務(wù)發(fā)現(xiàn)功能，就不需要再多帶帶添加 Admin Client 客戶端，僅僅需要 Spring Boot Server，其他內(nèi)容會自動進行配置。

接下來以 Eureka 作為服務(wù)發(fā)現(xiàn)的示例來進行演示，實際上也可以使用 Consul 或者 Zookeeper。

（1）服務(wù)端和客戶端添加 spring-cloud-starter-eureka 到包依賴中


    org.springframework.cloud
    spring-cloud-starter-netflix-eureka-client

（2）啟動類添加注解

@Configuration
@EnableAutoConfiguration
@EnableDiscoveryClient
@EnableAdminServer
public class SpringBootAdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootAdminApplication.class, args);
    }

    @Configuration
    public static class SecurityPermitAllConfig extends WebSecurityConfigurerAdapter {
        @Override
        protected void configure(HttpSecurity http) throws Exception {
            http.authorizeRequests().anyRequest().permitAll()  
                .and().csrf().disable();
        }
    }
}

使用類 SecurityPermitAllConfig 關(guān)閉了安全驗證。

（3）在客戶端中配置服務(wù)發(fā)現(xiàn)的地址

eureka:   
  instance:
    leaseRenewalIntervalInSeconds: 10
    health-check-url-path: /actuator/health
    metadata-map:
      startup: ${random.int}    #needed to trigger info and endpoint update after restart
  client:
    registryFetchIntervalSeconds: 5
    serviceUrl:
      defaultZone: ${EUREKA_SERVICE_URL:http://localhost:8761}/eureka/

management:
  endpoints:
    web:
      exposure:
        include: "*"  
  endpoint:
    health:
      show-details: ALWAYS

Spring Cloud 提供了示例代碼可以參考這里：spring-boot-admin-sample-eureka。

重啟啟動服務(wù)端和客戶端之后，訪問服務(wù)端的相關(guān)地址就可以看到監(jiān)控頁面了。

肆、安全控制

Spring Boot Admin 后臺有很多的敏感信息和操作，如果公司不做權(quán)限控制可能會影響到公司系統(tǒng)的安全性。Spring Boot Admin 也考慮到了這個因素，可以利用前面的 Spring Security 做安全訪問控制，在 spring-boot-admin-server 上進行改造。

（1）添加 Spring Boot Security 依賴包


    org.springframework.boot
    spring-boot-starter-security

（2）添加安全訪問控制

和前面的 Security 配置一樣，給項目添加訪問控制。

@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 {
        // @formatter:off
        SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler();
        successHandler.setTargetUrlParameter("redirectTo");
        successHandler.setDefaultTargetUrl(adminContextPath + "/");

        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()
            .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())  
            .ignoringAntMatchers(
                adminContextPath + "/instances",   
                adminContextPath + "/actuator/**"  
            );
    }
}

    antMatchers(adminContextPath + "/assets/**").permitAll() 所有靜態(tài)內(nèi)容不做安全驗證
    anyRequest().authenticated() 其他請求均需要驗證
    formLogin() 配置登錄
    logout() 配置登出
    httpBasic() 支持 HTTP，引導(dǎo) Spring Boot Admin 客戶端注冊
    csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()) 打開跨站點請求保護 Cookies
    adminContextPath + "/instances" 取消跨站點請求保護 "/instances"，方便 Admin 客戶端注冊
    adminContextPath + "/actuator/** " 取消跨站點請求保護 "/actuator/**"，可以讓 Admin 監(jiān)控到 Actuator 的相關(guān)接口

然后可以給 security 設(shè)置一個用戶名和密碼：

spring.security.user.name=admin
spring.security.user.password=admin

配置完成之后重啟 Admin Server 端，訪問網(wǎng)址 http://localhost:8000 就會發(fā)現(xiàn)需要一個登錄的用戶名和密碼了。

使用剛才設(shè)置的用戶名和密碼登錄之后，發(fā)現(xiàn)注冊到 Server 端的服務(wù)數(shù)成為 0 了，這是客戶端統(tǒng)一也需要配置帳戶名和密碼信息。

spring.security.user.name=admin
spring.security.user.password=admin

配置完成之后重新啟動，在服務(wù)端就又可以查看監(jiān)控到的應(yīng)用了。

伍、其他方式

如果 Actuator 的端口被使用 HTTP 認證保護，那么 Spring Boot Admin Server 訪問的時候需要憑證信息，這時候可以使用 metadata 的方式對賬戶和密碼進行配置。

直接使用客戶端注冊的方式：

spring.boot.admin.client:
    url: http://localhost:8080
    instance:
      metadata:
        user.name: ${spring.security.user.name}
        user.password: ${spring.security.user.password}

使用 Eureka 進行注冊的方式：

eureka:
  instance:
    metadata-map:
      user.name: ${spring.security.user.name}
      user.password: ${spring.security.user.password}

Eureka 中的 metadataMap 是專門用來存放一些自定義的數(shù)據(jù)，當注冊中心或者其他服務(wù)需要此服務(wù)的某些配置時可以在 metadataMap 里取。實際上，每個 instance 都有各自的 metadataMap，map 中存放著需要用到的屬性。例如，上面配置中的 eureka.instance.metadata-map.user.name，當這個服務(wù)成功注冊到 Eureka 上，Spring Boot Admin 就會拿到這個 instance，進而拿到 metadataMap 里的屬性，然后放入請求頭，向此服務(wù)發(fā)送請求，訪問此服務(wù)的 Actuator 開放的端點。

陸、郵件告警

Spring Boot Admin 將微服務(wù)中所有應(yīng)用信息在后臺進行了展示，非常方便我們對微服務(wù)整體的監(jiān)控和治理。但是我們的運營人員也不可能一天 24 小時盯著監(jiān)控后臺，因此如果服務(wù)有異常的時候，有對應(yīng)的郵件告警就太好了，其實 Spring Boot Admin 也給出了支持。

我們對上面的示例項目 spring-boot-admin-server 進行改造。

添加依賴


  org.springframework.boot
  spring-boot-starter-mail

增加了郵件發(fā)送的 starter 包。 配置文件

spring.mail.host=smtp.qq.com
[email protected]
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
[email protected]
[email protected]

在配置文件中添加郵件發(fā)送相關(guān)信息：郵件的發(fā)送者、接受者、協(xié)議、移動授權(quán)碼等。

配置完成后，重新啟動項目 spring-boot-admin-server，這樣 Admin Server 就具備了郵件告警的功能，默認情況下 Admin Server 對 Eureka 中的服務(wù)上下線都進行了監(jiān)控，當服務(wù)上下線的時候我們就會收到相應(yīng)的告警郵件。

當然這只是最基本的郵件監(jiān)控，在實際的使用過程中，需要根據(jù)情況對郵件告警內(nèi)容進行自定義，比如監(jiān)控堆內(nèi)存的使用情況，當?shù)竭_一定比例的時候進行告警等。

【寫在后面的話】Spring Boot Admin 解決了我們對大規(guī)模 Spring Boot 應(yīng)用監(jiān)控的需求，Spring Boot Admin 充分利用了 Actuator 開放的相關(guān)接口，采用優(yōu)秀的圖形界面將這些信息進行了展示，方便我們更加直觀的查看集群中應(yīng)用的狀態(tài)。Spring Boot Admin 不僅可以監(jiān)控單個 Spring Boot 應(yīng)用，也可以結(jié)合 Spring Cloud 監(jiān)控注冊到服務(wù)中心的所有應(yīng)用狀態(tài)，再結(jié)合報警系統(tǒng)的使用就可以隨時感知到應(yīng)用的狀態(tài)變化。在實際工作中 Spring Boot Admin 是我們在后期運營中頻繁用到的一個組件，應(yīng)該作為重點關(guān)注。

最后是一個用http方式監(jiān)聽的demo：Spring Boot Admin使用http連接server端

云服務(wù)器 GPU云服務(wù)器數(shù)組的使用字典的使用控件的使用游標的使用

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/76087.html

發(fā)表評論

登陸后可評論

0條評論

vslam

男|高級講師

我要關(guān)注我要私信

TA的文章

olink cloud：德國/圣何塞AS9929線路VPS全場8折優(yōu)惠，服務(wù)器6折優(yōu)惠，$4/月起

閱讀 1314·2021-11-04 16:09
DMIT，中國香港cn2 gia vps/lite版大帶寬vps整理分享，月付$6.9起！

閱讀 3516·2021-10-19 11:45
貨運巨頭Forward Air報告勒索軟件數(shù)據(jù)泄露損失金額達750萬美元

閱讀 2408·2021-10-11 10:59
手撕C語言進階---字符串和內(nèi)存函數(shù)(詳解+實現(xiàn)+原碼)

閱讀 1022·2021-09-23 11:21
ssl證書有哪些種類?如何選擇SSL證書?

閱讀 2774·2021-09-22 10:54
SVG圖片文件轉(zhuǎn)換成Inline Code 的非完美解決方案

閱讀 1149·2019-08-30 15:53
前端資源分享-只為更好前端

閱讀 2618·2019-08-30 15:53
CSS的低權(quán)重原則—避免濫用子選擇器

閱讀 3490·2019-08-30 12:57

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

SpringBoot-Admin的使用

相關(guān)文章

基于SpringCloud FinchleySR1 SpringBoot 2x vue elemen

Spring 指南（目錄）

不得不提的前端性能優(yōu)化

MongoDB指南---12、使用explain()和hint()、何時不應(yīng)該使用索引

發(fā)表評論

0條評論

vslam

男|高級講師

TA的文章

olink cloud：德國/圣何塞AS9929線路VPS全場8折優(yōu)惠，服務(wù)器6折優(yōu)惠，$4/月起

DMIT，中國香港cn2 gia vps/lite版大帶寬vps整理分享，月付$6.9起！

貨運巨頭Forward Air報告勒索軟件數(shù)據(jù)泄露損失金額達750萬美元

手撕C語言進階---字符串和內(nèi)存函數(shù)(詳解+實現(xiàn)+原碼)

ssl證書有哪些種類?如何選擇SSL證書?

SVG圖片文件轉(zhuǎn)換成Inline Code 的非完美解決方案

前端資源分享-只為更好前端

CSS的低權(quán)重原則—避免濫用子選擇器

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

SpringBoot-Admin的使用

相關(guān)文章

發(fā)表評論

0條評論

男|高級講師

TA的文章

最新活動

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！