fblog 项目教程

1. 项目的目录结构及介绍

fblog 是一个用于查看 JSON 日志的小型命令行工具。以下是 fblog 项目的目录结构及其介绍：

fblog/
├── Cargo.toml
├── README.md
├── src/
│   ├── main.rs
│   ├── config.rs
│   ├── log_parser.rs
│   ├── filter.rs
│   └── utils.rs
└── fblog.toml

目录结构介绍

• Cargo.toml: Rust 项目的配置文件，包含项目的依赖、元数据等信息。
• README.md: 项目的说明文档，通常包含项目的简介、安装方法、使用示例等。
• src/: 源代码目录，包含项目的所有 Rust 源文件。
  • main.rs: 项目的入口文件，负责启动和初始化 fblog。
  • config.rs: 配置文件处理模块，负责读取和解析 fblog.toml 配置文件。
  • log_parser.rs: 日志解析模块，负责解析 JSON 日志并格式化输出。
  • filter.rs: 日志过滤模块，支持使用 Lua 脚本进行日志过滤。
  • utils.rs: 工具模块，包含一些通用的工具函数。
• fblog.toml: fblog 的配置文件，定义了日志级别、颜色映射等配置。

2. 项目的启动文件介绍

fblog 的启动文件是 src/main.rs。该文件是整个项目的入口点，负责初始化配置、解析命令行参数并启动日志查看器。

src/main.rs 主要功能

• 初始化配置: 读取 fblog.toml 配置文件，并根据配置初始化日志级别、颜色映射等。
• 解析命令行参数: 使用 clap 库解析用户输入的命令行参数，如过滤条件、输出格式等。
• 启动日志查看器: 根据配置和命令行参数，启动日志查看器，开始解析和显示 JSON 日志。

3. 项目的配置文件介绍

fblog 的配置文件是 fblog.toml，该文件位于项目的根目录下。配置文件定义了日志级别、颜色映射等配置项。

fblog.toml 配置文件示例

# 日志级别配置
[log_levels]
trace = "trace"
debug = "debug"
info = "info"
warn = "warn"
error = "error"
fatal = "fatal"

# 颜色映射配置
[color_map]
trace = "green"
debug = "blue"
info = "cyan"
warn = "yellow"
error = "red"
fatal = "purple"

配置项介绍

• log_levels: 定义了日志级别的映射关系，将数字级别的日志映射到具体的日志级别名称。
• color_map: 定义了日志级别的颜色映射，不同级别的日志将以不同的颜色显示。

通过修改 fblog.toml 配置文件，用户可以自定义日志级别和颜色，以满足不同的日志查看需求。