Make debug diagnostic logger obsolete and add Trace diagnostic logger.

[lucas-zimerman]

DebugDiagnosticLogger only works with projects inside Sentry.NET.snl since Release builds remove the Debug code, making it useless to the end-user.
Another approach is to use Trace as a replacement, it's not as simple as the good old DebugDiagnosticLogger but it should work just fine even in Release mode.

Close #1040.

It would be great if I could simply use Trace.Write but it seems like the compiler gets rid of it if not called from the current process.

EDIT: Validated on

• .NET 5 Console
• .NET Core with IIS
• .NET Native UWP

[codecov-commenter]

Codecov Report

Merging #1048 (ee449fe) into main (93b93dc) will decrease coverage by 0.15%.
The diff coverage is 16.66%.

@@            Coverage Diff             @@
##             main    #1048      +/-   ##
==========================================
- Coverage   81.33%   81.17%   -0.16%     
==========================================
  Files         193      194       +1     
  Lines        6338     6349      +11     
  Branches     1528     1530       +2     
==========================================
- Hits         5155     5154       -1     
- Misses        747      758      +11     
- Partials      436      437       +1     

Impacted Files	Coverage Δ
src/Sentry/Infrastructure/DebugDiagnosticLogger.cs	0.00% <ø> (-50.00%)	⬇️
src/Sentry/Infrastructure/TraceDiagnosticLogger.cs	9.09% <9.09%> (ø)
src/Sentry.AspNet/SentryAspNetOptionsExtensions.cs	90.00% <100.00%> (ø)
src/Sentry/Internal/BackgroundWorker.cs	84.24% <0.00%> (-0.69%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 93b93dc...ee449fe. Read the comment docs.

[lucas-zimerman]

It works, not a fan of this line and linq doesn't work with listeners.

[Tyrrrz]

Maybe we should write to all listeners, not just one?

[Tyrrrz]

Does the trace logger not work without TRACE constant?

[bruno-garcia]

I wonder if we're adding overhead to the SDK by setting this. We're not explicitly adding anything that depends on TRACE constant being defined so I assume it wouldn't matter but it does make me wonder. Does it affect the size of the binary at all for example?

[lucas-zimerman]

Trace.Write/WriteLine doesn't work without the TRACE trace constant. Trace.Listeners are exposed with or without the TRACE constant, but in my opinion, it's better to use set the TRACE constant and using the build-in Trace.Write instead of reinventing the wheel.

The package sizes are:
1,076,098 bytes with the TRACE constant
1,076,158 bytes without the TRACE constant and without the Trace Logger file
1,077,102 bytes without it.
1,077,858 bytes without the trace constant with the addition of a loop to write to all listeners.
1,080,993 bytes adding the DEBUG constant (out of curiosity, this allows the debug diagnostic logger to work properly in release)

[bruno-garcia]

I wonder if we're adding overhead to the SDK by setting this. We're not explicitly adding anything that depends on TRACE constant being defined so I assume it wouldn't matter but it does make me wonder. Does it affect the size of the binary at all for example?

[bruno-garcia]

@lucas-zimerman and I talked on a call and decided to drop the constant and use the listeners. This is a logger for debug purposes and we don't wanta to add a trace constant to a release build