Serilog缓存日志器实现：任务成功才输出日志的方案咨询

针对你需要的「任务成功才输出累积日志，失败则丢弃」的需求，最优方案是自定义一个带缓存与触发机制的Sink包装器，以下是具体分析和实现思路：

方案选择分析 #

• 自定义ILogger：需要重写大量日志接口逻辑，复杂度高，没必要
• Async Sink：仅负责异步后台输出，无法控制日志输出的触发时机，不符合需求
• Periodic Batching Sink：基于时间批量输出，是时间驱动而非任务结果驱动，不匹配「任务成功才输出」的逻辑

因此，自定义Sink包装器是最直接且轻量的方案，它可以拦截日志事件做缓存，再根据任务结果决定是否转发给下游的Console、PostgreSQL、Seq等Sink。

具体实现步骤 #

1. 实现延迟提交的Sink包装器 #

这个包装器内部维护任务日志缓存，实现ILogEventSink接口，拦截日志事件存入对应任务的缓存，同时提供刷新/丢弃日志的方法：

using Serilog;
using Serilog.Core;
using Serilog.Events;
using System.Collections.Concurrent;

public class DelayedSink : ILogEventSink
{
    private readonly ILogEventSink _innerSink;
    private readonly ConcurrentDictionary<string, List<LogEvent>> _taskLogCache = new();

    public DelayedSink(ILogEventSink innerSink)
    {
        _innerSink = innerSink;
    }

    public void Emit(LogEvent logEvent)
    {
        // 从日志事件中提取TaskId标识
        if (!logEvent.Properties.TryGetValue("TaskId", out var taskIdProp) ||
            taskIdProp is not ScalarValue taskIdScalar ||
            taskIdScalar.Value is not string taskId)
        {
            // 无TaskId的日志直接输出（可根据需求调整为丢弃）
            _innerSink.Emit(logEvent);
            return;
        }

        // 将日志存入对应任务的缓存
        _taskLogCache.AddOrUpdate(
            taskId,
            _ => new List<LogEvent> { logEvent },
            (_, logs) => { logs.Add(logEvent); return logs; });
    }

    /// <summary>
    /// 刷新指定任务的缓存日志到下游Sink
    /// </summary>
    public void FlushTaskLogs(string taskId)
    {
        if (_taskLogCache.TryRemove(taskId, out var cachedLogs))
        {
            foreach (var log in cachedLogs)
            {
                _innerSink.Emit(log);
            }
        }
    }

    /// <summary>
    /// 丢弃指定任务的缓存日志
    /// </summary>
    public void DiscardTaskLogs(string taskId)
    {
        _taskLogCache.TryRemove(taskId, out _);
    }
}

2. 配置Serilog时包装现有Sink #

将你的Console、PostgreSQL、Seq等Sink用DelayedSink包装，让所有日志先经过缓存拦截：

var loggerConfig = new LoggerConfiguration()
    // 包装Console Sink
    .WriteTo.Sink(new DelayedSink(new ConsoleSink(new ConsoleSinkOptions())))
    // 包装PostgreSQL Sink（示例，需替换为你的实际配置）
    .WriteTo.Sink(new DelayedSink(new PostgreSqlSink(
        connectionString: "your_postgres_conn",
        tableName: "logs",
        columnOptions: new ColumnOptions())))
    // 包装Seq Sink（示例，需替换为你的实际配置）
    .WriteTo.Sink(new DelayedSink(new SeqSink("http://your_seq_url")));

Log.Logger = loggerConfig.CreateLogger();

3. 任务中使用带标识的日志器并控制输出 #

给每个任务创建带唯一TaskId的日志上下文，任务成功时刷新日志，失败时丢弃：

// 生成唯一任务ID
var taskId = Guid.NewGuid().ToString();
// 创建带TaskId的日志器
var taskLogger = Log.ForContext("TaskId", taskId);

// 正常记录日志（此时仅存入缓存，不输出到Sink）
taskLogger.Debug("Foo {Bar}", 42);
taskLogger.Information("任务开始执行");

try
{
    // 执行任务业务逻辑
    // ...

    // 任务成功，刷新缓存日志到下游Sink
    var delayedSink = Log.Logger.Sinks.First(s => s is DelayedSink) as DelayedSink;
    delayedSink?.FlushTaskLogs(taskId);
}
catch (Exception ex)
{
    taskLogger.Error(ex, "任务执行失败");
    // 任务失败，丢弃缓存日志
    var delayedSink = Log.Logger.Sinks.First(s => s is DelayedSink) as DelayedSink;
    delayedSink?.DiscardTaskLogs(taskId);
}

注意事项 #

• 确保TaskId全局唯一，避免不同任务的日志缓存混淆
• 多任务并发场景下，使用ConcurrentDictionary保证线程安全
• 若任务运行时间长、日志量大，需监控内存占用，避免缓存溢出
• 可将DelayedSink注册为依赖注入单例，方便在任务中直接注入调用，无需从Logger.Sinks中查找

内容的提问来源于stack exchange，提问作者lonix