程序中的日志

本文轉載自查看原文 2019-07-08 16:46 1177 程序構建

程序中的日志

程序中的日志

日志實際上只是一種按照時間順序存儲記錄的數據表或文件
它記錄了什么時間發生了什么事情。而對分布式數據系統，在許多方面，這是要解決的問題的真正核心

日志概念和分類

應用程序中的日志

tomcat 日志

數據庫中的日志

日志記錄了發生了什么，而每個表或者索引都是更改歷史中的一個投影。由於日志是立即持久化的，發生崩潰時，可以作為恢復其他所有持久化結構的可靠來源

機器可識別的日志的概念主要都被局限在數據庫的內部。日志作為做數據訂閱機制的用法似乎是偶然出現的。但這正是支持各種的消息傳輸、數據流和實時數據處理的理想抽象

分布式系統中的日志

分布式系統以日志為中心的方案是來自於一個簡單的觀察，我們稱之為狀態機復制原理（State Machine Replication Principle）：

如果兩個相同的、確定性的進程從同一狀態開始，並且以相同的順序獲得相同的輸入，那么這兩個進程將會生成相同的輸出，並且結束在相同的狀態

確定性（deterministic）
和冪等概念類似，同樣的輸入，任何情況都得到同樣的輸出
意味着處理過程是與時間無關的，而且不會讓任何其他『帶外』輸入（"out of band" input）影響其處理結果

舉例：
我們甚至可以記錄各個副本執行的機器指令序列的日志或是所調用的方法名和參數序列的日志。只要兩個進程用相同的方式處理這些輸入，這些副本進程就會保持一致的狀態。

物理與邏輯日志
對日志用法不同群體有不同的說法。數據庫工作者通常說成物理日志（physical logging）和邏輯日志（logical logging）。物理日志是指記錄每一行被改變的內容。邏輯日志記錄的不是改變的行而是那些引起行的內容改變的SQL語句（insert、update和delete語句）

狀態機器模型
分布式系統文獻通常把處理和復制（processing and replication）方案寬泛地分成兩種。『狀態機器模型』

『主-主模型』（active-active model），記錄輸入請求的日志，各個復本處理每個請求。
『主-備模型』（primary-backup model），即選出一個副本做為leader，讓leader按請求到達的順序處理請求，並輸出它請求處理的狀態變化日志。其他的副本按照順序應用leader的狀態變化日志，保持和leader同步，並能夠在leader失敗的時候接替它成為leader。

變更日志（changelog）101：表與事件的二象性（duality）

變更的日志和表之間有着迷人的二象性。日志類似借貸清單和銀行處理流水，而數據庫表則是當前賬戶的余額。如果有變更日志，你就可以應用這些變更生成數據表並得到當前狀態

可以認識到日志是更基本的數據結構：日志除了可用來創建原表，也可以用來創建各類衍生表
表與事件的二象性：表支持了靜態數據，而日志記錄了變更。日志的魅力就在於它是變更的完整記錄，它不僅僅包含了表的最終版本的內容，而且可以用於重建任何存在過其它版本。事實上，日志可以看作是表每個歷史狀態的一系列備份

表與事件是數據在不同條件/場景下數據的性質，是對人們對數據的認識、理解或描述方式。

版本控制系統通過日志來完成復制：更新代碼即是拉下補丁並應用到你的當前快照中。

日志結構設計

這塊沒有總結出一個完成的定義，還是把各種實現方式帶給大家，讓大家來理解看看大家有沒有其他的更好的理解和建議

OpenTracing語義標准規范及實現
https://www.jianshu.com/p/a963ad0bbe3e

如何使用 AOP 和自定義注解實現請求方法前后日志打印
https://mp.weixin.qq.com/s/J9eyqIx5Oq-z6mYv8j1zpg

在SpringBoot項目中添加logback的MDC
（Mapped Diagnostic Context，用於打LOG時跟蹤一個“會話“、一個”事務“）
https://blog.csdn.net/hongyang321/article/details/78803584

服務端最佳日志實踐（v2.0）
https://zhuanlan.zhihu.com/p/27363484

基於elk的業務日志格式設計
https://segmentfault.com/a/1190000008227989

跟蹤日志，程序日志，操作日志
http://dev.bingocc.com/dtls/logs/prog.html

{
    "type": 
    "trace_id":
    "span_id":
    "thread":
    "timestamp":
    "source_host":
    "component":    
    "logs": [
        {"LogItem":"LogItem"}
    ]
}

LogItem

{
    "level":
    "thread":
    "timestamp":
    "logger":    
    "message":
    "stack":
    "tags": {
    }
}

日志能做什么事情

線上日志排錯

我們平常使用的 tail -f xxx.log 的形式，來動態觀察錯誤，調試程序

借助 ELK,GreyLog 等第三方工具監控程序

方便查看
使用這類工具依賴可以有web界面來查看log，使用起來更友好，搜索條件，無需熟悉linux命令，即可快速的查詢指定時間段的log或是包含指定關鍵字的log

聚類分析
elk 和 grey log都有一點分析圖表和監控報警功能，都可以幫忙實現應用監控指標分析和報警

借助FileBeat,Flume等工具自定義日志收集

自定義日志收集處理
服務端接收到格式化的日志log，對log進行業務分析和統計，對程序狀態，應用使用，業務狀態進行分析，並能對突發情況作出預警和響應緊急措施

一段nginx log示例
-- 01 online-php7-6 2018-04-20T12:00:00+08:00 2018-04-20T12:00:00+08:00 0 web 34055 272408431 read_article {"novel_id":"2460","article_id":"883878","price":"35","consume":0}

各個字段含義
-- version, hostname, occur_time, log_time, type, platform, user_id, action, action_json

version: 01
hostname: online-php7-6 hostname
occur_time: 2018-04-20T12:00:00+08:00
log_time: 2018-04-20T12:00:00+08:00
platform: web
user_id: 367245568
action: read_article {"novel_id":"1542","article_id":"672651","price":"35","consume":1}

業務含義
根據上述的打印方式可以追蹤到app內部每個模塊業務被觸發的頻次，這只是處理了業務這一范圍，其實還可以有很多范圍比如：關鍵業務路徑范圍，業務異常警告報錯范圍 等等，一切圍繞應用的日志

日志該怎么打印

什么時候應該打日志

當你遇到問題的時候，只能通過debug功能來確定問題，你應該考慮打日志，良好的系統，是可以通過日志進行問題定為的。
當你碰到if…else 或者 switch這樣的分支時，要在分支的首行打印日志，用來確定進入了哪個分支
經常以功能為核心進行開發，你應該在提交代碼前，可以確定通過日志可以看到整個流程

基本格式

必須使用參數化信息的方式:

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);

對於debug日志，必須判斷是否為debug級別后，才進行使用:

if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " +id + " symbol: " + symbol);
}

使用[]進行參數變量隔離

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);

並不是所有的service都進行出入口打點記錄,單一、簡單service是沒有意義的(job除外,job需要記錄開始和結束,)。
反例(不要這么做):

public List listByBaseType(Integer baseTypeId) {


   log.info("開始查詢基地");
BaseExample ex=new BaseExample();
BaseExample.Criteria ctr = ex.createCriteria();
ctr.andIsDeleteEqualTo(IsDelete.USE.getValue());
Optionals.doIfPresent(baseTypeId, ctr::andBaseTypeIdEqualTo);
   log.info("查詢基地結束");
return baseRepository.selectByExample(ex);


}

對於復雜的業務邏輯，需要進行日志打點，以及埋點記錄，比如電商系統中的下訂單邏輯，以及OrderAction操作(業務狀態變更)

重要的狀態的變更發送事件並留出監聽接口,這個主題下含義是至少要打印log

service為SOA架構，微服務架構，REST接口，那么可以看成是一個外部接口提供方，那么必須記錄入參。

調用其他第三方服務時，所有的出參和入參是必須要記錄的(因為你很難追溯第三方模塊發生的問題)

特別詳細的系統運行完成信息，業務代碼中，不要使用.(除非有特殊用意，否則請使用DEBUG級別替代)

@Override
@Transactional
public void createUserAndBindMobile(@NotBlank String mobile, @NotNull User user) throws CreateConflictException{
    boolean debug = log.isDebugEnabled();
    if(debug){
        log.debug("開始創建用戶並綁定手機號. args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user));
    }
    try {
        user.setCreateTime(new Date());
        user.setUpdateTime(new Date());
        userRepository.insertSelective(user);
        if(debug){
            log.debug("創建用戶信息成功. insertedUser=[{}]",LogObjects.toString(user));
        }
        UserMobileRelationship relationship = new UserMobileRelationship();
        relationship.setMobile(mobile);
        relationship.setOpenId(user.getOpenId());
        relationship.setCreateTime(new Date());
        relationship.setUpdateTime(new Date());
        userMobileRelationshipRepository.insertOnDuplicateKey(relationship);
        if(debug){
            log.debug("綁定手機成功. relationship=[{}]",LogObjects.toString(relationship));
        }
        log.info("創建用戶並綁定手機號. userId=[{}],openId=[{}],mobile=[{}]",user.getId(),user.getOpenId(),mobile); 
        // 如果考慮安全，手機號記得脫敏
    }catch(DuplicateKeyException e){
        log.info("創建用戶並綁定手機號失敗,已存在相同的用戶. openId=[{}],mobile=[{}]",user.getOpenId(),mobile);
        throw new CreateConflictException("創建用戶發生沖突, openid=[%s]",user.getOpenId());
    }
}