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

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Report a new _Diagnostic_ (`SENTRY1001`) when an (experimental) Metrics-API is invoked with an unsupported numeric type ([#4840](https://github.com/getsentry/sentry-dotnet/pull/4840))
+
 ### Fixes
 
 - The SDK now logs a `Warning` instead of an `Error` when being ratelimited ([#4927](https://github.com/getsentry/sentry-dotnet/pull/4927))

src/Sentry.Compiler.Extensions/AnalyzerReleases.Shipped.md

@@ -0,0 +1,3 @@
+; Shipped analyzer releases
+; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
+

src/Sentry.Compiler.Extensions/AnalyzerReleases.Unshipped.md

@@ -0,0 +1,8 @@
+; Unshipped analyzer release
+; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
+
+### New Rules
+
+Rule ID | Category | Severity | Notes
+--------|----------|----------|-------
+SENTRY1001 | Sentry | Warning | TraceConnectedMetricsAnalyzer

src/Sentry.Compiler.Extensions/Analyzers/TraceConnectedMetricsAnalyzer.cs

@@ -0,0 +1,113 @@
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.Diagnostics;
+using Microsoft.CodeAnalysis.Operations;
+
+namespace Sentry.Compiler.Extensions.Analyzers;
+
+/// <summary>
+/// Guide consumers to use the public API of <see href="https://develop.sentry.dev/sdk/telemetry/metrics/">Sentry Trace-connected Metrics</see> correctly.
+/// </summary>
+[DiagnosticAnalyzer(LanguageNames.CSharp)]
+public sealed class TraceConnectedMetricsAnalyzer : DiagnosticAnalyzer
+{
+    private const string Title = "Unsupported numeric type of Metric";
+    private const string MessageFormat = "{0} is unsupported type for Sentry Metrics. The only supported types are byte, short, int, long, float, and double.";
+    private const string Description = "Integers should be a 64-bit signed integer, while doubles should be a 64-bit floating point number.";
+
+    private static readonly DiagnosticDescriptor Rule = new(
+        id: DiagnosticIds.Sentry1001,
+        title: Title,
+        messageFormat: MessageFormat,
+        category: DiagnosticCategories.Sentry,
+        defaultSeverity: DiagnosticSeverity.Warning,
+        isEnabledByDefault: true,
+        description: Description,
+        helpLinkUri: null
+    );
+
+    /// <inheritdoc />
+    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);
+
+    /// <inheritdoc />
+    public override void Initialize(AnalysisContext context)
+    {
+        context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
+        context.EnableConcurrentExecution();
+
+        context.RegisterOperationAction(Execute, OperationKind.Invocation);
+    }
+
+    private static void Execute(OperationAnalysisContext context)
+    {
+        Debug.Assert(context.Operation.Language == LanguageNames.CSharp);
+        Debug.Assert(context.Operation.Kind is OperationKind.Invocation);
+
+        context.CancellationToken.ThrowIfCancellationRequested();
+
+        if (context.Operation is not IInvocationOperation invocation)
+        {
+            return;
+        }
+
+        var method = invocation.TargetMethod;
+        if (method.DeclaredAccessibility != Accessibility.Public || method.IsStatic || method.Parameters.Length == 0)
+        {
+            return;
+        }
+
+        if (!method.IsGenericMethod || method.Arity != 1 || method.TypeArguments.Length != 1)
+        {
+            return;
+        }
+
+        if (method.ContainingAssembly is null || method.ContainingAssembly.Name != "Sentry")
+        {
+            return;
+        }
+
+        if (method.ContainingNamespace is null || method.ContainingNamespace.Name != "Sentry")
+        {
+            return;
+        }
+
+        string fullyQualifiedMetadataName;
+        if (method.Name is "EmitCounter" or "EmitGauge" or "EmitDistribution")
+        {
+            fullyQualifiedMetadataName = "Sentry.SentryMetricEmitter";
+        }
+        else if (method.Name is "TryGetValue")
+        {
+            fullyQualifiedMetadataName = "Sentry.SentryMetric";
+        }
+        else
+        {
+            return;
+        }
+
+        var typeArgument = method.TypeArguments[0];
+        if (typeArgument.SpecialType is SpecialType.System_Byte or SpecialType.System_Int16 or SpecialType.System_Int32 or SpecialType.System_Int64 or SpecialType.System_Single or SpecialType.System_Double)
+        {
+            return;
+        }
+
+        if (typeArgument is ITypeParameterSymbol)
+        {
+            return;
+        }
+
+        var sentryType = context.Compilation.GetTypeByMetadataName(fullyQualifiedMetadataName);
+        if (sentryType is null)
+        {
+            return;
+        }
+
+        if (!SymbolEqualityComparer.Default.Equals(method.ContainingType, sentryType))
+        {
+            return;
+        }
+
+        var location = invocation.Syntax.GetLocation();
+        var diagnostic = Diagnostic.Create(Rule, location, typeArgument.ToDisplayString(SymbolDisplayFormats.FullNameFormat));
+        context.ReportDiagnostic(diagnostic);
+    }
+}

src/Sentry.Compiler.Extensions/DiagnosticCategories.cs

@@ -0,0 +1,6 @@
+namespace Sentry.Compiler.Extensions;
+
+internal static class DiagnosticCategories
+{
+    internal const string Sentry = nameof(Sentry);
+}

src/Sentry.Compiler.Extensions/DiagnosticIds.cs

@@ -0,0 +1,6 @@
+namespace Sentry.Compiler.Extensions;
+
+internal static class DiagnosticIds
+{
+    internal const string Sentry1001 = "SENTRY1001";
+}

src/Sentry.Compiler.Extensions/Sentry.Compiler.Extensions.csproj

@@ -15,11 +15,36 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.3.1" PrivateAssets="all"/>
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.3.1" PrivateAssets="all" />
   </ItemGroup>
 
+  <!--
+    We use Simon Cropp's Polyfill source-only package to access APIs in lower targets.
+    https://github.com/SimonCropp/Polyfill
+  -->
+  <ItemGroup>
+    <PackageReference Include="Polyfill" Version="9.8.1" PrivateAssets="all" />
+  </ItemGroup>
+  <!-- We currently don't require Polyfills for System.Memory. Ensure the feature is disabled and suppress the MSBuild Warning from Polyfill. -->
+  <Target Name="BeforePreparePolyfill" BeforeTargets="PreparePolyfill">
+    <PropertyGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
+      <PolyfillNoWarnIncorrectVersion>true</PolyfillNoWarnIncorrectVersion>
+    </PropertyGroup>
+  </Target>
+  <Target Name="AfterPreparePolyfill" AfterTargets="PreparePolyfill" DependsOnTargets="PreparePolyfill">
+    <PropertyGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
+      <DefineConstants>$([System.String]::Copy('$(DefineConstants)').Replace('FeatureMemory','').Replace(';;',';'))</DefineConstants>
+    </PropertyGroup>
+  </Target>
+
   <ItemGroup>
     <Using Remove="System.Text.Json" />
     <Using Remove="System.Text.Json.Serialization" />
   </ItemGroup>
+
+  <ItemGroup>
+    <AdditionalFiles Remove="AnalyzerReleases.Shipped.md" />
+    <AdditionalFiles Remove="AnalyzerReleases.Unshipped.md" />
+  </ItemGroup>
+
 </Project>

src/Sentry.Compiler.Extensions/SymbolDisplayFormats.cs

@@ -0,0 +1,12 @@
+using Microsoft.CodeAnalysis;
+
+namespace Sentry.Compiler.Extensions;
+
+internal static class SymbolDisplayFormats
+{
+    internal static SymbolDisplayFormat FullNameFormat { get; } = new(
+        globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Omitted,
+        typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces,
+        genericsOptions: SymbolDisplayGenericsOptions.IncludeTypeParameters
+    );
+}