Add OpenTelemetry tracing instrumentation for SqlClient

[roji]

SqlClient itself doesn't emit OpenTelemetry tracing, but an instrumentation package exists for that; this emits traces for each command executed.

Aspire.Microsoft.Data.SqlClient currently wires up event counter-based metrics, but does not wire up tracing - we should add that to get traces out-of-the-box.

/cc @AndriySvyryd

[davidfowl]

@roji is this something you're planning to contribute?

[roji]

@davidfowl no immediate plans, no... But note that for tracing there's an external instrumentation package, which can be used and makes this less urgent.

Unfortunately the same isn't true for metrics, see #2211...

[skolima]

Update: current version of Aspire for SqlClient registers open telemetry support. Kinda.

1. The Aspire.Microsoft.Data.SqlClient package does not depend on OpenTelemetry.Instrumentation.SqlClient so that dependency needs to be added directly into consumer's .csproj
2. There is currently now plug-in point to set custom options for the tracing configuration.

We had to set Aspire:Microsoft:Data:SqlClient:DisableTracing to true because it was disabling the options we wanted, and register the sql client instrumentation explicitly:

.AddSqlClientInstrumentation(
o =>
{
    o.SetDbStatementForStoredProcedure = true;
    o.SetDbStatementForText = true;
    o.RecordException = true;
})

It would be nice if those were exposed from the Aspire's .AddSqlServerClient or from the configuration. Better defaults here would be nice, too.

[alefcarlos]

@davidfowl,

SqlClientTraceInstrumentationOptions is internal, so we cant configure the options. Why did you duplicate de sourcecode instead of using the contrib-package ?

[davidfowl]

IIRC OpenTelemetry.Instrumentation.SqlClient has no non-prerelease version

cc @eerhardt

[alefcarlos]

I got it. Thank you!

@davidfowl, @eerhardt

Is there any chance to change the *Options types to public ?

[eerhardt]

Until OpenTelemetry.Instrumentation.SqlClient becomes stable (or the tracing is built into SqlClient directly), we wouldn't expose these APIs from the Aspire client integration package.

We had to set Aspire:Microsoft:Data:SqlClient:DisableTracing to true because it was disabling the options we wanted, and register the sql client instrumentation explicitly:

This would be my recommendation until that time.