Serilog扩展：如何通过日志构建器添加内存日志记录功能

在软件开发过程中，日志记录是必不可少的调试和监控手段。Serilog作为.NET生态中广受欢迎的日志记录库，提供了灵活的扩展机制。本文将详细介绍如何扩展Serilog的日志构建器，实现将日志同时输出到控制台、文件以及内存队列的功能。

背景与需求分析

在实际应用场景中，我们经常需要：

1. 将日志持久化到文件供后续分析
2. 实时查看控制台输出
3. 通过API接口获取当前日志内容

然而，当使用Serilog的File Sink时，日志文件会被锁定，无法直接读取。这时就需要引入内存日志记录作为补充方案。

核心实现方案

1. 创建内存日志接收器(InMemorySink)

首先需要实现一个自定义的日志接收器，将日志事件存入内存队列：

class InMemorySink : ILogEventSink 
{
    readonly ITextFormatter _textFormatter = 
        new MessageTemplateTextFormatter("{Timestamp} [{Level}] {Message}{Exception}");

    public ConcurrentQueue<string> Events { get; } = new ConcurrentQueue<string>();

    public void Emit(LogEvent logEvent) 
    {
        if (logEvent == null) throw new ArgumentNullException(nameof(logEvent));
        var renderSpace = new StringWriter();
        _textFormatter.Format(logEvent, renderSpace);
        Events.Enqueue(renderSpace.ToString());
    }
}

这个实现有以下特点：

• 使用线程安全的ConcurrentQueue存储日志条目
• 通过MessageTemplateTextFormatter格式化日志输出
• 实现了ILogEventSink接口的Emit方法

2. 配置完整的Serilog日志管道

建议使用完整的Serilog配置方式，而非仅通过LoggerFactory：

var log = new LoggerConfiguration()
    .WriteTo.Console()
    .WriteTo.File("logs/Scanner-.log", rollingInterval: RollingInterval.Day)
    .WriteTo.Sink(new InMemorySink())
    .CreateLogger();

3. 与Microsoft.Extensions.Logging集成

如果需要与ASP.NET Core等框架集成，可以通过以下方式：

services.AddLogging(loggingBuilder => 
{
    loggingBuilder.AddSerilog(log);
});

高级应用场景

实时日志监控API

基于内存队列，可以轻松实现日志监控API：

[HttpGet("logs")]
public IActionResult GetLogs()
{
    return Ok(inMemorySink.Events.ToList());
}

性能优化建议

1. 考虑设置队列最大长度，防止内存溢出
2. 对于高频日志场景，建议使用更高效的数据结构
3. 可以添加日志级别过滤，只存储关键日志

总结

通过自定义Serilog Sink实现内存日志记录，我们解决了以下问题：

• 实时访问被文件锁定的日志内容
• 为系统提供了额外的日志获取通道
• 保持了原有日志记录功能不变

这种方案特别适合需要实时监控日志的Web应用和微服务场景。开发者可以根据实际需求，进一步扩展内存日志的功能，如添加日志过滤、分页查询等特性。