[Http] Update enrich callbacks for http

[vishweshbankwar]

Towards #3495

Changes

The PR splits the enrich callback in to three different callbacks based on the object that can be used to enrich the activity.

Current state:

HttpClientInstrumentationOptions

using System.Net.Http;

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddHttpClientInstrumentation((options) => options.Enrich
    = (activity, eventName, rawObject) =>
    {
        if (eventName.Equals("OnStartActivity"))
        {
            if (rawObject is HttpRequestMessage request)
            {
                activity.SetTag("requestVersion", request.Version);
            }
        }
        else if (eventName.Equals("OnStopActivity"))
        {
            if (rawObject is HttpResponseMessage response)
            {
                activity.SetTag("responseVersion", response.Version);
            }
        }
        else if (eventName.Equals("OnException"))
        {
            if (rawObject is Exception exception)
            {
                activity.SetTag("stackTrace", exception.StackTrace);
            }
        }
    }).Build();

HttpWebRequestInstrumentationOptions

using System.Net;

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddHttpClientInstrumentation((options) => options.Enrich
    = (activity, eventName, rawObject) =>
    {
        if (eventName.Equals("OnStartActivity"))
        {
            if (rawObject is HttpWebRequest request)
            {
                activity.SetTag("requestVersion", request.ProtocolVersion);
            }
        }
        else if (eventName.Equals("OnStopActivity"))
        {
            if (rawObject is HttpWebResponse response)
            {
                activity.SetTag("responseVersion", response.ProtocolVersion);
            }
        }
        else if (eventName.Equals("OnException"))
        {
            if (rawObject is Exception exception)
            {
                activity.SetTag("stackTrace", exception.StackTrace);
            }
        }
    }).Build();

New state:

HttpClientInstrumentationOptions

using System.Net.Http;

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddHttpClientInstrumentation((options) =>
    {
        options.EnrichWithHttpRequestMessage = (activity, httpRequestMessage) =>
        {
            activity.SetTag("requestVersion", httpRequestMessage.Version);
        };
        options.EnrichWithHttpResponseMessage = (activity, httpResponseMessage) =>
        {
            activity.SetTag("responseVersion", httpResponseMessage.Version);
        };
        options.EnrichWithException = (activity, exception) =>
        {
            activity.SetTag("stackTrace", exception.StackTrace);
        };
    })
    .Build();

HttpWebRequestInstrumentationOptions

using System.Net;

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddHttpClientInstrumentation((options) =>
    {
        options.EnrichWithHttpWebRequest = (activity, httpWebRequest) =>
        {
            activity.SetTag("requestVersion", httpWebRequest.Version);
        };
        options.EnrichWithHttpWebResponse = (activity, httpWebResponse) =>
        {
            activity.SetTag("responseVersion", httpWebResponse.Version);
        };
        options.EnrichWithException = (activity, exception) =>
        {
            activity.SetTag("stackTrace", exception.StackTrace);
        };
    })
    .Build();

For significant contributions please make sure you have completed the following items:

• Appropriate CHANGELOG.md updated for non-trivial changes
• Design discussion issue #
• Changes in public API reviewed

[codecov]

Codecov Report

Merging #3792 (6de48ff) into main (0c31fb9) will increase coverage by 0.25%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3792      +/-   ##
==========================================
+ Coverage   87.13%   87.38%   +0.25%     
==========================================
  Files         280      280              
  Lines       10763    10767       +4     
==========================================
+ Hits         9378     9409      +31     
+ Misses       1385     1358      -27     

Impacted Files	Coverage Δ
...mentation.Http/HttpClientInstrumentationOptions.cs	100.00% <100.00%> (ø)
...Http/HttpWebRequestInstrumentationOptions.netfx.cs	100.00% <100.00%> (ø)
...tp/Implementation/HttpHandlerDiagnosticListener.cs	73.19% <100.00%> (ø)
...plementation/HttpWebRequestActivitySource.netfx.cs	80.09% <100.00%> (ø)
...emetry.Api/Internal/OpenTelemetryApiEventSource.cs	76.47% <0.00%> (-5.89%)	⬇️
...Telemetry/Internal/SelfDiagnosticsEventListener.cs	96.87% <0.00%> (-0.79%)	⬇️
...tpListener/Internal/PrometheusCollectionManager.cs	75.82% <0.00%> (+2.19%)	⬆️
...p/Implementation/HttpInstrumentationEventSource.cs	76.00% <0.00%> (+4.00%)	⬆️
...lementation/SqlClientInstrumentationEventSource.cs	75.00% <0.00%> (+4.16%)	⬆️
...metryProtocol/Implementation/ActivityExtensions.cs	96.21% <0.00%> (+4.32%)	⬆️
... and 4 more

[JWilh]

I personally like it, but maybe it's better to not do a breaking change? You could keep the old Enrich property (marking it as Obsolete only) and simply call both for now and remove it in a "v2" or is this lib still in "prerelease" mode?

[Kielek]

I personally like it, but maybe it's better to not do a breaking change? You could keep the old Enrich property (marking it as Obsolete only) and simply call both for now and remove it in a "v2" or is this lib still in "prerelease" mode?

Prerelease channel, there is not stable releases on the nuget.org: https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Http/#versions-body-tab

[CodeBlanch]

LGTM