如何在.NET6 Worker Service中将Application Insights OperationID设为自定义CorrelationID？

针对你遇到的带横杠GUID无法作为OperationID传入StartOperation、直接设置Context.Operation.Id不生效、ITelemetryInitializer无法在DI作用域传递CorrelationID的问题，这里提供两种可行的解决方案：

方案一：直接在StartOperation后覆盖OperationID #

这种方式简单直接，适合单条消息处理的场景：

1. 在消息处理时创建独立的DI作用域（避免跨消息串用CorrelationID）
2. 从DI容器获取TelemetryClient实例（不要手动new）
3. 调用StartOperation后，直接覆盖返回对象的Telemetry.Id和Context.Operation.Id

示例代码：

public class Worker : BackgroundService
{
    private readonly IServiceScopeFactory _scopeFactory;

    public Worker(IServiceScopeFactory scopeFactory)
    {
        _scopeFactory = scopeFactory;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        while (!stoppingToken.IsCancellationRequested)
        {
            // 模拟从消息队列获取带CorrelationID的消息
            var correlationId = Guid.NewGuid().ToString(); // 带横杠的GUID格式

            using var scope = _scopeFactory.CreateScope();
            var telemetryClient = scope.ServiceProvider.GetRequiredService<TelemetryClient>();

            // 启动遥测操作
            using var operation = telemetryClient.StartOperation<RequestTelemetry>("ProcessQueueMessage");
            
            // 覆盖OperationID为自定义CorrelationID
            operation.Telemetry.Id = correlationId;
            operation.Telemetry.Context.Operation.Id = correlationId;

            try
            {
                // 执行消息处理逻辑
                await ProcessMessage(correlationId, stoppingToken);
                operation.Telemetry.Success = true;
            }
            catch (Exception ex)
            {
                operation.Telemetry.Success = false;
                telemetryClient.TrackException(ex);
            }

            await Task.Delay(1000, stoppingToken);
        }
    }

    private async Task ProcessMessage(string correlationId, CancellationToken stoppingToken)
    {
        // 你的业务逻辑
        await Task.Delay(500, stoppingToken);
    }
}

方案二：使用Scoped的ITelemetryInitializer（多遥测事件统一关联） #

如果需要在同一条消息处理的多个遥测事件（比如TrackException、TrackEvent）中统一使用CorrelationID，推荐这种方式：

1. 实现Scoped的初始化器 #

public class ScopedCorrelationInitializer : ITelemetryInitializer
{
    // 用于在作用域内设置自定义CorrelationID
    public string CorrelationId { get; set; }

    public void Initialize(ITelemetry telemetry)
    {
        // 仅当遥测未设置OperationID时覆盖
        if (!string.IsNullOrEmpty(CorrelationId) && string.IsNullOrEmpty(telemetry.Context.Operation.Id))
        {
            telemetry.Context.Operation.Id = CorrelationId;
            // 可选：设置ParentID，用于关联子操作
            // telemetry.Context.Operation.ParentId = CorrelationId;
        }
    }
}

2. 在Program.cs中注册服务 #

var builder = Host.CreateDefaultBuilder(args);
builder.ConfigureServices(services =>
{
    // 注册Application Insights Worker服务
    services.AddApplicationInsightsTelemetryWorkerService();
    // 将初始化器注册为Scoped，确保每个消息作用域独立实例
    services.AddScoped<ScopedCorrelationInitializer>();
    services.AddHostedService<Worker>();
});

var host = builder.Build();
host.Run();

3. 在消息处理中使用 #

protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
    while (!stoppingToken.IsCancellationRequested)
    {
        var correlationId = Guid.NewGuid().ToString();

        using var scope = _scopeFactory.CreateScope();
        var telemetryClient = scope.ServiceProvider.GetRequiredService<TelemetryClient>();
        var correlationInitializer = scope.ServiceProvider.GetRequiredService<ScopedCorrelationInitializer>();

        // 设置当前作用域的CorrelationID
        correlationInitializer.CorrelationId = correlationId;
        // 将初始化器添加到当前TelemetryClient的初始化链中
        telemetryClient.Initializers.Add(correlationInitializer);

        using var operation = telemetryClient.StartOperation<RequestTelemetry>("ProcessQueueMessage");

        try
        {
            await ProcessMessage(correlationId, stoppingToken);
            operation.Telemetry.Success = true;
            // 额外的遥测事件也会自动带上CorrelationID
            telemetryClient.TrackEvent("MessageProcessed", new Dictionary<string, string> { { "CorrelationId", correlationId } });
        }
        catch (Exception ex)
        {
            operation.Telemetry.Success = false;
            telemetryClient.TrackException(ex);
        }

        await Task.Delay(1000, stoppingToken);
    }
}

关键注意事项 #

• 必须从DI容器获取TelemetryClient，不要手动new，否则无法继承Application Insights的配置和初始化逻辑。
• 每个消息处理都要创建独立的DI作用域，避免不同消息的CorrelationID互相干扰。
• StartOperation的重载传入operationId时会自动格式化ID（比如去掉横杠），所以直接覆盖返回对象的属性更可靠。

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