2. 程式人生 > >驚訝！我定的日誌規範被CTO在全公司推廣了

驚訝！我定的日誌規範被CTO在全公司推廣了

阿新 • • 發佈：2019-12-24

列印日誌是一門藝術，但長期被開發同學所忽視。日誌就像車輛保險，沒人願意為保險付錢，但是一旦出了問題都又想有保險可用。我們列印日誌的時候都很隨意，可是用的時候會吐槽各種 SB 包括自己！寫好每一條日誌吧，與君共勉！

日誌

日誌是什麼？

日誌，維基百科的定義是記錄伺服器等電腦裝置或軟體的運作。

日誌檔案提供精確的系統記錄，根據日誌最終定位到錯誤詳情和根源。日誌的特點是，它描述一些離散的（不連續的）事件。 例如：應用通過一個滾動的檔案輸出 INFO 或 ERROR 資訊，並通過日誌收集系統，儲存到一些儲存引擎（Elasticsearch）中方便查詢。

日誌有什麼用？

  • 在上文中我們解釋了日誌的作用是提供精準的系統記錄方便根因分析。那麼具體在哪些具體方面它可以發揮作用？

  • 列印除錯：即可以用日誌來記錄變數或者某一段邏輯。記錄程式執行的流程，即程式運行了哪些程式碼，方便排查邏輯問題。
  • 問題定位：程式出異常或者出故障時快速的定位問題，方便後期解決問題。因為線上生產環境無法 debug，在測試環境去模擬一套生產環境，費時費力。所以依靠日誌記錄的資訊定位問題，這點非常重要。還可以記錄流量，後期可以通過 ELK（包括 EFK 進行流量統計）。
  • 使用者行為日誌：記錄使用者的操作行為，用於大資料分析，比如監控、風控、推薦等等。這種日誌，一般是給其他團隊分析使用，而且可能是多個團隊，因此一般會有一定的格式要求，開發者應該按照這個格式來記錄，便於其他團隊的使用。當然，要記錄哪些行為、操作，一般也是約定好的，因此，開發者主要是執行的角色。

  • 根因分析（甩鍋必備）：即在關鍵地方記錄日誌。方便在和各個終端定位問題時，別人說時你的程式問題，你可以理直氣壯的拿出你的日誌說，看，我這裡運行了，狀態也是對的。這樣，對方就會乖乖去定位他的程式碼，而不是互相推脫。

什麼時候記錄日誌？

上文說了日誌的重要性，那麼什麼時候需要記錄日誌。

  • 系統初始化：系統或者服務的啟動引數。核心模組或者元件初始化過程中往往依賴一些關鍵配置，根據引數不同會提供不一樣的服務。務必在這裡記錄 INFO 日誌，打印出引數以及啟動完成態服務表述。
  • 程式語言提示異常：如今各類主流的程式語言都包括異常機制，業務相關的流行框架有完整的異常模組。這類捕獲的異常是系統告知開發人員需要加以關注的，是質量非常高的報錯。應當適當記錄日誌，根據實際結合業務的情況使用 WARN 或者 ERROR 級別。
  • 業務流程預期不符：除開平臺以及程式語言異常之外，專案程式碼中結果與期望不符時也是日誌場景之一，簡單來說所有流程分支都可以加入考慮。取決於開發人員判斷能否容忍情形發生。常見的合適場景包括外部引數不正確，資料處理問題導致返回碼不在合理範圍內等等。
  • 系統核心角色，元件關鍵動作：系統中核心角色觸發的業務動作是需要多加關注的，是衡量系統正常執行的重要指標，建議記錄 INFO 級別日誌，比如電商系統使用者從登入到下單的整個流程；微服務各服務節點互動；核心資料表增刪改；核心元件執行等等，如果日誌頻度高或者列印量特別大，可以提煉關鍵點 INFO 記錄，其餘酌情考慮 DEBUG 級別。
  • 第三方服務遠端呼叫：微服務架構體系中有一個重要的點就是第三方永遠不可信，對於第三方服務遠端呼叫建議列印請求和響應的引數，方便在和各個終端定位問題，不會因為第三方服務日誌的缺失變得手足無措。

日誌列印

Slf4j & Logback

Slf4j 英文全稱為 “ Simple Logging Facade for Java ”，為 Java 提供的簡單日誌門面。Facade 門面，更底層一點說就是介面。它允許使用者以自己的喜好，在工程中通過 Slf4j 接入不同的日誌系統。

Logback 是 Slf4j 的原生實現框架，同樣也是出自 Log4j 一個人之手，但擁有比 Log4j 更多的優點、特性和更做強的效能，Logback 相對於 Log4j 擁有更快的執行速度。基於我們先前在 Log4j 上的工作，Logback 重寫了內部的實現，在某些特定的場景上面，甚至可以比之前的速度快上 10 倍。在保證 Logback 的元件更加快速的同時，同時所需的記憶體更加少。

日誌檔案

日誌檔案放置於固定的目錄中，按照一定的模板進行命名，推薦的日誌檔名稱：

當前正在寫入的日誌檔名：<應用名>[-<功能名>].log
如：example-server-book-service-access.log
已經滾入歷史的日誌檔名：<應用名>[-<功能名>].yyyy-MM-dd-hh.[滾動號].log

如：example-server-book-service-access.2019-12-01-10.1.log

日誌變數定義

推薦使用 lombok（程式碼生成器） 註解 @lombok.extern.slf4j.Slf4j 來生成日誌變數例項。

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.10</version>
    <scope>provided</scope>
</dependency>

程式碼示例

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class LogTest {

    public static void main(String[] args) {
        log.info("this is log test");
    }
    
}

日誌配置

日誌記錄採用分級記錄，級別與日誌檔名相對應，不同級別的日誌資訊記錄到不同的日誌檔案中。如有特殊格式日誌，如 access log，單獨使用一個檔案，請注意避免重複列印（可使用 additivity="false" 避免 ）。

引數佔位格式

使用引數化形式 {} 佔位，[] 進行引數隔離，這樣的好處是可讀性更高，而且只有真正準備列印的時候才會處理引數。

// 正確示例，必須使用引數化資訊的方式
log.debug("order is paying with userId:[{}] and orderId : [{}]",userId, orderId);
// 錯誤示例，不要進行字串拼接,那樣會產生很多 String 物件，佔用空間，影響效能。及日誌級別高於此級別也會進行字串拼接邏輯。
log.debug("order is paying with userId: " + userId + " and orderId: " + orderId);

日誌的基本格式

日誌時間

作為日誌產生的日期和時間，這個資料非常重要，一般精確到毫秒。

yyyy-MM-dd HH:mm:ss.SSS

日誌級別

日誌的輸出都是分級別的，不同的設定不同的場合列印不同的日誌。

主要使用如下的四個級別：

  • DEBUG：DEUBG 級別的主要輸出除錯性質的內容，該級別日誌主要用於在開發、測試階段輸出。該級別的日誌應儘可能地詳盡，開發人員可以將各類詳細資訊記錄到 DEBUG 裡，起到除錯的作用，包括引數資訊，除錯細節資訊，返回值資訊等等，便於在開發、測試階段出現問題或者異常時，對其進行分析。
  • INFO：INFO 級別的主要記錄系統關鍵資訊，旨在保留系統正常工作期間關鍵執行指標，開發人員可以將初始化系統配置、業務狀態變化資訊，或者使用者業務流程中的核心處理記錄到INFO日誌中，方便日常運維工作以及錯誤回溯時上下文場景復現。建議在專案完成後，在測試環境將日誌級別調成 INFO，然後通過 INFO 級別的資訊看看是否能瞭解這個應用的運用情況，如果出現問題後是否這些日誌能否提供有用的排查問題的資訊。
  • WARN：WARN 級別的主要輸出警告性質的內容，這些內容是可以預知且是有規劃的，比如，某個方法入參為空或者該引數的值不滿足執行該方法的條件時。在 WARN 級別的時應輸出較為詳盡的資訊，以便於事後對日誌進行分析。
  • ERROR：ERROR 級別主要針對於一些不可預知的資訊，諸如：錯誤、異常等，比如，在 catch 塊中抓獲的網路通訊、資料庫連線等異常，若異常對系統的整個流程影響不大，可以使用 WARN 級別日誌輸出。在輸出 ERROR 級別的日誌時，儘量多地輸出方法入引數、方法執行過程中產生的物件等資料，在帶有錯誤、異常物件的資料時，需要將該物件一併輸出。

DEBUG / INFO 的選擇

DEBUG 級別比 INFO 低，包含除錯時更詳細的瞭解系統執行狀態的東西，比如變數的值等等，都可以輸出到 DEBUG 日誌裡。 INFO 是線上日誌預設的輸出級別，反饋系統的當前狀態給終端使用者看的。輸出的資訊，應該對終端使用者具有實際意義的。從功能角度上說，INFO 輸出的資訊可以看作是軟體產品的一部分，所以需要謹慎對待，不可隨便輸出。如果這條日誌會被頻繁列印或者大部分時間對於糾錯起不到作用，就應當考慮下調為 DEBUG 級別。

  • 由於 DEBUG 日誌列印量遠大於 INFO，出於前文日誌效能的考慮，如果程式碼為核心程式碼，執行頻率非常高，務必推敲日誌設計是否合理，是否需要下調為 DEBUG 級別日誌。
  • 注意日誌的可讀性，不妨在寫完程式碼 review 這條日誌是否通順，能否提供真正有意義的資訊。
  • 日誌輸出是多執行緒公用的，如果有另外一個執行緒正在輸出日誌，上面的記錄就會被打斷，最終顯示輸出和預想的就會不一致。

WARN / ERROR 的選擇

當方法或者功能處理過程中產生不符合預期結果或者有框架報錯時可以考慮使用，常見問題處理方法包括：

  • 增加判斷處理邏輯，嘗試本地解決：增加邏輯判斷吞掉報警永遠是最優選擇丟擲異常，交給上層邏輯解決
  • 丟擲異常，交給上層邏輯解決
  • 記錄日誌，報警提醒
  • 使用返回碼包裝錯誤做返回

一般來說，WARN 級別不會簡訊報警，ERROR 級別則會簡訊報警甚至電話報警，ERROR 級別的日誌意味著系統中發生了非常嚴重的問題，必須有人馬上處理，比如資料庫不可用，系統的關鍵業務流程走不下去等等。錯誤的使用反而帶來嚴重的後果，不區分問題的重要程度，只要有問題就error記錄下來，其實這樣是非常不負責任的，因為對於成熟的系統，都會有一套完整的報錯機制，那這個錯誤資訊什麼時候需要發出來，很多都是依據單位時間內 ERROR 日誌的數量來確定的。

強調ERROR報警

  • ERROR 級別的日誌列印通常伴隨報警通知。ERROR的報出應該伴隨著業務功能受損，即上面提到的系統中發生了非常嚴重的問題，必須有人馬上處理。

ERROR日誌目標

  • 給處理者直接準確的資訊：ERROR 資訊形成自身閉環。

問題定位：

  • 發生了什麼問題，哪些功能受到影響
  • 獲取幫助資訊：直接幫助資訊或幫助資訊的儲存位置
  • 通過報警知道解決方案或者找何人解決

執行緒名稱

輸出該日誌的執行緒名稱，一般在一個應用中一個同步請求由同一執行緒完成，輸出執行緒名稱可以在各個請求產生的日誌中進行分類，便於分清當前請求上下文的日誌。

opentracing 標識

在分散式應用中，使用者的一個請求會呼叫若干個服務完成，這些服務可能還是巢狀呼叫的，因此完成一個請求的日誌並不在一個應用的日誌檔案，而是分散在不同伺服器上不同應用節點的日誌檔案中。該標識是為了串聯一個請求在整個系統中的呼叫日誌。

  • 唯一字串（trace id）
  • 呼叫層級（span id）

通過搜尋 trace id 就可以查到這個 trace id 標識的請求在整個系統中流轉（處理）過程中產生的所有日誌。

biz 標識

在業務開發中，我們的日誌都是和業務相關聯的，有時候是需要根據使用者或者業務做聚類的，因此一次請求如果可以通過某項標識做聚類的時候，可以將聚類標識列印到日誌中。

  • 使用者標識（user id）
  • 業務標識（biz id）

日誌記錄器名稱

日誌記錄器名稱一般使用類名，日誌檔案中可以輸出簡單的類名即可，看實際情況是否需要使用包名和行號等資訊。主要用於看到日誌後到哪個類中去找這個日誌輸出，便於定位問題所在。

日誌內容

禁用 System.out.println 和 System.err.println

變參替換日誌拼接

輸出日誌的物件，應在其類中實現快速的 toString 方法，以便於在日誌輸出時僅輸出這個物件類名和 hashCode

預防空指標:不要在日誌中呼叫物件的方法獲取值，除非確保該物件肯定不為 null，否則很有可能會因為日誌的問題而導致應用產生空指標異常。

異常堆疊

異常堆疊一般會出現在 ERROR 或者 WARN 級別的日誌中，異常堆疊含有方法呼叫鏈的系統，以及異常產生的根源。異常堆疊的日誌屬於上一行日誌的，在日誌收集時需要將其劃至上一行中。

最佳實踐

日誌格式

2019-12-01 00:00:00.000|pid|log-level|[svc-name,trace-id,span-id,user-id,biz-id]|thread-name|package-name.class-name : log message
  • 時間
  • pid，pid
  • log-level，日誌級別
  • svc-name，應用名稱
  • trace-id，呼叫鏈標識
  • span-id，呼叫層級標識
  • user-id，使用者標識
  • biz-id，業務標識
  • thread-name，執行緒名稱
  • package-name.class-name，日誌記錄器名稱
  • log message，日誌訊息體

日誌模組擴充套件

日誌模組是基於以下技術點做擴充套件的。

  • Slf4j MDC 實現原理（暫不開展詳解，如有興趣私下溝通）
  • Opentracing Scope 原理（暫不開展詳解，如有興趣私下溝通）

在每個 tracing 鏈路中，將 Opentracing Scope 中的上下文資訊放置 MDC 中，根據 Spring Boot Logging 擴充套件介面擴充套件的取值邏輯 logging.pattern.level 的取值邏輯。

相關原始碼參考

Spring Cloud Sleuth

[Spring Cloud Sleuth][https://github.com/spring-cloud/spring-cloud-sleuth/blob/master/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/log/Slf4jCurrentTraceContext.java](https://github.com/spring-cloud/spring-cloud-sleuth/blob/master/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/log/Slf4jCurrentTraceContext.java)

修改 logback 配置檔案中每個 appender 的 pattern 為以下預設值即可實現標準化。

%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}|${PID:- }|%level|${LOG_LEVEL_PATTERN:-%5p}|%t|%-40.40logger{39}: %msg%n

logback.xml 節選

<configuration>
<property name="LOG_PATH"
          value="${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}"/>

<springProperty scope="context" name="APP_NAME"
                source="spring.application.name" defaultValue="spring-boot-fusion"/>
<!-- 全域性統一 pattern -->
<property name="LOG_PATTERN"
          value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}|${PID:- }|%level|${LOG_LEVEL_PATTERN:-%5p}|%t|%-40.40logger{39}: %msg%n"/>
<!-- 輸出模式 file,滾動記錄檔案，先將日誌檔案指定到檔案，當符合某個條件時，將日誌記錄到其他檔案 -->
<appender name="fileInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--被寫入的檔名，可以是相對目錄，也可以是絕對目錄，如果上級目錄不存在會自動建立，沒有預設值。-->
    <file>${LOG_PATH}/${APP_NAME}-info.log</file>
    <!--滾動策略  基於時間的分包策略 -->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!-- yyyy-MM-dd 時間策略則為一天一個檔案 -->
        <FileNamePattern>${LOG_PATH}/${APP_NAME}-info.%d{yyyy-MM-dd-HH}.%i.log</FileNamePattern>
        <!--日誌檔案保留小時數-->
        <MaxHistory>48</MaxHistory>
        <maxFileSize>1GB</maxFileSize>
        <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
    <!--  layout 負責把事件轉換成字串，格式化的日誌資訊的輸出 -->
    <layout class="ch.qos.logback.classic.PatternLayout">
        <pattern>${LOG_PATTERN}</pattern>
    </layout>
    <!--級別過濾器，根據日誌級別進行過濾。如果日誌級別等於配置級別，過濾器會根據onMath 和 onMismatch接收或拒絕日誌-->
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <!--設定過濾級別-->
        <level>INFO</level>
        <!--用於配置符合過濾條件的操作-->
        <onMatch>ACCEPT</onMatch>
        <!--用於配置不符合過濾條件的操作-->
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>
</configuration>

程式碼使用示例：

@Override
public Result<PagingObject<SimpleResponse>> page(@RequestParam(value = "page-num", defaultValue = "1") int pageNum,
                                                 @RequestParam(value = "page-size", defaultValue = "10") int pageSize) {
    LogStandardUtils.putUserId("userId123");
    LogStandardUtils.putBizId("bizId321");
    producerService.sendMsg("xxx");
    simpleClient.page(pageNum, pageSize);
    return new Result<>(simpleService.page(pageNum, pageSize));
}

日誌記錄

2019-12-04 16:29:08.223|43546|INFO|[example-server-book-service,ac613cff04bac8b1,4a9adc10fdf0eb5,userId123,bizId321]|XNIO-1 task-4|c.n.u.concurrent.ShutdownEnabledTimer   : Shutdown hook installed for: NFLoadBalancer-PingTimer-example-server-order-service
2019-12-04 16:29:08.224|43546|INFO|[example-server-book-service,ac613cff04bac8b1,4a9adc10fdf0eb5,userId123,bizId321]|XNIO-1 task-4|c.netflix.loadbalancer.BaseLoadBalancer : Client: example-server-order-service instantiated a LoadBalancer: DynamicServerListLoadBalancer:{NFLoadBalancer:name=example-server-order-service,current list of Servers=[],Load balancer stats=Zone stats: {},Server stats: []}ServerList:null
2019-12-04 16:29:08.234|43546|INFO|[example-server-book-service,ac613cff04bac8b1,4a9adc10fdf0eb5,userId123,bizId321]|XNIO-1 task-4|c.n.l.DynamicServerListLoadBalancer     : Using serverListUpdater PollingServerListUpdater
2019-12-04 16:29:08.247|43546|INFO|[example-server-book-service,ac613cff04bac8b1,4a9adc10fdf0eb5,userId123,bizId321]|XNIO-1 task-4|c.n.l.DynamicServerListLoadBalancer     : DynamicServerListLoadBalancer for client example-server-order-service initialized: DynamicServerListLoadBalancer:{NFLoadBalancer:name=example-server-order-service,current list of Servers=[],Load balancer stats=Zone stats: {},Server stats: []}ServerList:ConsulServerList{serviceId='example-server-order-service', tag=null}
2019-12-04 16:29:08.329|43546|WARN|[example-server-book-service,ac613cff04bac8b1,4a9adc10fdf0eb5,userId123,bizId321]|XNIO-1 task-4|c.p.f.l.ctl.common.rule.StrategyRule    : No up servers available from load balancer: DynamicServerListLoadBalancer:{NFLoadBalancer:name=example-server-order-service,current list of Servers=[],Load balancer stats=Zone stats: {},Server stats: []}ServerList:ConsulServerList{serviceId='example-server-order-service', tag=null}
2019-12-04 16:29:08.334|43546|WARN|[example-server-book-service,ac613cff04bac8b1,4a9adc10fdf0eb5,userId123,bizId321]|XNIO-1 task-4|c.p.f.l.ctl.common.rule.StrategyRule    : No up servers available from load balancer: DynamicServerListLoadBalancer:{NFLoadBalancer:name=example-server-order-service,current list of Servers=[],Load balancer stats=Zone stats: {},Server stats: []}ServerList:ConsulServerList{serviceId='example-server-order-service', tag=null}
2019-12-04 16:29:08.342|43546|ERROR|[example-server-book-service,ac613cff04bac8b1,4a9adc10fdf0eb5,userId123,bizId321]|XNIO-1 task-4|c.p.f.w.c.advice.ExceptionHandlerAdvice : 當前程式進入到異常捕獲器，出錯的 url 為：[ http://127.0.0.1:10011/simples ]，出錯的引數為：[ {"querystring":"{}","payload":""} ]
java.lang.RuntimeException: com.netflix.client.ClientException: Load balancer does not have available server for client: example-server-order-service

日誌服務

SLS 阿里雲日誌服務

阿里雲日誌服務（簡稱 SLS）是針對日誌類資料的一站式服務，在阿里巴巴集團經歷大量大資料場景錘鍊而成。您無需開發就能快捷完成日誌資料採集、消費、投遞以及查詢分析等功能，提升運維、運營效率，建立 DT 時代海量日誌處理能力。

project

專案、管理日誌基礎單元，服務日誌建議一個環境建為一個 Project，這樣日誌記錄是整體一個閉環，日誌記錄隨整個環境內的服務呼叫產生。

logstore

日誌庫，日誌庫建議按照日誌型別分為不同的，如特定格式的 access 日誌，以及 info / warn / error 日誌，特定格式可以配置更為方面的索引以及告警設定。

注意：請勿按照應用服務區分為不同的 logstore，在微服務架構中，一次請求交叉了多個應用服務，日誌是散落在各個應用服務中的，按照服務區分 logstore，需要開發同學十分了解應用執行狀況和呼叫拓撲圖，這點往往是不具備的。

實時採集與消費

功能：

  • 通過ECS、容器、移動端、開源軟體、JS等接入實時日誌資料（例如Metric、Event、BinLog、TextLog、Click等）。
  • 提供實時消費介面，與實時計算及服務對接。

用途：資料清洗（ETL）、流計算（Stream Compute）、監控與報警、 機器學習與迭代計算。

查詢分析

實時索引、查詢分析資料。

  • 查詢：關鍵詞、模糊、上下文、範圍。
  • 統計：SQL聚合等豐富查詢手段。
  • 視覺化：Dashboard + 報表功能。
  • 對接：Grafana、JDBC/SQL92。

用途：DevOps / 線上運維，日誌實時資料分析，安全診斷與分析，運營與客服系統。

消費投遞

穩定可靠的日誌投遞。將日誌中樞資料投遞至儲存類服務進行儲存。支援壓縮、自定義Partition、以及行列等各種儲存方式。

用途：資料倉庫 + 資料分析、審計、推薦系統與使用者畫像。

告警

日誌服務的告警功能基於儀表盤中的查詢圖表實現。在日誌服務控制檯查詢頁面或儀表盤頁面設定告警規則，並指定告警規則的配置、檢查條件和通知方式。設定告警後，日誌服務定期對儀表盤的查詢結果進行檢查，檢查結果滿足預設條件時傳送告警通知，實現實時的服務狀態監控。

最佳實踐

阿里雲的日誌服務功能相當強大，想用好日誌服務可以參看：

https://help.aliyun.com/document_detail/29090.html?spm=a2c4g.11186623.6.1079.4edd3aabvs50OW

ELK 通用日誌解決方案

ELK 是 Elasticsearch、Logstash、Kibana 三大開源框架首字母大寫簡稱。市面上也被成為 Elastic Stack。其中 Elasticsearch 是一個基於 Lucene、分散式、通過 Restful 方式進行互動的近實時搜尋平臺框架。像類似百度、谷歌這種大資料全文搜尋引擎的場景都可以使用 Elasticsearch 作為底層支援框架，可見 Elasticsearch 提供的搜尋能力確實強大，市面上很多時候我們簡稱 Elasticsearch 為 es。Logstash 是 ELK 的中央資料流引擎，用於從不同目標（檔案/資料儲存/MQ）收集的不同格式資料，經過過濾後支援輸出到不同目的地（檔案/ MQ / Redis / Elasticsearch / Kafka 等）。Kibana 可以將 Elasticsearch 的資料通過友好的頁面展示出來，提供實時分析的功能。

實踐說明

普通格式日誌

2019-11-26 15:01:03.332|1543|INFO|[example-server-book-service,28f019d57b8336ab,630697c7f34ca4fa,105,45982043|XNIO-1 task-42]|c.p.f.w.pay.PayServiceImpl     : order is paying with userId: 105 and orderId: 45982043

普通日誌字首是固定的，可以固定分詞索引，方便更快的查詢分析。

特定格式日誌

以 access 日誌為例

2019-11-26 15:01:03.332|1543|INFO|[example-server-book-service,28f019d57b8336ab,630697c7f34ca4fa,105,45982043|XNIO-1 task-42]|c.p.f.w.logging.AccessLoggingFilter     : 
> url: http://liweichao.com:10011/actuator/health
> http-method: GET
> request-header: [Accept:"text/plain, text/*, */*", Connection:"close", User-Agent:"Consul Health Check", Host:"liweichao.com:10011", Accept-Encoding:"gzip"]
> request-time: 2019-11-26 15:01:03.309
> querystring: -
> payload: -
> extra-param: -

< response-time: 2019-11-26 15:01:03.332
< take-time: 23
< http-status: 200
< response-header: [content-type:"application/vnd.spring-boot.actuator.v2+json;charset=UTF-8", content-size:"15"]
< response-data: {"status":"UP"}

特定格式日誌可按格式建立索引更方便聚焦查詢分析和告警，如根據 take-time，http-status，biz-code 等值。

參考文獻

  • [ Java日誌記錄最佳實踐 ](https://www.jianshu.com/p/546e9aace657
  • [ 別在 Java 程式碼裡亂打日誌了，這才是列印日誌的正確姿勢！ ](https://mp.weixin.qq.com/s/hJvkRlt9xQbWhYy1G7ZDsw
  • [ 阿里雲日誌服務 ](https://help.aliyun.com/product/28958.html?spm=a2c4g.11186623.3.1.7cfd735dv8i1pB
  • [ Spring Boot Logging ](https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/reference/html/spring-boot-features.html#boot-features-logging
  • [ Spring Cloud Sleuth ](https://github.com/spring-cloud/spring-cloud-sleuth
  • [ Opentracing ](https://github.com/opentracing

作者說明

來自讀者投稿，有好的文章歡迎聯絡我微信 jihuan900

相關推薦

驚訝！我定的日誌規範被CTO在全公司推廣了

列印日誌是一門藝術，但長期被開發同學所忽視。日誌就像車輛保險，沒人願意為保險付錢，但是一旦出了問題都又想有保險可用。我們列印日誌的時候都很隨意，可是用的時候會吐槽各種 SB 包括自己！寫好每一條日誌吧，與君共勉！ 日誌 日誌是什麼？ 日誌，維基百科的定義是記錄伺服器等電腦裝置或軟體的運作。 日誌檔案提供精

為什麽我的對象被 IntelliJ IDEA 悄悄的修改了？

pre 需要 驗證 開發人員 alter uil http 你在 false 背景 ????最近，在復習JUC的時候調試了一把ConcurrentLinkedQueue的offer方法，意外的發現Idea在debug模式下竟然會 “自動修改” 已經創建的Java對象，當時覺

企業請人做網站被網絡公司騙了怎麽辦？網站建設制作外包需要註意什麽事項？

升級 提高 視覺 企業網 了解 到你 是你 減少 網絡建設 記得之前一個建站客戶找王晴兒聊天，客戶分享了她之前找人做網站被騙的經歷，經歷分享完後客戶不但沒有任何抱怨，反而看得很開，真是讓我也感慨頗深，覺得應學會寬容傷害自己的人，因為他們很可憐，各人都有自己的難處，大家都不容

日誌大了，怎麽辦？用我的日誌切割腳本吧！

fix ref str 觸發 body article ron left param 本文轉載自https://www.imooc.com/article/13260 分享一個腳本,它配合linux系統的crontab任務，對nginx自動日誌切割和清理，分別作用於ACC

自從會了這招，我就再也不擔心我的爬蟲會被封了！搭建Cookies池

detail http containe TP bad pst pro ear tip 但是，這個接口在沒有登錄的情況下會有請求頻率檢測。如果一段時間內訪問太過頻繁，比如打開這個鏈接，一直不斷刷新，則會看到請求頻率過高的提示，如下圖所示。 一、本

大表哥微信給我發了很多資源！結果被和諧了！Python秒存不被和諧

保存 微信 右上角 瀏覽器 python dff 方法 百度 不錯 最近大表哥老是給我發一些雲盤鏈接，裏面經常也有發視頻的雲盤鏈接，小編對此挺好奇的，所以決定點進去看看，看看每天發的這樣的雲盤鏈接裏面都是什麽樣的視頻，當然小編是有私心的。以為你們是某些方面的動作片嘛

我的編碼習慣 —— 日誌規範

開發中日誌這個問題，每個公司都強調，也制定了一大堆規範，但根據實際情況看，效果不是很明顯，主要是這個東西不好測試和考核，沒有日誌功能一樣跑啊。 但程式設計活久見，開發久了，總會遇到“這個問題生產環境上能重現，但是沒有日誌，業務很複雜，不知道哪一步出錯了？” 這個時候，怎麼辦？ 還能怎麼辦，發個版

我就是要用MD5！不用不行！那麼，怎麼防止被拖庫後洩露使用者密碼？

寫在開頭 最近(2015年10月20日前後)某郵箱系統被曝“洩露”了上億使用者資料，包括密碼、密保問題等。無論是確有安全漏洞導致被“拖庫”，還是有心人利用“撞庫”的方法獲得的使用者資料，從留出的資料來看，使用者的密碼、密保等資訊都還是使用的MD5 Hash摘要進行儲存。

初級java編程，大神多多點評。我定虛心接受！

break 用戶 nbsp exti sta int() system java else import java.util.Scanner;import java.util.Random;public class Vc{ public static void mai

我的第一本書，被選作大學教材了！

這真是意料之外！ 去年年初，接受清華大學出版社夏老師的邀請，下定決心開始寫我的第一本書，戰戰兢兢早起晚睡，好幾個月都沒有陪女票出去玩，辛辛苦苦終於在年底的時候新書順利上市！ 銷量出乎意料 新書上市之後，剛開始想的是首印的能賣完就不錯了，千萬別砸到出版社手裡了。鬆哥的公眾號當時也只有 4000 多人，而且

女人們，這些技術男真的被“雙十一”逼“瘋”了！

align tom 我們 墨菲定律 都是 歷程 wid 前三 鍵盤 　　每到“雙十一”都是女人購物狂歡日，你家女人是不是都守到電腦前、手機上搶到手抖？但是你有沒有想過。這裏面支撐這麽多人瘋狂購物的技術系統碼農們都是怎麽過的？ 　　前些日子遇到了淘寶的一個技術小二

告訴你們！我是怎麽與Linux系統觸電的！

windows linux 阿裏雲 臺式機 試驗機 最開始接觸Linux是在15年來北京後，剛來北京機緣巧合，從事了實施工程師的工作。實施工作是一個面很廣的工作。業務、技術、溝通等等方方面面的。技術一直是我是的短板。剛開始，公司在要在阿裏雲上部署APP與商城。在公司，想發展，提升。就必須學

讓我們把KBEngine玩壞吧！如何定制我們自己的C++函數（一）

data ase erro glob alt ins sin 程序 all 為什麽不更新kbe warring的代碼解讀了，因為在我看來那個demo講完了實體就沒東西可講了，如果專心的看官方文檔和PPT的話demo的代碼後面沒任何難點了已經，單純的復制黏貼代碼實在太過無聊。

置頂！！！ 我想說的東西

span 宋體 使用 pan 人才 領域 spa python語言 包括 　　本人才接觸這個領域，學識尚淺，發表的內容僅是一些個人的理解，如有不對，歡迎大家的評論區裏指出，如有問題，也可以在評論區裏提出，我會抽時間解答 　　註意： 　　　　　　leetcode分類中，我使用

【轉載】運維職業向！我是怎麽入得運維行業？運維工程師入門必備技能以及打怪升級篇

能說 還要 作用 經歷 人工智能 details 最大堆 orm lock 前言:轉載 陳浩一個從事安全運維向的前輩文章。寫的很好。人非常nice，遇到了問題，qq上很快就回復了我。 大道三千 入門最難，凡事入了行，也就什麽都好說了，好的自然不斷努力奮鬥修行，不好的自然很快

幹貨分享！懸浮按鈕設計規範和經典實踐

原型設計 交互設計 界面設計 設計師 懸浮按鈕 懸浮按鈕（Floating Action Button，簡稱FAB）是APP應用中常見的UI元件。它輕盈、優雅、便捷又高效，是Google設計語言中一顆璀璨的明珠。懸浮按鈕往往都會獨立出現在界面之上，提升整體的導航，拓展頁面的功能，使應

誰當年還沒看過幾本小說！我用Python爬取全站的的小說！

nec 打印 b數 技術分享 mon 結果 鏈接 ons ide 然後再將請求發送出去，定義變量response，用read（）方法觀察，註意將符號解碼成utf-8的形式，省的亂碼： 打印一下看結果： 看到這麽

人生的意義，呵！我找到了

吃火鍋 總監 之間 找到 2018年 人際關系 遇到 妹子 日子 現在是2018年6月4日淩晨四點，咖啡撐著我沒有睡意，思緒滿千，寫下這篇文章。 淩晨一點的時候，我一直在刷抖音到三點。十點的時候，我才到家，打了幾把王者榮耀，連輸未贏。白天，還剛剛看完動漫，天行九歌。 這就是

【親測有效】主頁鎖定神器，媽媽再也不用擔心我電腦瀏覽器主頁被劫持篡改了

text 問題 img strong 密碼 TE build log 電腦 很多朋友都在網上下載一些軟件或者重裝系統後發現，瀏覽器主頁被鎖定了，不管怎麽修改都改不過來，即便是殺毒軟件也拿它沒辦法，這次給大家一個自己親測的主頁鎖定神器，穩妥的解決主頁問題。 註意：主頁鎖定神

項目實戰！我用Python爬取了14年所有的福彩3D信息

下載器 rap 寫入excel url req 理論 ola text port 前兩天，在網上看到一個有意思的問題：×××靠譜麽？為什麽還有那麽多的人相信×××？ 暫且不說，×××是否靠譜？×××也分人而異，江湖上騙術很多，有些甚至會誤以為×××的準確度可以很高，這些操盤