Serilog BeginScope全局日志状态更新后不生效的问题咨询

问题背景 #

• 使用Serilog作为Microsoft.Extensions.Logging的后端实现
• 类T通过依赖注入接收ILogger<T>实例
• T包含多个异步方法（如M1Async、M2Async），存在大量日志输出
• 需要将一个“全局状态”随T输出的每条日志一同记录，该状态大部分内容固定，仅少量属性会偶尔变更
• 由于T与应用内其他类共享Serilog配置，单独为T定制Enricher不实用
• 因此决定使用logger.BeginScope()创建全局状态，状态变更时销毁旧Scope并重建新的
• 从T的方法视角来看，该状态是全局的（存储在私有可读写成员中）

复现场景 #

• 创建T实例，构建loggerScope（通过logger.BeginScope()）
• 调用M1Async，日志输出包含预期的loggerScope内容
• M1Async检测到状态变更，重建新的loggerScope后退出
• 调用M2Async，日志却输出原始的loggerScope内容，而非更新后的版本

疑问 #

1. 为何会出现Scope内容回退的情况？
2. 有没有办法避免该问题（如配置、特性、技巧等）？

解答 #

1. Scope内容回退的原因 #

BeginScope()创建的作用域是**基于异步上下文（AsyncLocal）**实现的，它的生命周期和调用栈/异步流绑定，而非和ILogger实例或T的实例绑定。

当你在M1Async里销毁旧Scope并创建新Scope时，这个新Scope仅存在于M1Async的异步上下文内。一旦M1Async执行完毕退出，对应的异步上下文被清理，后续调用M2Async时，会回到最初创建T实例时的异步上下文，自然就使用了原始的Scope内容。

另外，如果只是把Scope的引用存在T的私有成员里，但没有确保新Scope在M2Async的执行上下文中被激活，也会导致问题——BeginScope()返回的IDisposable只有在其生命周期内才会将上下文注入到当前异步流中，旧Scope被Dispose后，新Scope如果没有被纳入当前执行流的作用域链，就不会生效。

2. 避免问题的方案 #

方案一：维持Scope在T实例生命周期内的激活状态

不要仅存储Scope引用，而是确保状态变更时，先Dispose旧Scope，再创建新Scope并持有其激活状态——关键是让新Scope的IDisposable被持续持有，且覆盖T所有方法的执行上下文。

示例代码：

private IDisposable _currentScope;
private readonly ILogger<T> _logger;

public T(ILogger<T> logger)
{
    _logger = logger;
    UpdateScope(initialState);
}

private void UpdateScope(GlobalState newState)
{
    // 销毁旧Scope
    _currentScope?.Dispose();
    // 创建新Scope并持有，自动注入当前异步上下文
    _currentScope = _logger.BeginScope(newState);
}

public async Task M1Async()
{
    // 业务逻辑
    if (stateChanged)
    {
        UpdateScope(newState);
    }
}

public async Task M2Async()
{
    // 此时异步上下文已被新Scope覆盖，日志会使用更新后的状态
    _logger.LogInformation("M2Async log");
}

注意：如果T是单例且被多并发异步流调用，需给UpdateScope加lock保证线程安全。

方案二：用Serilog的LogContext替代BeginScope

LogContext是基于AsyncLocal的全局上下文，比ILogger.BeginScope更灵活，适合全局状态场景。状态变更时直接更新LogContext属性即可：

// 初始化设置初始状态
LogContext.PushProperty("GlobalState", initialState);

// 状态变更时，覆盖旧属性
var oldProperty = LogContext.PushProperty("GlobalState", newState);
oldProperty.Dispose(); // 移除旧属性，确保只保留最新状态

// 日志自动包含LogContext中的属性
_logger.LogInformation("Log with global state");

这种方式不绑定ILogger实例，每个异步流有独立的LogContext副本，多并发场景下不会互相干扰。

方案三：自定义ILogger<T>包装类

自定义包装类，在每次日志输出时手动添加全局状态，彻底规避Scope的异步上下文问题：

public class ScopedLogger<T> : ILogger<T>
{
    private readonly ILogger<T> _innerLogger;
    private GlobalState _currentState;

    public ScopedLogger(ILogger<T> innerLogger)
    {
        _innerLogger = innerLogger;
    }

    public void UpdateState(GlobalState newState)
    {
        _currentState = newState;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
    {
        // 给日志附加全局状态
        var loggerWithState = _innerLogger.ForContext("GlobalState", _currentState);
        loggerWithState.Log(logLevel, eventId, state, exception, formatter);
    }

    public bool IsEnabled(LogLevel logLevel) => _innerLogger.IsEnabled(logLevel);
    public IDisposable BeginScope<TState>(TState state) => _innerLogger.BeginScope(state);
}

依赖注入时注册包装类：

services.AddScoped<ILogger<T>, ScopedLogger<T>>();

T接收ScopedLogger<T>实例后，每次调用UpdateState，后续所有日志都会自动包含最新状态。

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