Azure SDK for .NET 中解决 Azure Monitor Distro 重复 SQL 依赖追踪问题

在使用 Azure Monitor Distro 进行应用监控时，开发者可能会遇到 SQL 依赖追踪重复出现的问题。本文将深入分析问题原因，并提供多种解决方案。

问题现象

当开发者同时使用 Azure Monitor Distro 和手动配置 SqlClientInstrumentation 时，会出现 SQL 依赖追踪重复记录的情况。具体表现为：

• 每个 SQL 操作会生成两个追踪记录
• 一个记录包含完整的 SQL 语句文本
• 另一个记录不包含 SQL 语句文本
• 两个记录的属性也不完全相同

根本原因分析

这个问题源于 Azure Monitor Distro 内部已经包含了 SqlClientInstrumentation 的默认配置。当开发者再次手动添加 SqlClientInstrumentation 时，实际上创建了两个独立的检测器实例，导致每个 SQL 操作被记录两次。

解决方案

方案一：完全自定义配置

放弃使用 Azure Monitor Distro，改用 Azure Monitor Exporter 并手动配置所有需要的检测器：

builder.Services.AddOpenTelemetry()
    .WithTracing(builder => 
    {
        builder.AddAzureMonitorTraceExporter();
        builder.AddSqlClientInstrumentation(options => 
        {
            options.RecordException = true;
            options.SetDbStatementForText = true;
        });
        // 添加其他需要的检测器
    });

方案二：环境变量配置

通过环境变量配置 SqlClientInstrumentation 而不修改代码：

OTEL_DOTNET_AUTO_SQLCLIENT_SET_DBSTATEMENT_FOR_TEXT=true
OTEL_DOTNET_AUTO_SQLCLIENT_RECORD_EXCEPTION=true

方案三：等待官方更新

目前 Azure Monitor Distro 不提供排除特定检测器的功能。可以关注官方更新，未来版本可能会提供更灵活的配置选项。

最佳实践建议

1. 对于新项目，建议采用方案一的完全自定义配置方式，可以获得最大的灵活性
2. 对于已有项目，如果已经大量使用 Azure Monitor Distro，可以采用环境变量配置
3. 使用 Entity Framework Core 时，可以考虑添加对应的检测器而不是 SqlClientInstrumentation
4. 定期检查 Azure SDK 的更新日志，关注相关功能的改进

总结

重复的 SQL 依赖追踪问题源于检测器的重复配置。开发者需要根据项目实际情况选择合适的解决方案。随着 Azure Monitor OpenTelemetry 生态的不断完善，未来这类配置问题将会得到更好的解决。