OpenTelemetry AddSqlClientInstrumentation是否兼容Azure Functions SQL输出绑定？

我本地运行着一个采用隔离工作进程的Azure Function，希望使用OpenTelemetry contrib包而非Functions运行时的内置功能来实现OpenTelemetry集成。

根据了解，OpenTelemetry.Instrumentation.SqlClient中的.AddSqlClientInstrumentation()应该能追踪使用Microsoft.Data.SQLClient的SQL调用，而Azure Functions的SQL输出绑定似乎正是基于该组件。但我并未发现它生效的迹象，而HttpClient的instrumentation工作正常，说明OpenTelemetry的整体配置是没问题的。我猜测SQL输出绑定扩展可能运行在宿主工作进程而非应用工作进程中，但查阅扩展生命周期文档后无法确认这一点。

补充上下文 #

我更关注Sql工具库的架构是否在Azure Functions运行时存在兼容性问题，而非代码调试，以下是相关代码供参考：

Program.cs 配置 #

var builder = new HostBuilder()
    .ConfigureFunctionsWebApplication()
    .ConfigureServices(services =>
    {

        services.AddOpenTelemetry()
            .ConfigureResource(resource => resource.AddService(serviceName))
            .WithTracing(tracing => tracing
                .AddAspNetCoreInstrumentation()
                .AddSqlClientInstrumentation(options => options.SetDbStatementForText = true)
                .AddHttpClientInstrumentation()
                .AddConsoleExporter()
                .AddAzureMonitorTraceExporter(options => options.ConnectionString = "XXX")
                );

    })
    .ConfigureLogging(logging =>
    {
        logging.AddOpenTelemetry(options => options
                .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService(serviceName))
                .AddAzureMonitorLogExporter(options => options.ConnectionString = "XXX")
                .AddConsoleExporter());
    })
    .UseDefaultServiceProvider(x => x.ValidateOnBuild = true);

var host = builder.Build();

host.Run();

包引用 #

<FrameworkReference Include="Microsoft.AspNetCore.App" />
    <PackageReference Include="Azure.Monitor.OpenTelemetry.Exporter" Version="1.3.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.23.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.2.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore" Version="1.3.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Sql" Version="3.0.534" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.17.3-preview2" />
    <PackageReference Include="Microsoft.ApplicationInsights.WorkerService" Version="2.22.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="1.2.0" />
    <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.9.0" />
    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.9.0" />
    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
    <PackageReference Include="OpenTelemetry.Instrumentation.SqlClient" Version="1.9.0-beta.1" />

host.json 配置 #

{
    "version": "2.0",
    "logging": {
        "applicationInsights": {
            "samplingSettings": {
                "isEnabled": true,
                "excludedTypes": "Request"
            },
            "enableLiveMetricsFilters": true,
            "enableDependencyTracking": true,    
            "dependencyTrackingOptions": {
                "enableSqlCommandTextInstrumentation": true
            }
        }
    },
    "logLevel": {
        "default": "Information"
    },
    "telemetryMode": "openTelemetry"
}

SQL输出绑定代码 #

public class NewUserOutputBinding
    {

        [SqlOutput("dbo.Users", connectionStringSetting: "SqlConnectionString")]
        public required User User { get; set; }

        [HttpResult]
        public required IActionResult HttpResponse { get; set; }

    }

解答 #

目前隔离进程模式下，OpenTelemetry.SqlClient Instrumentation无法追踪Azure Functions SQL输出绑定的SQL调用，核心原因如下：

1. 进程隔离限制：SQL输出绑定扩展的执行逻辑运行在宿主进程而非你的应用工作进程中。OpenTelemetry的Instrumentation基于应用进程内的代码注入实现，无法跨进程追踪宿主进程中的SQL操作。
2. 内置Telemetry独立性：Azure Functions运行时的内置依赖追踪（包括SQL绑定）独立于应用自定义的OpenTelemetry管道，即使设置telemetryMode: "openTelemetry"，当前版本的SQL绑定扩展也未适配将内部SQL操作的追踪数据注入到自定义管道中。
3. Instrumentation作用范围：AddSqlClientInstrumentation()仅能追踪当前应用进程内通过Microsoft.Data.SqlClient发起的直接调用，而SQL输出绑定的数据库操作由扩展在宿主侧封装执行，不在应用进程上下文内，因此无法被捕获。

临时替代方案 #

如果需要追踪SQL输出绑定的操作，可以：

• 改用直接在函数代码中使用Microsoft.Data.SqlClient执行SQL写入，而非依赖输出绑定，这样OpenTelemetry就能正常捕获追踪数据。
• 依赖Azure Functions内置的Application Insights追踪（配置中的enableDependencyTracking已开启），但这无法纳入自定义的OpenTelemetry管道。

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