MCServerLauncher-Future项目中的日志系统优化实践-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_07005/article/details/148861634

MCServerLauncher-Future项目中的日志系统优化实践

MCServerLauncher-Future Future version of MCSL, a brand new server management tool. Redefined, Versatile, Easy to use. (WPF Launcher & Daemon) 项目地址: https://gitcode.com/gh_mirrors/mc/MCServerLauncher-Future

引言

在MCServerLauncher-Future项目的开发过程中，团队发现需要统一日志记录系统以提升调试效率和运行状态监控能力。本文将详细介绍该项目如何通过Serilog实现统一的日志记录方案。

背景与需求分析

现代软件开发中，良好的日志系统是必不可少的调试和监控工具。MCServerLauncher-Future项目最初存在日志记录不统一的问题，特别是在Daemon组件中，日志记录方式分散，缺乏统一格式和输出渠道。

主要需求包括：

统一日志记录接口，避免使用分散的日志记录方式
规范日志格式，包含时间戳、日志等级、来源模块等信息
支持多级日志记录（DEBUG、INFO、WARNING等）
同时支持控制台和文件输出

技术选型：Serilog

项目选择了Serilog作为日志记录框架，主要基于以下考虑：

灵活的配置方式
强大的格式化能力
支持多种输出渠道（sinks）
良好的性能表现
丰富的扩展生态系统

实现方案

日志格式设计

日志格式规范化为： [时间] [等级] [模块] 日志内容

例如： [2024-07-22 15:30:45] [INFO] [Remote] 成功连接到远程服务器

模块化日志记录

为每个功能模块创建专门的日志记录器，通过前缀标识来源：

// Remote模块日志记录器
public static class RemoteLogHelper
{
    private static readonly ILogger Logger = Log.ForContext("SourceContext", "Remote");
    
    public static void Info(string message)
    {
        Logger.Information("[Remote] {Message}", message);
    }
    
    // 其他日志级别方法...
}

日志等级划分

采用标准日志等级：

DEBUG：调试信息，最详细级别
INFO：常规运行信息
WARNING：潜在问题
ERROR：错误情况，但程序仍可运行
FATAL：严重错误，可能导致程序终止

输出渠道配置

同时配置控制台和文件输出：

Log.Logger = new LoggerConfiguration()
    .MinimumLevel.Debug()
    .WriteTo.Console(outputTemplate: "[{Timestamp:yyyy-MM-dd HH:mm:ss}] [{Level}] {Message}{NewLine}{Exception}")
    .WriteTo.File("logs/mcsl.log", rollingInterval: RollingInterval.Day)
    .CreateLogger();