SpringBoot Admin應用監控搭建

簡介

Spring Boot Admin 用於監控基於 Spring Boot 的應用，它是在 Spring Boot Actuator 的基礎上提供簡潔的可視化 WEB UI。

參考手冊地址：http://codecentric.github.io/spring-boot-admin/2.1.1/

Spring Boot Admin 是由服務端Server和客戶端Client組成

• 服務端
• 1.創建一個springboot工程並添加以下依賴

  <dependencies>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
  
       <dependency>
           <groupId>de.codecentric</groupId>
           <artifactId>spring-boot-admin-server</artifactId>
           <version>2.1.1</version>
       </dependency>
  
       <dependency>
           <groupId>de.codecentric</groupId>
           <artifactId>spring-boot-admin-server-ui</artifactId>
           <version>2.1.1</version>
       </dependency>
  
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
  </dependencies>

• 2.重寫權限控制類(非必要)

  @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 + "/monitor");
  
          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/**"
                  );
      }
  }

  @EnableWebSecurity
  public class WebSecurityConfig implements WebMvcConfigurer {
  
      @Bean
      public UserDetailsService userDetailsService() throws Exception {
          InMemoryUserDetailsManager manager = new InMemoryUserDetailsManager();
          manager.createUser(User.withDefaultPasswordEncoder().username("root").password("root").roles("administrator").build());
          return manager;
      }
  }

• 3.啟動類添加注解@EnableAdminServer

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

• 4.配置application.yml

  server:
    port: 8081
   
  spring:
    boot:
      admin:
        context-path: monitor

• 5.瀏覽器訪問該項目
• 客戶端
  • 1.在需要被監控的應用里面添加如下依賴(注意版本號要與server端相同)

    <dependency>
          <groupId>de.codecentric</groupId>
          <artifactId>spring-boot-admin-starter-client</artifactId>
          <version>2.1.1</version>
    </dependency>

  • 2.編輯配置文件（詳細屬性配置參考手冊）

    spring.boot.admin.client.url = http://localhost:8081/admin-server/monitor
    spring.boot.admin.client.username = root
    spring.boot.admin.client.password = root
    spring.boot.admin.client.instance.service-base-url=http://localhost:8080
    spring.boot.admin.client.instance.name = dida
    
    management.endpoints.web.exposure.include = *
    management.endpoint.health.show-details = ALWAYS

• 刷新服務端

問題記錄

 　　按照上面的操作，我把公司的一個項目配置成了客戶端。在我的win10系統電腦上面運行這兩個程序是沒有問題的。但是當實際部署在linux服務器上面的時候就遇到了問題：我把springbootAdmin的server端部署到了linux服務器（服務器1），把要監控的項目部署到了另一台Linux服務器（服務器2），這兩台服務器處於同一個局域網內。運行這兩個項目，發現程序server端能夠發現這個我的client項目，但是client項目一直處於斷開狀態。

 錯誤日志

WARN  de.codecentric.boot.admin.client.registration.ApplicationRegistrator.register Line:115 - Failed to register application as Application
(name=dida, managementUrl=http://www.xxx.com:8081/dida/actuator, healthUrl=http://www.xxx.com:8081/dida/actuator/health,serviceUrl=http://www.xxx.com:8081/dida)
 at spring-boot-admin ([http://admin.xxx.com:8080/monitor/instances]): 404 null. Further attempts are logged on DEBUG level

經過多次嘗試，發現spring.boot.admin.client.url 該項目配置應該配置ip地址 http://172.18.0.188:8080/monitor，而不是域名。

INFO  de.codecentric.boot.admin.client.registration.ApplicationRegistrator.register Line:98 - Application registered itself as 2449779efa06

日志顯示注冊成功。

待補充 ... ...