前言
分散式系統的執行環境往往是異常複雜的，很多情況涉及到多節點間的訊息通訊。相比較於單節點系統而言，分散式系統在問題追蹤，排查方面顯然也複雜很多。那麼這個時候，在分散式系統中，增加哪些型別的日誌資料，來幫助我們發現和定位問題呢？答案就是我們今天將要闡述的審計日誌（Audit log）。

審計日誌的概念
很多人可能在想這樣一個問題：同樣是日誌，審計日誌和普通的日誌，區別在於哪裡呢？

審計日誌，英文名為audit log，而audit這個單詞的中文意思為“查賬”，說明這些資訊是具有準確記錄的，並且會有規定的（賬單）格式。也就是說，審計日誌它會明確記錄過往的“操作流水”，並且每天記錄格式規則統一。這樣能夠方便地幫助我們分析這些日誌。在分散式系統中，這些“操作流水”其實就是系統中每一次的操作行為。

下面筆者截取了HDFS的audit日誌做為例子，如下：

2018-11-09 16:08:37,209 INFO FSNamesystem.audit: allowed=true ugi=hdfs (auth:SIMPLE) ip=xx.xx.xx.xx cmd=rename src=/tmp dst=/tmp2 perm=hdfs:hdfs:rw-r–r-- proto=rpc
2018-11-09 16:08:37,209 INFO FSNamesystem.audit: allowed=true ugi=hdfs (auth:SIMPLE) ip=/xx.xx.xx.xx cmd=open src=/data dst=null perm=null proto=rpc

我們可以看到，每天記錄都準確地記下了每次操作行為的具體屬性資訊，因為日誌格式非常規則化，我們完全可以將它們做文字處理分析，然後匯入到SQL表裡進一步進行查詢分析。比如可以做“哪個時間段，哪部分操作佔比最多”等等類似這樣的查詢。

審計日誌功能類的編寫
審計日誌說到底它還是一種日誌，只是經過人為的加工包裝後再輸出。所以對於審計日誌工具類的開發來說，其實並不是特別難的。主要實現以下幾點：

定義好訊息的統一格式
構造出靈活的訊息構建模式
複用Logger日誌例項進行日誌列印
第一點，訊息格式的定義。這個決定了訊息的最終輸出內容，這個在開始時是一定要設想好的，哪些屬性要必須輸出的，哪些是可選的。下面是一個例子：

private static final String MSG_PATTERN =
“user=%s | ip=%s | op=%s %s | ret=%s”;

這裡，我們用pattern模式的方法，要比直接字串append方式組裝靈活許多。
在上面的格式裡，我們定義了4個屬性值。

然後是對於日誌訊息的構造，這裡強調的是靈活性，我們可以用構建者模式來做，示例程式碼如下：

首先AuditMessage訊息物件如下：

/**
 * Defines audit message structure.
 */
public class AuditMessage implements Message {

  private String message;
  private Throwable throwable;

  private static final String MSG_PATTERN =
      "user=%s | ip=%s | op=%s %s | ret=%s";
  ...

  /**
   * Builder class for AuditMessage.
   */
  public static class Builder {
    private Throwable throwable;
    private String user;
    private String ip;
    private String op;
    private Map<String, String> params;
    private String ret;

    public Builder(){

    }

    public Builder setUser(String usr){
      this.user = usr;
      return this;
    }

    public Builder atIp(String ipAddr){
      this.ip = ipAddr;
      return this;
    }

    public Builder forOperation(String operation){
      this.op = operation;
      return this;
    }

    public Builder withParams(Map<String, String> args){
      this.params = args;
      return this;
    }

    public Builder withResult(String result){
      this.ret = result;
      return this;
    }

    public Builder withException(Throwable ex){
      this.throwable = ex;
      return this;
    }

    public AuditMessage build(){
      AuditMessage auditMessage = new AuditMessage();
      // 用format方法構建完整訊息
      auditMessage.message = String.format(MSG_PATTERN,
          this.user, this.ip, this.op, this.params, this.ret);
      auditMessage.throwable = this.throwable;
      return auditMessage;
    }
  }

然後在定義日誌輸出類，來輸出這個message物件例項：

/**
 * Class to define Audit Logger for Ozone.
 */
public class AuditLogger {

  ...

  /**
   * Initializes the logger with specific type.
   * @param loggerType specified one of the values from enum AuditLoggerType.
   */
  private void initializeLogger(AuditLoggerType loggerType){
    this.logger = LogManager.getContext(false).getLogger(loggerType.getType());
  }

  public void logWriteSuccess(AuditMessage msg) {
    this.logger.logIfEnabled(FQCN, Level.INFO, WRITE_MARKER, msg, null);
  }

  public void logWriteFailure(AuditMessage msg) {
    this.logger.logIfEnabled(FQCN, Level.ERROR, WRITE_MARKER, msg,
        msg.getThrowable());
  }

審計日誌在實際系統中的應用
下面我們對照上面寫的類，來看看它是如何被應用到系統中的，下面的例子也是大多數分散式系統常用的audit log的列印手法。

第一步，初始化得到audit日誌列印例項：

private static final AuditLogger AUDIT = new AuditLogger(AuditLoggerType.OMLOGGER);
1
在服務管理物件的關鍵操作行為處（RPC呼叫處），加上操作日誌是，

  @Override
  public OmKeyLocationInfo allocateBlock(OmKeyArgs args, long clientID)
      throws IOException {
    boolean auditSuccess = true;
    Map<String, String> auditMap = (args == null) ? new LinkedHashMap<>() :
        args.toAuditMap();
    auditMap.put(OzoneConsts.CLIENT_ID, String.valueOf(clientID));
    try {
      metrics.incNumBlockAllocateCalls();
      return keyManager.allocateBlock(args, clientID);
    } catch (Exception ex) {
      metrics.incNumBlockAllocateCallFails();
      auditSuccess = false;
      AUDIT.logWriteFailure(buildAuditMessageForFailure(OMAction.ALLOCATE_BLOCK,
          auditMap, ex));
      throw ex;
    } finally {
      if(auditSuccess){
        AUDIT.logWriteSuccess(buildAuditMessageForSuccess(
            OMAction.ALLOCATE_BLOCK, auditMap));
      }
    }
  }
  ...
    public AuditMessage buildAuditMessageForFailure(AuditAction op,
      Map<String, String> auditMap, Throwable throwable) {
    return new AuditMessage.Builder()
        .setUser((Server.getRemoteUser() == null) ? null :
            Server.getRemoteUser().getUserName())
        .atIp((Server.getRemoteIp() == null) ? null :
            Server.getRemoteIp().getHostAddress())
        .forOperation(op.getAction())
        .withParams(auditMap)
        .withResult(AuditEventStatus.FAILURE.toString())
        .withException(throwable)
        .build();
  }

我們看到，在上面的失敗和成功的地方都列印了audit日誌，但是如果我們不考慮失敗的情況，只需程式碼塊的最後finally塊區域，新增日誌即可。這樣可以確保無論前面邏輯執行如何，能夠保證操作記錄不被丟失。

OK，以上就是今天闡述的一個小的知識點，不是很複雜，但用處不小。

作者：Android路上的人
來源：CSDN
原文：https://blog.csdn.net/Androidlushangderen/article/details/84196698
版權宣告：本文為博主原創文章，轉載請附上博文連結！