Springboot輕量級的監控元件SpringbootAdmin

2023-02-12 06:00:22

簡介

Springboot Admin是一個管理和監控Springboot專案的元件，分為伺服器端和使用者端，兩端通過http進行通訊。由於其輕量級的特性，所以特別適合中小專案使用。

其效果圖如下：

伺服器端設定

1，引入Springboot admin和Spring Security依賴。

<dependency>
    <groupId>de.codecentric</groupId>
    <artifactId>spring-boot-admin-starter-server</artifactId>
    <version>2.5.1</version>
</dependency>
<dependency>
      <groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-security</artifactId>
</dependency>

2，設定相關屬性。

server:
  port: 8080
  servlet:
    context-path: /server
spring:
  security:
    user:
      #admin Server端登入時用的賬戶密碼
      name: server123
      password: 123456
  boot:
    admin:
      instance-auth:
        #啟用header驗證
        enabled: true
        #Server存取client介面時會使用下面的設定生成authorization
        default-user-name: "name_shishan"
        default-password: "pwd_shishan"

3，設定@EnableAdminServer註解

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

經過以上3步，伺服器端就可以啟動了。

存取 http://localhost:8080/server/，就可以看到以下登入介面。

使用在yml檔案中設定的賬戶密碼就可以登入了。

使用者端設定

1，在我們要監控的使用者端中加入以下依賴。

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

2，暴露監控介面以及設定Server地址。

使用者端在啟動後會向設定的Server發起註冊申請，此時為了安全性還需要Server端的賬戶密碼進行校驗。

spring:
  boot:
    admin:
      client:
        #admin註冊地址
        url: http://localhost:8080/server
        #設定admin的賬戶
        username: server123
        password: 123456
admin:
  header:
    auth:
      name: "name_shishan"
      password: "pwd_shishan"
#暴露出埠
management:
  endpoints:
    web:
      exposure:
        include: "*"

3，對暴露的介面進行許可權校驗。

由於我們將監控介面進行了暴露，所以必須對相關的介面進行許可權校驗，否則就有可能洩露相關資訊。

對介面進行許可權過濾有很多種選擇，比如設定IP存取的白名單，只允許admin Server所在的伺服器存取，也可以設定相關的token等等。

下面我們以一個簡單的介面過濾器實現對/actuator/**相關介面的許可權校驗。

@Component
public class PathFilter implements Filter {
    @Value("${admin.header.auth.name}")
    private String username;
    @Value("${admin.header.auth.password}")
    private String password;
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        AntPathMatcher antPathMatcher = new AntPathMatcher();
        if (antPathMatcher.match("/actuator/**", request.getServletPath())) {
            String authorization = request.getHeader("authorization");
            if (StringUtils.hasText(authorization)) {
                String token = Base64Utils.encodeToString((username + ":" + password).getBytes(StandardCharsets.UTF_8));
                if (authorization.equals("Basic " + token)) {
                    //token匹配才放行
                    filterChain.doFilter(request, servletResponse);
                    return;
                }
            }
            response.setContentType("application/json;charset=UTF-8");
            response.setStatus(HttpStatus.UNAUTHORIZED.value());
            response.getWriter().print("許可權不足");
            return;
        }
        //其他介面直接放行
        filterChain.doFilter(request, servletResponse);
    }
}

在這個filter中，對actuator相關的介面進行了header引數的校驗，只有通過校驗才可以存取暴露出的actuator介面。

當然，如果我們使用了SpringSecurity或者SaToken這樣的第三方許可權框架，也可以去重寫相關的設定完成許可權的判斷，原理都是一樣的。

下面我們看一下最終的監控效果：