feat(metrics): Trace-connected Metrics (Analyzers)

[Flash0ver]

based on

• feat(metrics): Trace-connected Metrics (Implementation) #4834

My little weekend-project:
Add a Diagnostic-Analyzer to our Compiler-Extensions, that warn users when a metric would not be emitted due to an unsupported numeric value type.

Context:
For the numeric type of a Metric, we currently allow 64-bit sized integral (signed) and floating-point numbers.
That means that e.g. ulong, System.Int128, or decimal are currently not supported by Sentry.
The compile-time constraint of Sentry.SentryMetric<T> only constrains to non-nullable value types.
Alternatively, we could have implemented respectively types overloads for the method groups:

public void EmitCounter<T>(string name, long value);
public void EmitCounter<T>(string name, float value);
public void EmitCounter<T>(string name, double value);
public void EmitCounter<T>(string name, long value, Scope? scope)
public void EmitCounter<T>(string name, float value, Scope? scope)
public void EmitCounter<T>(string name, double value, Scope? scope)
public void EmitCounter<T> ..

public void EmitGauge<T> ..
public void EmitDistribution<T> ..

To avoid this explosion of overloads per method group,
and be similar to the implementation of System.Diagnostics.Metrics,
we are not compile-time constraining unsupported types,
but are instead run-time constraining unsupported types (no-op and Debug-Diagnostic-Logging).

To still warn users unfamiliar with the System.Diagnostics.Metrics.Meter-based APIs,
I built an Analyzer over two weekends to guide new users.

options.Experimental.SetBeforeSendMetric<int>(static SentryMetric<int>? (SentryMetric<int> metric) => metric);
options.Experimental.SetBeforeSendMetric<uint>(static SentryMetric<uint>? (SentryMetric<uint> metric) => metric); //SENTRY1001

SentrySdk.Experimental.Metrics.EmitCounter("my.counter", 1);
SentrySdk.Experimental.Metrics.EmitCounter("my.counter", 1m); //SENTRY1001
SentrySdk.Experimental.Metrics.EmitCounter("my.counter", StringComparison.CurrentCultureIgnoreCase); //SENTRY1001
SentrySdk.Experimental.Metrics.EmitCounter<ulong>("my.counter", default); //SENTRY1001

#skip-changelog

[github-actions]

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against b87bc4d

[codecov]

Codecov Report

❌ Patch coverage is 74.07407% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.59%. Comparing base (d730432) to head (b87bc4d).
⚠️ Report is 2 commits behind head on feat/trace-connected-metrics.

Files with missing lines	Patch %	Lines
...ensions/Analyzers/TraceConnectedMetricsAnalyzer.cs	71.42%	7 Missing and 7 partials ⚠️

Additional details and impacted files

@@                       Coverage Diff                        @@
##           feat/trace-connected-metrics    #4840      +/-   ##
================================================================
+ Coverage                         72.58%   72.59%   +0.01%     
================================================================
  Files                               495      497       +2     
  Lines                             17893    17947      +54     
  Branches                           3523     3534      +11     
================================================================
+ Hits                              12988    13029      +41     
- Misses                             4048     4055       +7     
- Partials                            857      863       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.