ApiBoot Logging忽略路徑不進(jìn)行采集日志的教程

ApiBoot Logging支持排除指定路徑不參與日志的采集，當(dāng)我們的服務(wù)集成actuator時(shí)，會(huì)不斷的重復(fù)調(diào)用內(nèi)置的路徑導(dǎo)致大量采集到一些無(wú)關(guān)業(yè)務(wù)的日志信息，當(dāng)然這只是一個(gè)例子，集成其他的第三方組件時(shí)也可能出現(xiàn)定時(shí)重復(fù)調(diào)用接口的場(chǎng)景。

創(chuàng)建示例項(xiàng)目

本章所使用的示例項(xiàng)目請(qǐng)?jiān)L問(wèn)【修改ApiBoot Logging日志采集的前綴】文章底部訪問(wèn)源碼下載后導(dǎo)入idea工具。

配置排除路徑

ApiBoot Logging提供了配置參數(shù)api.boot.logging.ignore-paths，該配置參數(shù)的數(shù)據(jù)類型為java.lang.String[]，可以使用,逗號(hào)隔開配置多個(gè)忽略采集日志的路徑。

修改application.yml配置文件內(nèi)容如下所示：

api:
  boot:
    # ApiBoot Logging 相關(guān)配置
    logging:
      # 修改采集日志的前綴
      logging-path-prefix: /user/**,/order/**
      # 控制臺(tái)打印日志
      show-console-log: true
      # 美化控制臺(tái)打印的日志
      format-console-log-json: true
      # 排除/user/info路徑不進(jìn)行采集日志
      ignore-paths: /user/info

在上面配置中排除了/user/info路徑采集日志。

運(yùn)行測(cè)試

導(dǎo)入idea的源碼并沒有添加/user/info路徑請(qǐng)求方法，下面我們修改UserController類如下所示：

/**
  * 用戶信息
  * /user/info
  *
  * @return
  */
@GetMapping(value = "/info")
public String info() {
  return "this is user info";
}

使用Application方式啟動(dòng)本章源碼，通過(guò)curl方式訪問(wèn)/user/info路徑，如下所示：

? ~ curl http://localhost:8080/user/info
this is user info

訪問(wèn)成功后，查看控制臺(tái)并未發(fā)現(xiàn)有請(qǐng)求日志輸出，證明了/user/info路徑被排除了。

敲黑板，劃重點(diǎn)

api.boot.logging.ignore-paths配置參數(shù)與api.boot.logging.logging-path-prefix可以組合使用，可以進(jìn)行重疊，排除的路徑是在org.minbox.framework.logging.client.interceptor.web.LoggingWebInterceptor#checkIgnore方法內(nèi)進(jìn)行判斷，支持Ant風(fēng)格路徑過(guò)濾。

審核編輯 黃昊宇