TJC.Cyclops.LogLib 2025.12.2.1

Cyclops.LogLib

项目概述

Cyclops.LogLib是Cyclops框架中的日志收集组件，提供高效的日志批量收集、处理和数据库持久化功能。该组件采用单例模式实现，支持两种类型日志的收集：普通系统日志（包括异常日志）和API调用日志，并提供批处理机制优化数据库写入性能。

核心功能模块

1. 日志收集器

• 单例模式实现的LoggerCollector，集中管理日志收集和处理流程
• 自动注册日志事件，监听Logger的日志记录和错误事件
• 支持服务名称自动获取和配置

2. 批处理机制

• 基于Batcher<T>实现的日志批处理器
• 分别针对普通日志(LogInfo)和API日志(ApiLogInfo)提供独立的批处理队列
• 支持批处理完成事件和错误处理事件

3. 数据库持久化

• 使用BaseRepository实现日志的数据库操作
• 支持两种日志表的批量插入
• 异常处理和错误重试机制

4. 设备信息解析

• 自动从UserAgent中解析设备信息、操作系统和浏览器信息
• 为API调用日志提供详细的客户端环境信息

技术栈

• .NET 8.0 - 基础运行时环境
• SqlSugar - ORM框架，用于数据库操作
• Cyclops.Common - 通用工具类库
• Cyclops.Orm - ORM封装组件

环境依赖

• 数据库连接字符串配置（名为"LogsDB"）
• .NET 8.0运行时环境
• Cyclops.Common和Cyclops.Orm组件

数据模型

DbLogError

异常日志表模型，包含以下关键字段：

• ServiceName - 服务名称
• Description - 日志描述
• Parmas - 相关参数
• Exception - 异常信息JSON字符串

DbLogApi

API调用日志表模型，包含以下关键字段：

• ServiceName - 服务名称
• CallIp - 调用方IP
• Url - 请求地址
• RequestMethod - 请求方式
• Header - 请求头
• UserAgent - 用户代理信息
• Input - 输入参数
• Output - 输出结果
• StatusCode - HTTP状态码
• UserId - 用户ID
• Cost - 请求耗时
• Device/Os/Ua - 解析后的设备信息

安装与配置

1. 安装组件

dotnet add package Cyclops.LogLib

2. 数据库配置

在应用程序配置文件中添加名为"LogsDB"的数据库连接字符串：

{
  "ConnectionStrings": {
    "LogsDB": "Data Source=your_server;Initial Catalog=LogsDB;User ID=your_user;Password=your_password;"
  }
}

3. 启动日志收集器

在应用程序启动时初始化并启动日志收集器：

// 在应用程序启动时
var loggerCollector = LoggerCollector.Instance;
loggerCollector.Start();

使用示例

1. 自动收集日志

配置完成后，通过Cyclops.Common.LogCom.Logger记录的日志会自动被收集：

// 记录普通日志
Logger.Info("这是一条信息日志");

// 记录错误日志
try
{
    // 可能抛出异常的代码
}
catch (Exception ex)
{
    Logger.Error("操作失败", ex);
}

// 记录API调用日志
Logger.ApiLog(new ApiLogInfo
{
    Url = "/api/users",
    RequestMethod = "GET",
    Input = "{\"id\":1}",
    Output = "{\"success\":true}",
    Cost = 100,
    StatusCode = 200,
    CallIp = "192.168.1.1",
    UserID = "user123"
});

2. 手动添加日志到批处理器

如果需要手动控制日志收集，可以直接使用批处理器：

// 直接获取实例并添加日志
var logCollector = LoggerCollector.Instance;
var logInfo = new LogInfo { Description = "手动添加的日志" };

// 这种方式不推荐，建议通过Logger来记录，让收集器自动处理

高级配置

批处理器配置

批处理器的行为（如批量大小、处理间隔等）可以在Cyclops.Common中进行配置。

启用/禁用数据库日志

通过DbConnectionOptions的EnableDBLogs属性控制是否将日志写入数据库：

// 在数据库配置中设置
_errorLogRepo.DbConnectionOptions.EnableDBLogs = true; // 默认值

注意事项

• 对于高流量应用，建议适当调整批处理器配置以优化性能
• 当数据库连接不可用时，组件会抛出异常并停止日志收集

贡献者

• yswenli

许可证

保留所有权利