Spring Boot Admin-應用健康監控後臺管理

<div class="show-content-free"> <blockquote> <h3>Spring Boot Admin 用於監控基於 Spring Boot 的應用，它是在 Spring Boot Actuator 的基礎上提供簡潔的可視化 WEB UI。</h3> </blockquote> <h2>1. 什麼是Spring Boot Admin?</h2> <hr> Spring Boot Admin（下文簡稱SBA）是一個社區開源項目，用於管理和監控你的Spring Boot應用。應用經過SBA Client註冊到SBA Server中，可經過HTTP請求或者Spring Cloud發現（例如Eureka、Consul），UI展現經過Vue在Spring Boot Actuator端點上獲取應用監控數據進行管理。 <h2>2. 開始使用</h2> <hr> <h3>2,1 配置好你的SBA Server服務端程序</h3> <h4>2.1.1 添加spring-boot-admin-starter-server的Maven依賴到你的pom.xml中：</h4> <pre class="hljs xml"><code class="xml"><dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-server</artifactId> <version>2.0.2</version> </dependency> <dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-server-ui</artifactId> <version>2.0.2</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> </code></pre> <h4>2.1.2 打開你的Spring Boot啓動文件中添加@EnableAdminServer 註解用於激活SBA Server配置：</h4> <pre class="hljs java"><code class="java">import de.codecentric.boot.admin.server.config.EnableAdminServer; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;java

@SpringBootApplication @EnableAdminServer public class Application {git

<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> </span>{
    SpringApplication.run(Application.class, args);
}

} </code></pre>github

注意若是你須要將應用以war形式部署，請將啓動文件作以下改變： <pre class="hljs java"><code class="java">import de.codecentric.boot.admin.server.config.EnableAdminServer; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;web

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">protected</span> SpringApplicationBuilder <span class="hljs-title">configure</span><span class="hljs-params">(SpringApplicationBuilder builder)</span> </span>{
    <span class="hljs-keyword">return</span> builder.sources(Application.class);
}

<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title">main</span><span class="hljs-params">(String[] args)</span> </span>{
    SpringApplication.run(Application.class, args);
}

} </code></pre>瀏覽器

<h4>2.1.3 在你的SBA Server中的 application.yml 中進行相關配置：</h4> <pre class="hljs bash"><code class="bash">spring: # 配置SBA Client鏈接的安全帳號密碼 security: user: name: admin password: admin boot: admin: ui: # 修改網頁顯示的tab標題 title: "應用監控管理" # 修改網頁的brand的圖標和標題 brand: "<img src='assets/img/icon-spring-boot-admin.svg'>應用監控管理" server: port: 7070 </code></pre> <h4>2.1.4 進行Spring Security相關配置：</h4> <pre class="hljs java"><code class="java">import de.codecentric.boot.admin.server.config.AdminServerProperties; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter; import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler; import org.springframework.security.web.csrf.CookieCsrfTokenRepository;安全

@EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter { private final String adminContextPath;bash

<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-title">SecurityConfig</span><span class="hljs-params">(AdminServerProperties adminServerProperties)</span> </span>{
    <span class="hljs-keyword">this</span>.adminContextPath = adminServerProperties.getContextPath();
}

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">protected</span> <span class="hljs-keyword">void</span> <span class="hljs-title">configure</span><span class="hljs-params">(HttpSecurity http)</span> <span class="hljs-keyword">throws</span> Exception </span>{
    SavedRequestAwareAuthenticationSuccessHandler successHandler = <span class="hljs-keyword">new</span> SavedRequestAwareAuthenticationSuccessHandler();
    successHandler.setTargetUrlParameter(<span class="hljs-string">"redirectTo"</span>);
    successHandler.setDefaultTargetUrl(adminContextPath + <span class="hljs-string">"/"</span>);

    http.authorizeRequests()
            .antMatchers(
                    adminContextPath + <span class="hljs-string">"/assets/**"</span>,
                    adminContextPath + <span class="hljs-string">"/login"</span>
            ).permitAll()
            .anyRequest().authenticated()
            .and()
            .formLogin().loginPage(adminContextPath + <span class="hljs-string">"/login"</span>).successHandler(successHandler).and()
            .logout().logoutUrl(adminContextPath + <span class="hljs-string">"/logout"</span>).and()
            .httpBasic().and()
            .csrf()
            .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
            .ignoringAntMatchers(
                    <span class="hljs-string">"/instances"</span>,
                    <span class="hljs-string">"/actuator/**"</span>,
                    adminContextPath + <span class="hljs-string">"/logout"</span>
            );
}

} </code></pre>網絡

<h3>2.2 註冊你的客戶端應用</h3> <blockquote> 爲了註冊你的應用在SBA Server中，你能夠使用SBA Client 或者使用Spring Cloud Discovery(例如：Eureka, Consul， ...）。 </blockquote> <h4>2.2.1 配置你的Spring Boot Admin客戶端</h4> 每個想註冊的應用都必須包含SBA Client，同時爲了確保Actuator端點的安全，建議添加 spring-boot-starter-security 依賴用於保護端點安全訪問。 添加 spring-boot-admin-starter-client 的Maven依賴到你的pom.xml中： <pre class="hljs xml"><code class="xml"><dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-client</artifactId> <version>2.0.2</version> </dependency>  <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> </dependency> </code></pre> <h4>2.2.2. 在你的SBA Client中的 application.yml 中配置你的SBA Server的服務地址：</h4> <pre class="hljs bash"><code class="bash">spring: boot: admin: client: # 這個URL地址是SBA Server的服務地址，你須要將你的應用註冊到該地址上 url: http://localhost:7070 # 配置鏈接到監測管理平臺的Security安全密碼 username: admin password: admin instance: metadata: # 配置發送到SBA Server的SBA Client的端點安全密碼 user.name: ${spring.security.user.name} user.password: ${spring.security.user.password} security: user: name: root password: root # 官方文檔中有提到， SpringBoot 的 Logging 配置的級別有7個：TRACE , DEBUG , INFO , WARN , ERROR , FATAL , OFF logging: # 設置日誌保存的路徑，path和file只須要設置一個，指定path則日誌名稱固定爲spring.log path: /java-log # 打印日誌的級別 level: root: info # 在默認狀況下大多數Actuator的端點並無徹底公開，這裏我將全部端點都進行公開進行管理 management.endpoints.web.exposure.include: "*" app

</code></pre>

<h4>2.2.3. 若是你添加了 spring-boot-starter-security 依賴，你須要進行以下配置使SBA Server服務端可以訪問SBA Client客戶端的Actuator端點：</h4> <pre class="hljs java"><code class="java">import org.springframework.context.annotation.Configuration; import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration public class SecurityConfig extends WebSecurityConfigurerAdapter {

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">protected</span> <span class="hljs-keyword">void</span> <span class="hljs-title">configure</span><span class="hljs-params">(HttpSecurity http)</span> <span class="hljs-keyword">throws</span> Exception </span>{
    http.httpBasic().and()
            .authorizeRequests().antMatchers(<span class="hljs-string">"/actuator/**"</span>).authenticated()
            .anyRequest().permitAll();
}

} </code></pre>

<h3>3.至此相關配置已經完成，如今讓咱們啓動SBA Server服務端程序，打開瀏覽器輸入<a href="http://localhost:7070" target="_blank" rel="nofollow">http://localhost:7070</a> 訪問它。</h3>

<div class="image-container" style="max-width: 700px; max-height: 345px; background-color: transparent;"> <div class="image-view" data-width="1920" data-height="949"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-e8258ce3badab3be.png" data-original-width="1920" data-original-height="949" data-original-format="image/png" data-original-filesize="52194" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150321306-288700741.png"></div> </div> 咱們能夠看到SBA Server跳轉到了登陸頁面提示咱們登陸，這時候咱們輸入咱們在application.yml中配置的帳號密碼進行登陸： <div class="image-container" style="max-width: 431px; max-height: 397px; background-color: transparent;"> <div class="image-view" data-width="431" data-height="397"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-83269364e36c29d0.png" data-original-width="431" data-original-height="397" data-original-format="image/png" data-original-filesize="17275" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150411912-1666681706.png"></div> </div> 輸入用戶名和密碼後點擊Login後跳轉到咱們的應用監控管理首頁： <div class="image-container" style="max-width: 700px; max-height: 345px; background-color: transparent;"> <div class="image-view" data-width="1920" data-height="949"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-72bd1b0d05d4b874.png" data-original-width="1920" data-original-height="949" data-original-format="image/png" data-original-filesize="50527" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150454196-1804564636.png"></div> </div> 這時咱們看到是沒有應用註冊進來的，頁面是數據是空白的，整個頁面簡潔乾淨，接下去讓咱們啓動一個SBA Client客戶端程序註冊進來 <div class="image-container" style="max-width: 700px; max-height: 345px; background-color: transparent;"> <div class="image-view" data-width="1920" data-height="949"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-575f1b73a9f994b6.png" data-original-width="1920" data-original-height="949" data-original-format="image/png" data-original-filesize="52659" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150536704-1308118067.png"></div> </div> 啓動一個SBA Client後，能夠看到頁面上出現了一個客戶端程序註冊進來了 <div class="image-container" style="max-width: 700px; max-height: 345px; background-color: transparent;"> <div class="image-view" data-width="1920" data-height="949"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-d84eb022f3069fe7.png" data-original-width="1920" data-original-height="949" data-original-format="image/png" data-original-filesize="83527" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150609688-626626406.png"></div> </div> 下圖是你的應用的基本信息查看，包括線程使用圖表，堆內存使用圖表，非堆內存使用圖表等等 <div class="image-view" data-width="1920" data-height="1080"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-3c2c62382daf9be1.png" data-original-width="1920" data-original-height="1080" data-original-format="image/png" data-original-filesize="104437" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150642488-341401263.png"></div> 下圖是你的應用的日誌打印 <div class="image-view" data-width="1920" data-height="1080"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-3aac83ee693a9351.png" data-original-width="1920" data-original-height="1080" data-original-format="image/png" data-original-filesize="202490" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150713228-1347024027.png"></div> 下圖是你的應用的網絡URL請求狀況監控 <div class="image-container" style="max-width: 700px; max-height: 393px; background-color: transparent;"> <div class="image-view" data-width="1920" data-height="1080"><img data-original-src="//upload-images.jianshu.io/upload_images/7089499-7b0fa09063c0d95a.png" data-original-width="1920" data-original-height="1080" data-original-format="image/png" data-original-filesize="152871" style="cursor: zoom-in;" class="" src="https://img2018.cnblogs.com/blog/1112483/201906/1112483-20190610150744789-193538763.png"></div> </div> <h3>這裏就不過多演示了，能夠看出這個經過這個監控平臺咱們能夠方便快捷的管理監控咱們的應用，不再用打開Linux命令行查看咱們項目運行的狀況，怎麼樣功能是否是很強大。</h3> 最後貼上如下官方文檔地址 <a href="http://codecentric.github.io/spring-boot-admin/2.0.2/#_what_is_spring_boot_admin" target="_blank" rel="nofollow">spring-boot-admin 官方文檔地址</a> <a href="https://github.com/codecentric/spring-boot-admin" target="_blank" rel="nofollow">spring-boot-admin GitHub地址</a>

</div>

原文地址：https://www.jianshu.com/p/921387db847e