Spring boot admin 服務監控利器詳解

Posted on 2022-08-04 by WalkonNet

一、簡介

用於對 Spring Boot 應用的管理和監控。可以用來監控服務是否健康、是否在線、以及一些jvm數據等等。
Spring Boot Admin 分為服務端(spring-boot-admin-server)和客戶端(spring-boot-admin-client)，服務端和客戶端之間采用 http 通訊方式實現數據交互；單體項目中需要整合 spring-boot-admin-client 才能讓應用被監控。
在 SpringCloud 項目中，spring-boot-admin-server 是直接從註冊中心抓取應用信息，不需要每個微服務應用整合 spring-boot-admin-client 就可以實現應用的管理和監控。

主要的功能點有：

顯示應用程序的監控狀態
應用程序上下線監控
查看 JVM，線程信息
可視化的查看日志以及下載日志文件
動態切換日志級別
Http 請求信息跟蹤

二、搭建

1、服務端

需先搭建服務端，監控服務，被監控的服務連接過來即可，開箱即用。

1、新建一個項目做為服務端
2、引入spring-boot-admin服務端依賴

	  <!--用於檢查系統的監控情況-->
 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-actuator</artifactId>
 </dependency>
  <!--Spring Boot Admin Server監控服務端-->
 <dependency>
     <groupId>de.codecentric</groupId>
     <artifactId>spring-boot-admin-starter-server</artifactId>
     <version>2.3.1</version>
 </dependency>
   <!--增加安全防護，防止別人隨便進-->
 <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-security</artifactId>
  </dependency>

3、啟動類上開啟admin@EnableAdminServer

4、security安全防護配置

import de.codecentric.boot.admin.server.config.AdminServerProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
import org.springframework.security.web.csrf.CookieCsrfTokenRepository;
@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()
                //靜態文件允許訪問
                .antMatchers(adminContextPath + "/assets/**").permitAll()
                //登錄頁面允許訪問
                .antMatchers(adminContextPath + "/login", "/css/**", "/js/**", "/image/*").permitAll()
                //其他所有請求需要登錄
                .anyRequest().authenticated()
                .and()
                //登錄頁面配置，用於替換security默認頁面
                .formLogin().loginPage(adminContextPath + "/login").successHandler(successHandler).and()
                //登出頁面配置，用於替換security默認頁面
                .logout().logoutUrl(adminContextPath + "/logout").and()
                .httpBasic().and()
                .csrf()
                .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse())
                .ignoringAntMatchers(
                        "/instances",
                        "/actuator/**"
                );
    }
}

5、yml配置

server:
  port: 9111
spring:
  boot:
    admin:
      ui:
        title: HMB服務監控中心
      client:
        instance:
          metadata:
            tags:
              environment: local
         #要獲取的client的端點信息
      probed-endpoints: health,env,metrics,httptrace:trace,threaddump:dump,jolokia,info,logfile,refresh,flyway,liquibase,heapdump,loggers,auditevents
      monitor: # 監控發送請求的超時時間
        default-timeout: 20000
  security: # 設置賬號密碼
    user:
      name: admin
      password: admin
# 服務端點詳細監控信息
management:   
  trace:
    http:
      enabled: true
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always

6、啟動項目

訪問 http://ip:端口,

如我的http://localhost:9111，賬號密碼都是admin(上面的security配的)

7、自定義服務狀態變化後，提醒功能

import de.codecentric.boot.admin.server.domain.entities.Instance;
import de.codecentric.boot.admin.server.domain.entities.InstanceRepository;
import de.codecentric.boot.admin.server.domain.events.InstanceEvent;
import de.codecentric.boot.admin.server.notify.AbstractStatusChangeNotifier;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Mono;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;

@Component
public class WarnNotifier extends AbstractStatusChangeNotifier {
	public WarnNotifier(InstanceRepository repository) {
		super(repository);
	}

	@Override
	protected Mono<Void> doNotify(InstanceEvent event, Instance instance) {
		// 服務名
		String serviceName = instance.getRegistration().getName();
		// 服務url
		String serviceUrl = instance.getRegistration().getServiceUrl();
		// 服務狀態
		String status = instance.getStatusInfo().getStatus();
		// 詳情
		Map<String, Object> details = instance.getStatusInfo().getDetails();
		// 當前服務掉線時間
		Date date = new Date();
		SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		String format = simpleDateFormat.format(date);
		// 拼接短信內容
		StringBuilder str = new StringBuilder();
		str.append("服務名：【" + serviceName + "】 \r\n");
		str.append("服務狀態：【"+ status +"】 \r\n");
		str.append("地址：【" + serviceUrl + "】\r\n");
		str.append("時間：" + format +"\r\n");

		return Mono.fromRunnable(()->{
			// 這裡寫你服務發生改變時，要提醒的方法
			// 如服務掉線瞭，就發送短信告知
		});
	}
}

8、服務端配置

配置	默認參數	解釋
spring.boot.admin.context-path	/	server端的訪問路徑
spring.boot.admin.monitor.status-interval	10,000ms	檢查實例狀態的時間間隔。

2、客戶端

被監控的服務，需要連接服務端

1、依賴

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

2、yml配置

server:
  port: 9222
spring:
  application:
    name: client
  boot:
    admin:
      client: # spring-boot-admin 客戶端配置
        url: http://localhost:9111 #服務端連接地址
        username: admin # 服務端賬號
        password: admin # 服務端密碼
        instance:
          prefer-ip: true # 使用ip註冊

# 服務端點詳細監控信息
management:
  trace:
    http:
      enabled: true
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: always
    logfile: # 日志（想在線看日志才配）
      external-file: ./logs/client-info.log # 日志所在路徑

3、啟動項目

此時客戶端就已經註冊進來瞭。

點擊可查看更多信息：

點擊日志也可在線查看日志：

此時，如果我們服務掉線瞭，就會觸發服務端的預警功能，告知我們。

4、客戶端配置

3、微服務

除特別說明外，都是在上面的基礎上添加

3.1、服務端

1、添加依賴

  <!--  nacos註冊中心配置-->
  <dependency>
      <groupId>com.alibaba.cloud</groupId>
      <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
      <version>2.2.5.RELEASE</version>
  </dependency>

2、yml添加配置

spring:
  cloud: 
    nacos: 
      discovery:
        server-addr: localhost:8848
#        namespace: # 要和你的服務同一命名空間

3.2、客戶端

客戶端不用引spring-boot-admin-starter-clien依賴，springbootadmin會去服務列表裡找

如果服務有配置context-path路徑，則需添加yml配置

spring:
  cloud:
    nacos:
      discovery:
        metadata:  # minitor監控的context-path配置
          management:
            context-path: ${server.servlet.context-path}/actuator

4、我的微服務預警發送其他服務狀態信息思路

問題：由於該組件重寫狀態發生變化時的接口，沒有提供其他服務的狀態信息，隻有本服務，但是如果是集群、多實例，我又想知道，該服務其他實例或者其他的服務狀態信息，是否存活。

結果展示：如我的預警內容，發送當前服務狀態、當前服務剩餘健康實例、其他健康服務數等等

到此這篇關於Spring boot admin 服務監控利器詳解的文章就介紹到這瞭,更多相關Spring boot admin 內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

Spring boot admin 服務監控利器詳解

目錄

一、簡介

二、搭建

1、服務端

2、客戶端

3、啟動項目

4、客戶端配置

3、微服務

3.1、服務端

3.2、客戶端

4、我的微服務預警發送其他服務狀態信息思路

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

一、簡介

二、搭建

1、服務端

2、客戶端

3、啟動項目

4、客戶端配置

3、微服務

3.1、服務端

3.2、客戶端

4、我的微服務預警發送其他服務狀態信息思路

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆