ASP.NET+Serilog+ILoggerFactory下SentryEventProcessors后台上下文失效问题

问题原因 #

Sentry v3.23.0版本对后台线程的Scope关联逻辑做了调整，导致全局注册的SentryEventProcessors默认不会自动绑定到后台任务、后台服务的日志上下文，部分场景下甚至无法将事件发送到Sentry，而控制器上下文因请求Scope的存在不受影响。

解决方案 #

1. 使用依赖注入的ILogger<T>替代手动创建 #

后台服务必须通过构造函数注入ILogger<T>，而非直接从ILoggerFactory手动创建日志实例。注入的日志会自动关联当前Sentry Scope及全局处理器：

public class MyBackgroundService : BackgroundService
{
    private readonly ILogger<MyBackgroundService> _logger;

    // 构造函数注入ILogger<T>
    public MyBackgroundService(ILogger<MyBackgroundService> logger)
    {
        _logger = logger;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        try
        {
            // 业务逻辑
        }
        catch (Exception ex)
        {
            // 此处日志会经过全局注册的SentryEventProcessors处理
            _logger.LogError(ex, "后台服务执行出错");
        }
    }
}

2. 开启Scope传播到后台线程 #

在Sentry配置中启用ContinueOnCapturedContext，确保主线程的Scope（包括全局处理器）能传播到后台任务上下文：

builder.Services.AddSentry(options =>
{
    options.Dsn = "你的Sentry DSN";
    // 开启上下文传播
    options.ContinueOnCapturedContext = true;
    // 全局注册事件处理器
    options.AddEventProcessor<CustomEventProcessor>();
});

3. 全局处理器注册验证 #

确保事件处理器是通过AddSentry配置中的AddEventProcessor方法全局注册的，而非仅在请求上下文注册：

// 自定义事件处理器
public class CustomEventProcessor : ISentryEventProcessor
{
    public SentryEvent Process(SentryEvent evnt)
    {
        // 自定义处理逻辑
        evnt.Tags.Add("Context", "Background");
        return evnt;
    }
}

// 在AddSentry中全局注册
builder.Services.AddSentry(options =>
{
    options.AddEventProcessor<CustomEventProcessor>();
});

4. 手动关联处理器（仅作 fallback） #

如果上述方法无效，可在后台任务执行时手动将全局处理器绑定到当前Scope（不推荐，仅临时解决）：

public class MyBackgroundService : BackgroundService
{
    private readonly ILogger<MyBackgroundService> _logger;
    private readonly IServiceProvider _serviceProvider;

    public MyBackgroundService(ILogger<MyBackgroundService> logger, IServiceProvider serviceProvider)
    {
        _logger = logger;
        _serviceProvider = serviceProvider;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        using var scope = SentrySdk.PushScope();
        // 获取全局注册的所有事件处理器
        var processors = _serviceProvider.GetServices<ISentryEventProcessor>();
        foreach (var processor in processors)
        {
            scope.AddEventProcessor(processor);
        }

        try
        {
            // 业务逻辑
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "后台任务出错");
        }
    }
}

总结 #

优先采用依赖注入ILogger + 开启ContinueOnCapturedContext的组合方案，这能保证后台上下文的日志自动关联全局处理器，无需手动配置。该问题源于v3.23.0对Scope传播逻辑的调整，虽未在更新日志明确提及，但通过上述配置即可修复。

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