Lib.rs

企业级 Rust 日志基础设施

✨ 核心特性 • 🚀 快速开始 • 📚 文档 • 💻 示例 • 🤝 贡献

English

🎯 基于 Tokio 构建的高性能、安全、功能丰富的日志基础设施

Inklog 为企业级应用提供全面的日志解决方案：

use inklog::{InklogConfig, LoggerManager};
use std::path::PathBuf;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = InklogConfig {
        file_sink: Some(inklog::FileSinkConfig {
            enabled: true,
            path: "logs/app.log".into(),
            max_size: "100MB".into(),
            compress: true,
            ..Default::default()
        }),
        ..Default::default()
    };

    let _logger = LoggerManager::with_config(config).await?;

    log::info!("应用启动成功");
    log::error!("发生错误，详情如下");

    Ok(())
}

📋 目录

✨ 核心特性

📦 功能预设

🚀 快速开始

📦 安装

在 Cargo.toml 中添加依赖：

[dependencies]
inklog = "0.1.7"

完整功能集（显式启用）：

[dependencies]
inklog = { version = "0.1.7", default-features = false, features = ["http", "cli", "sqlite"] }

💡 基础使用

use inklog::LoggerManager;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let _logger = LoggerManager::new().await?;

    log::info!("日志系统已初始化");
    Ok(())
}

use inklog::LoggerManager;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let _logger = LoggerManager::new().await?;

    log::trace!("追踪消息");
    log::debug!("调试消息");
    log::info!("信息消息");
    log::warn!("警告消息");
    log::error!("错误消息");

    Ok(())
}

use inklog::{FileSinkConfig, InklogConfig, LoggerManager};

let config = InklogConfig {
    file_sink: Some(FileSinkConfig {
        enabled: true,
        path: "logs/app.log".into(),
        max_size: "10MB".into(),
        rotation_time: "daily".into(),
        keep_files: 7,
        compress: true,
        ..Default::default()
    }),
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

use inklog::{DatabaseConfig, InklogConfig};

let config = InklogConfig {
    db_config: Some(DatabaseConfig {
        enabled: true,
        url: "sqlite://logs/app.db".to_string(),
        pool_size: 5,
        batch_size: 100,
        flush_interval_ms: 1000,
    }),
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

🔧 高级配置

加密文件日志

use inklog::{FileSinkConfig, InklogConfig};

// 从环境变量设置加密密钥
std::env::set_var("INKLOG_ENCRYPTION_KEY", "base64-encoded-32-byte-key");

let config = InklogConfig {
    file_sink: Some(FileSinkConfig {
        enabled: true,
        path: "logs/encrypted.log.enc".into(),
        max_size: "10MB".into(),
        encrypt: true,
        encryption_key_env: Some("INKLOG_ENCRYPTION_KEY".into()),
        compress: false, // 加密日志不压缩
        ..Default::default()
    }),
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

自定义日志格式

use inklog::{InklogConfig, config::GlobalConfig};

let format_string = "[{timestamp}] [{level:>5}] {target} - {message} | {file}:{line}";

let config = InklogConfig {
    global: GlobalConfig {
        level: "debug".into(),
        format: format_string.to_string(),
        masking_enabled: true,
        ..Default::default()
    },
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

🎨 功能标志

默认功能

inklog = "0.1.7"  # 默认不包含可选 feature (default = [])

可选功能

# HTTP 服务器
inklog = { version = "0.1.7", features = [
    "http",       # Axum HTTP 健康端点
] }

# 命令行工具
inklog = { version = "0.1.7", features = [
    "cli",        # decrypt, generate, validate 命令
] }

# 数据库 Sink (可选一个或多个)
inklog = { version = "0.1.7", features = [
    "sqlite",     # SQLite 数据库 Sink
    "postgres",   # PostgreSQL 数据库 Sink
    "mysql",      # MySQL 数据库 Sink
] }

# 开发
inklog = { version = "0.1.7", features = [
    "test-local", # 本地测试模式
    "debug",      # 额外安全审计日志
] }

功能详情

📚 文档

📖 附加资源

💻 示例

use inklog::LoggerManager;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let _logger = LoggerManager::new().await?;

    log::info!("应用已启动");
    log::error!("发生错误: {}", err);

    Ok(())
}

use inklog::{FileSinkConfig, InklogConfig, LoggerManager};

let config = InklogConfig {
    file_sink: Some(FileSinkConfig {
        enabled: true,
        path: "logs/app.log".into(),
        max_size: "10MB".into(),
        rotation_time: "daily".into(),
        keep_files: 7,
        compress: true,
        ..Default::default()
    }),
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

use inklog::{FileSinkConfig, InklogConfig};

std::env::set_var("INKLOG_ENCRYPTION_KEY", "base64-encoded-key");

let config = InklogConfig {
    file_sink: Some(FileSinkConfig {
        enabled: true,
        path: "logs/encrypted.log".into(),
        encrypt: true,
        encryption_key_env: Some("INKLOG_ENCRYPTION_KEY".into()),
        ..Default::default()
    }),
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

use inklog::{DatabaseSinkConfig, InklogConfig};

let config = InklogConfig {
    database_sink: Some(DatabaseSinkConfig {
        enabled: true,
        url: "postgresql://localhost/logs".to_string(),
        pool_size: 10,
        batch_size: 100,
        flush_interval_ms: 1000,
        ..Default::default()
    }),
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

use axum::{routing::get, Json, Router};
use inklog::LoggerManager;
use std::sync::Arc;

let logger = Arc::new(LoggerManager::new().await?);

let app = Router::new().route(
    "/health",
    get({
        let logger = logger.clone();
        || async move { Json(logger.get_health_status()) }
    }),
);

// 启动 HTTP 服务器...

use inklog::{InklogConfig, config::GlobalConfig};

let format_string = "[{timestamp}] [{level:>5}] {target} - {message}";

let config = InklogConfig {
    global: GlobalConfig {
        level: "debug".into(),
        format: format_string.to_string(),
        masking_enabled: true,
        ..Default::default()
    },
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

use inklog::{InklogConfig, config::GlobalConfig};

let config = InklogConfig {
    global: GlobalConfig {
        level: "info".into(),
        format: "{timestamp} {level} {message}".to_string(),
        masking_enabled: true,  // 启用 PII 脱敏
        ..Default::default()
    },
    ..Default::default()
};

let _logger = LoggerManager::with_config(config).await?;

// 敏感数据将自动脱敏
log::info!("用户邮箱: user@example.com");
// 输出: 用户邮箱: ***@***.***

📦 可运行示例

examples/ crate 提供了 10 个专用示例，演示特定功能。使用 cargo run --example <名称> 运行（在 examples/ 目录下或使用 --package inklog-examples）。

🏗️ 架构

flowchart TD
    App["应用层<br/>(使用 log! 宏的代码)"]
    API["Inklog API 层<br/>- LoggerManager, LoggerBuilder<br/>- 配置管理<br/>- 健康监控"]
    Sink["Sink 抽象层<br/>- ConsoleSink<br/>- FileSink (轮转、压缩)<br/>- DatabaseSink (批量写入)<br/>- AsyncFileSink<br/>- RingBufferedFileSink"]
    Core["核心处理层<br/>- 日志格式化和模板<br/>- 数据脱敏 (PII)<br/>- 加密 (AES-256-GCM)<br/>- 压缩 (ZSTD, GZIP, Brotli)"]
    IO["并发与 I/O<br/>- Tokio 异步运行时<br/>- Crossbeam 通道<br/>- Rayon 并行处理"]
    Store["存储与外部服务<br/>- 文件系统<br/>- 数据库 (PostgreSQL, MySQL, SQLite)<br/>- Parquet (分析)"]

    App --> API --> Sink --> Core --> IO --> Store

分层说明

应用层

• 应用代码使用 log crate 的标准 log! 宏
• 与现有 Rust 日志模式兼容

Inklog API 层

• LoggerManager: 所有日志操作的主要协调器
• LoggerBuilder: 流式构建器模式配置
• 健康状态跟踪和指标收集

Sink 抽象层

• 多种 Sink 实现对应不同的输出目标
• 开发环境的控制台输出
• 带轮转、压缩和加密的文件输出
• 批量写入的数据库输出 (PostgreSQL, MySQL, SQLite)
• 高吞吐量场景的异步和缓冲文件 Sink

核心处理层

• 基于模板的日志格式化
• 基于正则的 PII 数据脱敏 (邮箱、身份证、信用卡等)
• 敏感日志的 AES-256-GCM 加密
• 多种压缩算法 (ZSTD, GZIP, Brotli, LZ4)

并发与 I/O 层

• Tokio 异步运行时用于非阻塞 I/O
• Crossbeam 通道用于任务间通信
• Rayon 用于 CPU 密集型并行处理

存储与外部服务层

• 本地文件系统访问
• 通过 Sea-ORM 的数据库连接
• 分析工作流的 Parquet 格式

🔒 安全

Inklog 以安全为首要优先级构建：

🔒 加密

• AES-256-GCM: 军用级日志文件加密
• 密钥管理: 基于环境变量的密钥注入
• 内存安全清除: 通过 zeroize crate 安全清除密钥
• SHA-256 哈希: 加密日志的完整性验证

🎭 数据脱敏

• 基于正则的模式: 自动 PII 检测和脱敏
• 邮箱脱敏: user@example.com → ***@***.***
• 身份证脱敏: 信用卡和社会安全号脱敏
• 自定义模式: 可配置的正则表达式模式

🔐 密钥安全处理

// 从环境变量安全设置加密密钥
std::env::set_var("INKLOG_ENCRYPTION_KEY", "base64-encoded-32-byte-key");

// 密钥使用后自动清除
// 切勿在代码中硬编码密钥

🛡️ 安全最佳实践

• 无硬编码密钥: 密钥从环境变量加载
• 最小权限操作: 仅必要的文件/数据库访问
• 审计日志: 调试功能用于安全审计追踪
• 合规就绪: 支持 GDPR、HIPAA、PCI-DSS 日志要求

🧪 测试

# 使用默认功能运行所有测试
cargo test --all-features

# 使用特定功能运行测试
cargo test --features "http,cli"

# 在发布模式下运行测试
cargo test --release

# 运行基准测试
cargo bench

测试覆盖率

Inklog 目标是 95%+ 代码覆盖率：

# 生成覆盖率报告
cargo tarpaulin --out Html --all-features

代码检查和格式化

# 格式化代码
cargo fmt --all

# 检查格式而不修改
cargo fmt --all -- --check

# 运行 Clippy (警告视为错误)
cargo clippy --all-targets --all-features -- -D warnings

安全审计

# 运行 cargo deny 安全检查
cargo deny check

# 检查安全公告
cargo deny check advisories

# 检查禁止的许可证
cargo deny check bans

依赖注入测试

Inklog 提供 Mock 实现，支持无外部依赖的单元测试：

use inklog::{LoggerManager, LoggerDependencies};
use inklog::infrastructure::{MockCache, MockConfig, MockDatabaseAdapter};
use std::sync::Arc;

#[tokio::test]
async fn test_with_mocks() -> Result<(), Box<dyn std::error::Error>> {
    // 创建 Mock 依赖
    let deps = LoggerDependencies {
        cache: Some(Arc::new(MockCache::new())),
        config: Some(Arc::new(MockConfig::new())),
        database: Some(Arc::new(MockDatabaseAdapter::new())),
    };

    // 注入依赖创建 logger
    let logger = LoggerManager::with_dependencies(deps).await?;

    // 测试日志记录...
    log::info!("Test message");

    Ok(())
}

Mock 实现特性:

• MockCache: 内存 HashMap，支持延迟模拟
• MockConfig: 运行时可修改的配置
• MockDatabaseAdapter: 内存日志存储，支持健康状态控制

详细使用方法请参考 用户指南。

集成测试

# 运行集成测试
cargo test --test '*'

# 使用 Docker 服务运行 (PostgreSQL, MySQL)
docker-compose up -d
cargo test --all-features
docker-compose down

🤝 贡献

开发环境设置

# 克隆仓库
git clone https://github.com/Kirky-X/inklog.git
cd inklog

# 安装 pre-commit 钩子 (如果可用)
./scripts/install-pre-commit.sh

# 运行测试
cargo test --all-features

# 运行 linter
cargo clippy --all-features

# 格式化代码
cargo fmt --all

Pull Request 流程

1. Fork 仓库
2. 创建功能分支 (git checkout -b feature/amazing-feature)
3. 进行修改
4. 运行测试确保全部通过 (cargo test --all-features)
5. 运行 clippy 并修复警告 (cargo clippy --all-features)
6. 提交修改 (git commit -m 'Add amazing feature')
7. 推送到分支 (git push origin feature/amazing-feature)
8. 打开 Pull Request

代码风格

• 遵循 Rust 命名约定 (变量 snake_case，类型 PascalCase)
• 使用 thiserror 定义错误类型
• 使用 anyhow 提供错误上下文
• 为所有公共 API 添加文档注释
• 提交前运行 cargo fmt

📄 许可证

🙏 致谢

Inklog 的实现离不开这些优秀的项目：

• tracing - Rust 结构化日志基础
• tokio - Rust 异步运行时
• Sea-ORM - 异步 ORM
• axum - HTTP 端点 Web 框架
• serde - 序列化框架
• 整个 Rust 生态系统的优秀工具和库

📞 支持

⭐ Star 历史