1.概述
Spring Boot Admin是一個Web應用程序，用于管理和監視Spring Boot應用程序。每個應用程序都被視為客戶端，并注冊到管理服務器。底層能力是由Spring Boot Actuator端點提供的。
在本文中，我們將介紹配置Spring Boot Admin服務器的步驟以及應用程序如何集成客戶端。
2.管理服務器配置
由于Spring Boot Admin Server可以作為servlet或webflux應用程序運行，根據需要，選擇一種并添加相應的Spring Boot Starter。在此示例中，我們使用Servlet Web Starter。
首先，創建一個簡單的Spring Boot Web應用程序，并添加以下Maven依賴項：
|
1
2
3
4
5
6
7
8
9
|
<dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-server</artifactId> <version>2.2.3</version></dependency><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency> |
之后，@ EnableAdminServer將可用，因此我們將其添加到主類中，如下例所示：
|
1
2
3
4
5
6
7
8
|
@EnableAdminServer@SpringBootApplicationpublic class SpringBootAdminServerApplication { public static void main(String[] args) { SpringApplication.run(SpringBootAdminServerApplication.class, args); }} |
至此，服務端就配置完了。
3.設置客戶端
要在Spring Boot Admin Server服務器上注冊應用程序，可以包括Spring Boot Admin客戶端或使用Spring Cloud Discovery（例如Eureka，Consul等）。
下面的例子使用Spring Boot Admin客戶端進行注冊，為了保護端點，還需要添加spring-boot-starter-security，添加以下Maven依賴項：
|
1
2
3
4
5
6
7
8
9
|
<dependency> <groupId>de.codecentric</groupId> <artifactId>spring-boot-admin-starter-client</artifactId> <version>2.2.3</version></dependency><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId></dependency> |
接下來，我們需要配置客戶端說明管理服務器的URL。為此，只需添加以下屬性：
|
1
|
spring.boot.admin.client.url=http://localhost:8080 |
從Spring Boot 2開始，默認情況下不公開運行狀況和信息以外的端點，對于生產環境，應該仔細選擇要公開的端點。
|
1
2
|
management.endpoints.web.exposure.include=*management.endpoint.health.show-details=always |
使執行器端點可訪問：
|
1
2
3
4
5
6
7
8
|
@Configurationpublic static class SecurityPermitAllConfig extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { http.authorizeRequests().anyRequest().permitAll() .and().csrf().disable(); }} |
為了簡潔起見，暫時禁用安全性。
如果項目中已經使用了Spring Cloud Discovery，則不需要Spring Boot Admin客戶端。只需將DiscoveryClient添加到Spring Boot Admin Server，其余的自動配置完成。
下面使用Eureka做例子，但也支持其他Spring Cloud Discovery方案。
將spring-cloud-starter-eureka添加到依賴中：
|
1
2
3
4
|
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId></dependency> |
通過添加@EnableDiscoveryClient到配置中來啟用發現
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
@Configuration@EnableAutoConfiguration@EnableDiscoveryClient@EnableAdminServerpublic 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(); } }} |
配置Eureka客戶端：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
eureka: instance: leaseRenewalIntervalInSeconds: 10 health-check-url-path: /actuator/health metadata-map: startup: ${random.int} #需要在重啟后觸發信息和端點更新 client: registryFetchIntervalSeconds: 5 serviceUrl: defaultZone: ${EUREKA_SERVICE_URL:http://localhost:8761}/eureka/management: endpoints: web: exposure: include: "*" endpoint: health: show-details: ALWAYS |
4.安全配置
Spring Boot Admin服務器可以訪問應用程序的敏感端點，因此建議為admin 服務和客戶端應用程序添加一些安全配置。
由于有多種方法可以解決分布式Web應用程序中的身份驗證和授權，因此Spring Boot Admin不會提供默認方法。默認情況下spring-boot-admin-server-ui提供登錄頁面和注銷按鈕。
服務器的Spring Security配置如下所示：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
@Configuration(proxyBeanMethods = false)public class SecuritySecureConfig extends WebSecurityConfigurerAdapter { private final AdminServerProperties adminServer; public SecuritySecureConfig(AdminServerProperties adminServer) { this.adminServer = adminServer; } @Override protected void configure(HttpSecurity http) throws Exception { SavedRequestAwareAuthenticationSuccessHandler successHandler = new SavedRequestAwareAuthenticationSuccessHandler(); successHandler.setTargetUrlParameter("redirectTo"); successHandler.setDefaultTargetUrl(this.adminServer.path("/")); http.authorizeRequests( (authorizeRequests) -> authorizeRequests.antMatchers(this.adminServer.path("/assets/**")).permitAll() // 授予對所有靜態資產和登錄頁面的公共訪問權限 .antMatchers(this.adminServer.path("/login")).permitAll().anyRequest().authenticated() //其他所有請求都必須經過驗證 ).formLogin( (formLogin) -> formLogin.loginPage(this.adminServer.path("/login")).successHandler(successHandler).and() //配置登錄和注銷 ).logout((logout) -> logout.logoutUrl(this.adminServer.path("/logout"))).httpBasic(Customizer.withDefaults()) //啟用HTTP基本支持，這是Spring Boot Admin Client注冊所必需的 .csrf((csrf) -> csrf.csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()) //使用Cookies啟用CSRF保護 .ignoringRequestMatchers( new AntPathRequestMatcher(this.adminServer.path("/instances"), HttpMethod.POST.toString()), new AntPathRequestMatcher(this.adminServer.path("/instances/*"), HttpMethod.DELETE.toString()), //禁用Spring Boot Admin Client用于（注銷）注冊的端點的CSRF-Protection new AntPathRequestMatcher(this.adminServer.path("/actuator/**")) )) //對執行器端點禁用CSRF-Protection。 .rememberMe((rememberMe) -> rememberMe.key(UUID.randomUUID().toString()).tokenValiditySeconds(1209600)); } @Override protected void configure(AuthenticationManagerBuilder auth) throws Exception { auth.inMemoryAuthentication().withUser("user").password("{noop}password").roles("USER"); }} |
添加之后，客戶端無法再向服務器注冊。為了向服務器注冊客戶端，必須在客戶端的屬性文件中添加更多配置：
|
1
2
|
spring.boot.admin.client.username=adminspring.boot.admin.client.password=admin |
當使用HTTP Basic身份驗證保護執行器端點時，Spring Boot Admin Server需要憑據才能訪問它們。可以在注冊應用程序時在元數據中提交憑據。在BasicAuthHttpHeaderProvider隨后使用該元數據添加Authorization頭信息來訪問應用程序的執行端點。也可以提供自己的屬性HttpHeadersProvider來更改行為（例如添加一些解密）或添加額外的請求頭信息。
使用Spring Boot Admin客戶端提交憑據：
|
1
2
3
4
5
6
|
spring.boot.admin.client: url: http://localhost:8080 instance: metadata: user.name: ${spring.security.user.name} user.password: ${spring.security.user.password} |
使用Eureka提交憑據：
|
1
2
3
4
5
|
eureka: instance: metadata-map: user.name: ${spring.security.user.name} user.password: ${spring.security.user.password} |
5.日志文件查看器
默認情況下，日志文件無法通過執行器端點訪問，因此在Spring Boot Admin中不可見。為了啟用日志文件執行器端點，需要通過設置logging.file.path或將Spring Boot配置為寫入日志文件 logging.file.name。
Spring Boot Admin將檢測所有看起來像URL的內容，并將其呈現為超鏈接。
還支持ANSI顏色轉義。因為Spring Boot的默認格式不使用顏色，可以設置一個自定義日志格式支持顏色。
|
1
2
|
logging.file.name=/var/log/sample-boot-application.log logging.pattern.file=%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(%5p) %clr(${PID}){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n%wEx |
6. 通知事項
郵件通知
郵件通知將作為使用Thymeleaf模板呈現的HTML電子郵件進行傳遞。要啟用郵件通知，請配置JavaMailSender使用spring-boot-starter-mail并設置收件人。
將spring-boot-starter-mail添加到依賴項中：
|
1
2
3
4
|
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-mail</artifactId></dependency> |
配置一個JavaMailSender
|
1
2
3
|
spring.mail.username=smtp_userspring.mail.password=smtp_passwordspring.boot.admin.notify.mail.to=admin@example.com |
無論何時注冊客戶端將其狀態從“ UP”更改為“ OFFLINE”，都會將電子郵件發送到上面配置的地址。
自定義通知程序
可以通過添加實現Notifier接口的Spring Bean來添加自己的通知程序，最好通過擴展 AbstractEventNotifier或AbstractStatusChangeNotifier來實現。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
public class CustomNotifier extends AbstractEventNotifier { private static final Logger LOGGER = LoggerFactory.getLogger(LoggingNotifier.class); public CustomNotifier(InstanceRepository repository) { super(repository); } @Override protected Mono<Void> doNotify(InstanceEvent event, Instance instance) { return Mono.fromRunnable(() -> { if (event instanceof InstanceStatusChangedEvent) { LOGGER.info("Instance {} ({}) is {}", instance.getRegistration().getName(), event.getInstance(), ((InstanceStatusChangedEvent) event).getStatusInfo().getStatus()); } else { LOGGER.info("Instance {} ({}) {}", instance.getRegistration().getName(), event.getInstance(), event.getType()); } }); }} |
其他的一些配置參數和屬性可以通過官方文檔來了解。
到此這篇關于詳解用Spring Boot Admin來監控我們的微服務的文章就介紹到這了,更多相關Spring Boot Admin監控微服務內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家！
原文鏈接：https://blog.csdn.net/huahao1989/article/details/108039738
