Add SetErrorStatusOnException option to TracerProviderSdk

[reyang]

Related to #1853.

Changes

• Added TracerProviderOptions to allow configurations while creating the tracer provider. Inspired by @CodeBlanch per offline discussion.
• Introduced ExceptionProcessor based on the idea from Automatically detect exceptions and set Activity status #1853.
  • I made this a processor, later we can add more features to it (by supporting more options/flags) - e.g. extract the SEH content and call activity.SetTag.
  • An alternative way is to put the logic inside TraceProviderSdk but I think it will be too bulky (and people who don't use this will pay for an extra if-condition check).

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

• CHANGELOG.md updated for non-trivial changes
• Design discussion issue Automatically detect exceptions and set Activity status #1853
• Changes in public API reviewed

[codecov]

Codecov Report

Merging #1858 (c7b115f) into main (cb066cb) will increase coverage by 0.28%.
The diff coverage is 97.59%.

@@            Coverage Diff             @@
##             main    #1858      +/-   ##
==========================================
+ Coverage   83.77%   84.06%   +0.28%     
==========================================
  Files         187      189       +2     
  Lines        5967     6036      +69     
==========================================
+ Hits         4999     5074      +75     
+ Misses        968      962       -6     

Impacted Files	Coverage Δ
src/OpenTelemetry/Logs/OpenTelemetryLogger.cs	71.42% <ø> (ø)
...rc/OpenTelemetry/Trace/TracerProviderBuilderSdk.cs	88.46% <88.88%> (-2.28%)	⬇️
src/OpenTelemetry/Trace/ExceptionProcessor.cs	90.90% <90.90%> (ø)
src/OpenTelemetry/Trace/TracerProviderSdk.cs	95.16% <98.64%> (+4.38%)	⬆️
...metryProtocol/Implementation/ActivityExtensions.cs	86.89% <100.00%> (+0.05%)	⬆️
...ry.Instrumentation.AspNet/AspNetInstrumentation.cs	100.00% <100.00%> (ø)
...umentation.AspNet/Implementation/HttpInListener.cs	89.10% <100.00%> (ø)
...entation.AspNet/TracerProviderBuilderExtensions.cs	100.00% <100.00%> (ø)
...umentation.AspNetCore/AspNetCoreInstrumentation.cs	100.00% <100.00%> (ø)
...tation.AspNetCore/Implementation/HttpInListener.cs	86.56% <100.00%> (ø)
... and 20 more

[CodeBlanch]

Is it possible to get the type, message, and/or stack from the IntPtr returned from GetExceptionPointers?

[reyang]

Yes it is possible by traveling through the SEH object. This is CPU/OS/platform dependent and not well documented.
https://bytepointer.com/resources/pietrek_crash_course_depths_of_win32_seh.htm.

[CodeBlanch]

Looks petty intense! Not sure if it is worth attempting.

Why I bring it up:

I was just thinking about the applications I have instrumented with OpenTelemetry .NET so far. There are really only a few spots I've had the need to create spans manually. Almost exclusively around queues/topics. In those cases, I'm doing what the example has, with one exception...

catch (Exception ex)
{
   activity.SetStatus(Status.Error.WithDescription(ex.Message));
   throw;
}

...instead of...

catch (Exception)
{
   activity.SetStatus(Status.Error);
   throw;
}

So, commenting from the perspective of a user of the library, since there's only a handful of spots where I have the try/catch, and the message/description is super useful, I'll probably continue doing the try/catch instead of using the processor/option. But if the processor could grab the message too, that would be something.

[reyang]

I'm happy to cover it in a follow up PR.
One heads up, the exceptions we captured here could be any SEH exception - e.g. C++ exception, OS exception.

[reyang]

I'm using #1874 to explore how deep should we go.

[CodeBlanch]

❤️ this guide 😄

[CodeBlanch]

LGTM

[ThomsonTan]

LGTM, thanks!

[cijothomas]

From the doc it looks like its support in all cases except in .NET Core 2.1.
Do you know if it works in windows only?
While we can generally redirect users to official docs, we can list any obvious things right here in this doc . for example, if this only works in Windows, we can mention it here (along with link to official doc)

[reyang]

It works on Mac (x64) and Linux (x86 VM) as I've tested locally (I also created issue #1859 to cover ARM64).