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. 性能与安全的最佳实践

可根据实际需要补充具体配置案例或性能测试数据以完善文档。