修改ApiBoot Logging日志采集前綴的教程

ApiBoot Logging支持指定單個或者多個路徑的前綴進行采集，也就是我們可以指定/user/**或者/order/**下的單個或者同時指定多個路徑進行采集請求日志，其他不符合Ant表達式的路徑就會被忽略掉。

創(chuàng)建示例項目

使用idea創(chuàng)建SpringBoot項目。

添加ApiBoot Logging依賴

創(chuàng)建項目后在pom.xml配置文件內(nèi)添加依賴如下所示：

org.springframework.bootspring-boot-starter-weborg.minbox.frameworkapi-boot-starter-loggingorg.minbox.frameworkapi-boot-dependencies2.1.4.RELEASEimportpom

默認攔截路徑

ApiBoot Logging默認的攔截路徑是/**，可以訪問org.minbox.framework.api.boot.autoconfigure.logging.ApiBootLoggingProperties屬性配置類查看源碼。

配置采集攔截器前綴

ApiBoot Logging提供了在application.yml配置文件內(nèi)修改的配置參數(shù)api.boot.logging.logging-path-prefix，該配置參數(shù)接收的類型為java.lang.String[]，所以我們可以使用,逗號隔開配置多個路徑，如下所示：

spring:
  application:
    name: modify-apiboot-logging-collection-prefix
server:
  port: 8080

api:
  boot:
    # ApiBoot Logging 相關(guān)配置
    logging:
      # 修改采集日志的前綴
      logging-path-prefix: /user/**,/order/**
      # 控制臺打印日志
      show-console-log: true
      # 美化控制臺打印的日志
      format-console-log-json: true

啟用ApiBoot Logging Client

配置已經(jīng)完成，下面我們在入口類（XxxApplication）或者配置類（XxxConfiguration）上添加@EnableLoggingClient注解來啟用ApiBoot Logging的功能，如下所示：

/**
 * 入口類
 *
 * @author 恒宇少年
 */
@SpringBootApplication
@EnableLoggingClient
public class ModifyApibootLoggingCollectionPrefixApplication {

    public static void main(String[] args) {
        SpringApplication.run(ModifyApibootLoggingCollectionPrefixApplication.class, args);
    }

}

運行測試

使用idea的Application或者java -jar xxx.jar的形式來運行本章源碼，本章源碼的端口號配置為8080，我們需要從下面幾個點進行測試。

測試點：匹配/user/**路徑

添加測試控制器類UserController如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    /**
     * 測試日志攔截路徑接口
     *
     * @param name
     * @return
     */
    @GetMapping
    public String welcome(@RequestParam("name") String name) {
        return "hello, " + name;
    }
}

通過如下命令訪問測試接口：

? ~ curl http://localhost:8080/user/?name/=hengboy
hello, hengboy

/user路徑匹配/user/**表達式，所以我們在控制臺可以看到請求日志的打印。

測試點：匹配/order/**路徑

添加測試控制器類OrderController如下所示：

@RestController
@RequestMapping(value = "/order")
public class OrderController {

    @PostMapping
    public String submit() {
        return "訂單：" + UUID.randomUUID().toString() + "，提交成功.";
    }
}

通過如下命令訪問測試接口：

? ~ curl -X POST http://localhost:8080/order       
訂單：24a24d24-539e-4da9-9272-e68fd592313c，提交成功.

/order路徑匹配/order/**表達式，所以我們在控制臺也可以看到請求日志的打印。

測試點：其他路徑

添加測試控制器類OtherController如下所示：

@RestController
public class OtherController {

    @GetMapping(value = "/other")
    public String other() {
        return "this is other path";
    }
}

通過如下命令訪問測試接口：

? ~ curl http://localhost:8080/other         
this is other path

由于/other路徑并不匹配/user/**或者/order/**表達式，所以我們在控制臺并沒有看到日志的打印。

敲黑板，劃重點

ApiBoot Logging支持單個或者多個路徑配置來進行過濾指定路徑前綴來采集日志，讓日志采集不再不可控，更精準的定位到業(yè)務(wù)請求的日志采集。

審核編輯 黃昊宇