給日志打標簽，讓你的日志定位再無困難-有解無憂

背景

不知道各位在生產日志中定位問題時有沒有碰到這樣的場景：由于coding的時候日志輸出的比較少，出現問題時，很難通過日志去定位到問題，又或者是，你明明coding的時候有輸出日志，但是在龐大的日志檔案中，由于業務執行緒并發比較多，你輸出的日志又沒有加關鍵資訊，你也很難定位到你所需要的日志資訊，

之前在公司里寫業務代碼時，為了使每個RPC呼叫能被日志記錄下來，我們在公司基礎組件里定義了一個切面，攔截所有的RPC呼叫，方法開始之前，在日志里輸出呼叫的服務和方法以及引數，方法結束時輸出方法的耗時，我相信很多人也是這么做的，

這樣一來，所有的呼叫都能通過引數里的關鍵資訊被搜索到，也能定位到呼叫是什么結束的以及耗時，

但是在有些業務方法中，也打上了很多的業務日志，由于核心業務的tps和qps很高，日志是互相穿插的，如果你的日志沒有打上關鍵的業務資訊(比如訂單號，業務ID)，那就很難在日志中被定位出來，

也許有些童鞋會說，用執行緒號呀，通過搜索業務ID定位到呼叫開始的地方，再搜索這條執行緒的執行緒號，就可以定位整個請求的所有日志，其實之前我也是這么干的，但是執行緒一般都是由執行緒池進行管理的，在tps很高的業務中，同一個執行緒號有可能短時間會出現多次，但是卻是不同的請求，而且業務方法中可能也會有異步執行緒，導致了執行緒號會變，這樣對于定位日志就又增加了難度，當然最后可以通過對時間戳的分析，還是可以定位到具體日志，但是這樣就增加了定位的時間成本，

如果你的公司對微服務使用了分布式追蹤，那么定位日志可以通過traceId來解決，如果沒有在生產上應用分布式追蹤，又想在并發比較高的應用的日志上快速定位到所需要的日志，其中一個比較有效的辦法就是：規范日志的輸出格式，

在每行日志輸出時盡可能的加上關鍵的業務資訊，然后定位起來就比較清晰了，例如：

file

這里每一行日志都加上了訂單號和請求ID，我們把這樣的日志頭資訊稱之為日志標簽，有了這些標簽定位起來就比較容易了，

那這樣是不是意味著每寫一行日志，都必須加上這樣日志標簽資訊呢？這是不是也麻煩了？

答案是不用的，

推薦一款自動給日志打標簽實作精確定位的日志切面框架，你使用了這個，你的日志可以實作自定義的業務標簽！

點擊Aspect-log跳轉到開源主頁，或者復制以下地址：

https://gitee.com/bryan31/aspect-log

file

Aspect-log介紹

這是一款小巧，輕量級，對業務幾乎無侵入的日志切面框架，特性為：

使用簡單，不侵入業務代碼，只需要在方法上配置標注
支持log4j，logback，log4j2三種常見的日志框架
配置極其簡單，提供“一鍵配置”，自動識別日志框架
在方法上配置，無論呼叫多深或者異步呼叫，也可以統一加上日志標簽
無性能損耗

使用方法很簡單，如果你是springboot，aspect-log提供了自動裝配，GAV為：

<dependency>
  <groupId>com.yomahub</groupId>
  <artifactId>aspect-log-spring-boot-starter</artifactId>
  <version>1.2</version>
</dependency>

如果你是spring，GAV為：

<dependency>
  <groupId>com.yomahub</groupId>
  <artifactId>aspect-log-core</artifactId>
  <version>1.2</version>
</dependency>

配置方式

如果你使用spring，需要在專案里的application.xml里定義：

<bean />

如果你使用springboot，AspectLog切面會自動裝配好，

一鍵配置方法

這種方式用javassit實作，只需要一句話就可以實作，自動識別當前主流的日志框架，

@SpringBootApplication
public class Runner {

    static {AspectLogEnhance.enhance();}//進行日志增強，自動判斷日志框架

    public static void main(String[] args) {
        try {
            SpringApplication.run(Runner.class, args);
        } catch (Throwable e) {
            e.printStackTrace();
        }
        while (true) {
            try {
                Thread.sleep(60000);
            } catch (Throwable e) {
                e.printStackTrace();
            }
        }
    }
}

針對于主流的Log日志框架作了適配（推薦用這種）

針對于每種Log日志框架提供了適配，具體使用方法請參照專案主頁里的檔案，

如何使用

接下來在你的方法上加上@AspectLog標注，簡單的例子如下：

@AspectLog({"id"})
public void demo1(String id,String name){
  log.info("這是第一條日志");
  log.info("這是第二條日志");
  log.info("這是第三條日志");
  new Thread(() -> log.info("這是異步日志")).start();
}

假設id的值為'NO1234'，日志打出來的樣子如下：

2020-02-08 20:22:33.945 [main] INFO  Demo - [NO1234] 這是第一條日志
2020-02-08 20:22:33.945 [main] INFO  Demo - [NO1234] 這是第二條日志
2020-02-08 20:22:33.945 [main] INFO  Demo - [NO1234] 這是第三條日志
2020-02-08 20:22:33.948 [Thread-3] INFO  Demo - [NO1234] 這是異步日志

@AspectLog支持多個標簽:

@AspectLog({"id","name"})
public void demo1(String id,String name){
  log.info("這是第一條日志");
  log.info("這是第二條日志");
  log.info("這是第三條日志");
  new Thread(() -> log.info("這是異步日志")).start();
}

假設傳入id的值為'NO1234'，name為'jenny'，日志打出來的樣子如下：

2020-02-08 22:09:40.101 [main] INFO  Demo - [NO1234-jenny] 這是第一條日志
2020-02-08 22:09:40.101 [main] INFO  Demo - [NO1234-jenny] 這是第二條日志
2020-02-08 22:09:40.102 [main] INFO  Demo - [NO1234-jenny] 這是第三條日志
2020-02-08 22:09:40.103 [Thread-3] INFO  Demo - [NO1234-jenny] 這是異步日志

@AspectLog支持自定pattern和多個引數的連接符

@AspectLog(value = https://www.cnblogs.com/bryan31/p/{"id","name"},pattern = "<-{}->",joint = "_")
public void demo(String id,String name){
  log.info("加了patter和joint的示例");
}

日志打出來的樣子如下：

2020-02-08 22:09:40.103 [main] INFO  Demo - <-NO1234_jenny-> 加了patter和joint的示例

@AspectLog支持點運算子，適用于物件的取值，支持型別為業務物件和Map

@AspectLog({"person.id","person.age","person.company.department.dptId"})
public void demo(Person person){
  log.info("多引數加多層級示例");
}

日志打出來的樣子如下：

2020-02-08 22:09:40.110 [main] INFO  Demo - [31-25-80013] 多引數加多層級示例

@AspectLog支持自定義Convert，適用于更復雜的業務場景

@AspectLog(convert = CustomAspectLogConvert.class)
public void demo(Person person){
  log.info("自定義Convert示例");
}

public class CustomAspectLogConvert implements AspectLogConvert {
    @Override
    public String convert(Object[] args) {
        Person person = (Person)args[0];
        return "PERSON(" + person.getId() + ")";
    }
}

日志列印出來的樣子如下：

2020-02-20 17:05:12.414 [main] INFO  Demo - [PERSON(31] 自定義Convert示例

@AspectLog支持編程式設值

public void demo(){
  AspectLogContext.putLogValue("[SO1001]");
  log.info("代碼控制示例");
}

日志打出來的樣子：

2020-02-08 22:09:40.110 [main] INFO  Demo - [SO1001] 代碼控制示例

結尾

日志輸出對于一個服務來說，即是執行軌跡的記錄，也是尋錯找源的根本，日志打的全面而工整，對于排查問題來說，是事半功倍的，相信小伙伴都有看過亂糟糟的日志吧，在一堆這樣的日志檔案中取尋根溯源，那是極其痛苦的，

我相信很多開發者都有著代碼潔癖，工程的架構，代碼的結構，變數的定義，都有著苛刻的要求，這是種好習慣，這種好習慣會使代碼的閱讀和理解事半功倍，

所以Aspect-log就是這樣一款能讓你的日志也變得工整和賞心悅目的工具，

最后附上Aspect-log的工程主頁，歡迎關注和提出issue

希望這款小工具能讓你的日志變得工整，能讓你的排查變得簡單而快捷，

聯系作者

微信關注「jishuyuanren」或者掃描以下二維碼獲取更多技術干貨：

file

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/140442.html

標籤：Java

上一篇：java物件屬性拷貝

下一篇：并發編程AQS----共享鎖