FISCO BCOS日志規范有哪些

# FISCO BCOS日志規范有哪些

## 目錄
- [1. 引言](#1-引言)
- [2. 日志級別規范](#2-日志級別規范)
  - [2.1 級別定義](#21-級別定義)
  - [2.2 使用場景](#22-使用場景)
- [3. 日志格式規范](#3-日志格式規范)
  - [3.1 基礎字段](#31-基礎字段)
  - [3.2 擴展字段](#32-擴展字段)
  - [3.3 示例模板](#33-示例模板)
- [4. 日志輸出規范](#4-日志輸出規范)
  - [4.1 控制臺輸出](#41-控制臺輸出)
  - [4.2 文件輸出](#42-文件輸出)
  - [4.3 日志輪轉](#43-日志輪轉)
- [5. 日志分類規范](#5-日志分類規范)
  - [5.1 系統日志](#51-系統日志)
  - [5.2 交易日志](#52-交易日志)
  - [5.3 網絡日志](#53-網絡日志)
- [6. 日志采集與分析](#6-日志采集與分析)
  - [6.1 ELK集成](#61-elk集成)
  - [6.2 監控告警](#62-監控告警)
- [7. 最佳實踐](#7-最佳實踐)
  - [7.1 性能優化](#71-性能優化)
  - [7.2 安全建議](#72-安全建議)
- [8. 總結](#8-總結)

## 1. 引言
FISCO BCOS作為企業級區塊鏈平臺，完善的日志體系是保障系統可觀測性的關鍵。本文詳細闡述FISCO BCOS的日志規范體系，包括日志級別、格式規范、輸出方式、分類管理以及運維實踐等內容，幫助開發者構建符合生產要求的日志管理系統。

## 2. 日志級別規范
### 2.1 級別定義
采用五級日志分級體系：

| 級別    | 數值 | 說明                     |
|---------|------|--------------------------|
| TRACE   | 0    | 最細粒度調試信息          |
| DEBUG   | 1    | 開發調試關鍵信息          |
| INFO    | 2    | 正常運行狀態信息          |
| WARNING | 3    | 潛在異常警告              |
| ERROR   | 4    | 業務錯誤但系統可繼續運行   |
| FATAL   | 5    | 導致系統崩潰的嚴重錯誤     |

### 2.2 使用場景
- **生產環境推薦配置**：INFO級別+WARNING過濾
- **開發調試場景**：DEBUG級別開啟完整調用鏈追蹤
- **TRACE級別**慎用（可能導致性能下降）

## 3. 日志格式規范
### 3.1 基礎字段
```json
{
  "timestamp": "2023-08-20T15:30:45.123+08:00",
  "level": "INFO",
  "service": "node0",
  "module": "consensus",
  "thread": "pbft_sealer",
  "location": "PbftEngine.cpp:1256",
  "message": "Generate seal on blkNum=325"
}

3.2 擴展字段

3.3 示例模板

[2023-08-20 15:30:45.123][INFO][node0][consensus] PbftEngine.cpp:1256 - Generate seal on blkNum=325 tx_count=3 tx_hash=0x3a7d... peer_ip=192.168.1.2 cost_time=45ms

4. 日志輸出規范

4.1 控制臺輸出

• 開發環境建議啟用彩色輸出
• 生產環境建議關閉控制臺日志（通過配置文件log.ini設置）

4.2 文件輸出

; log.ini 配置示例
[log]
enable=true
log_path=./log
max_log_file_size=200
flush=true

4.3 日志輪轉

• 單文件默認200MB自動分割
• 保留最近30個日志文件（可通過max_log_files配置）

5. 日志分類規范

5.1 系統日志

• 節點啟動/關閉
• 資源監控（CPU/內存/磁盤）
• 證書變更記錄

5.2 交易日志

[TRACE][executor] TransactionExecutor.cpp:342 - Execute tx=0x5b2d... gasUsed=21000

5.3 網絡日志

• P2P連接建立/斷開
• 區塊同步狀態
• 網絡吞吐量統計

6. 日志采集與分析

6.1 ELK集成

推薦日志采集架構：

Filebeat -> Logstash -> Elasticsearch -> Kibana

6.2 監控告警

關鍵監控指標： - ERROR日志頻率突增 - 共識模塊超時告警 - 交易執行失敗率閾值

7. 最佳實踐

7.1 性能優化

• 避免高頻日志（如循環內打印DEBUG）
• 使用異步日志庫（如spdlog）
• 敏感字段脫敏處理

7.2 安全建議

1. 禁止日志包含私鑰信息
2. 設置合理的文件權限（600）
3. 傳輸通道加密（TLS）

8. 總結

FISCO BCOS的日志規范體系通過分級控制、結構化輸出、分類管理三大核心設計，為區塊鏈運維提供完整的可觀測性方案。建議結合具體業務場景靈活調整日志配置，同時注意平衡信息詳實度與系統性能的關系。

注：本文檔基于FISCO BCOS 3.x版本，具體實現可能因版本差異略有不同。 “`

該文檔包含以下核心要點： 1. 完整的日志級別定義和使用建議 2. 結構化日志字段的詳細說明 3. 生產環境配置模板（含log.ini示例） 4. 關鍵模塊的日志分類指南 5. 從采集到分析的完整運維方案 6. 性能與安全的最佳實踐

可根據實際需要補充具體配置案例或性能測試數據以完善文檔。