[ASP.NET Core] Update enrich callbacks to use specific type.

[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:

services.AddOpenTelemetryTracing((builder) =>
{
    builder.AddAspNetCoreInstrumentation((options) => options.Enrich
        = (activity, eventName, rawObject) =>
    {
        if (eventName.Equals("OnStartActivity"))
        {
            if (rawObject is HttpRequest httpRequest)
            {
                activity.SetTag("requestProtocol", httpRequest.Protocol);
            }
        }
        else if (eventName.Equals("OnStopActivity"))
        {
            if (rawObject is HttpResponse httpResponse)
            {
                activity.SetTag("responseLength", httpResponse.ContentLength);
            }
        }
    })
});

New state:

services.AddOpenTelemetryTracing((builder) =>
{
    builder.AddAspNetCoreInstrumentation(o =>
    {
        o.EnrichWithHttpRequest = (activity, httpRequest) =>
        {
            activity.SetTag("requestProtocol", httpRequest.Protocol);
        };
        o.EnrichWithHttpResponse = (activity, httpResponse) =>
        {
            activity.SetTag("responseLength", httpResponse.ContentLength);
        };
        o.EnrichWithException = (activity, exception) =>
        {
            activity.SetTag("exceptionType", exception.GetType().ToString());
        };
    })
});

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 #3749 (bd814f1) into main (82a3353) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3749      +/-   ##
==========================================
+ Coverage   87.32%   87.33%   +0.01%     
==========================================
  Files         280      280              
  Lines       10761    10763       +2     
==========================================
+ Hits         9397     9400       +3     
+ Misses       1364     1363       -1     

Impacted Files	Coverage Δ
...ion.AspNetCore/AspNetCoreInstrumentationOptions.cs	100.00% <100.00%> (ø)
...tation.AspNetCore/Implementation/HttpInListener.cs	90.24% <100.00%> (ø)
...ter.ZPages/Implementation/ZPagesActivityTracker.cs	97.14% <0.00%> (-2.86%)	⬇️
...metryProtocol/Implementation/ActivityExtensions.cs	95.13% <0.00%> (-1.09%)	⬇️
...Telemetry/Internal/SelfDiagnosticsEventListener.cs	96.87% <0.00%> (-0.79%)	⬇️
...lementation/SqlClientInstrumentationEventSource.cs	75.00% <0.00%> (+4.16%)	⬆️
...emetry.Api/Internal/OpenTelemetryApiEventSource.cs	82.35% <0.00%> (+5.88%)	⬆️
...ZPages/Implementation/ZPagesExporterEventSource.cs	62.50% <0.00%> (+6.25%)	⬆️
...Propagators/OpenTelemetryPropagatorsEventSource.cs	100.00% <0.00%> (+12.50%)	⬆️

[cijothomas]

Hold off merging until @utpilla completes a release today. Want to make sure all breaking changes in this area are part of same release.

[cijothomas]

LGTM.
Please update the PR description to clearly indicate what action is expected from users when they update to this version, with code snippets. This is breaking change, so need to make it as smooth as possible.

[alanwest]

LGTM. Proposed some changelog verbiage.

[cijothomas]

💯