[Exporter.OpenTelemetryProtocol] enable analysis (#6251)

Author: Kielek

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Builder/OpenTelemetryBuilderOtlpExporterExtensions.cs

@@ -36,7 +36,9 @@ public static class OpenTelemetryBuilderOtlpExporterExtensions
     /// <returns>Supplied <see cref="IOpenTelemetryBuilder"/> for chaining calls.</returns>
     public static IOpenTelemetryBuilder UseOtlpExporter(
         this IOpenTelemetryBuilder builder)
+#pragma warning disable CA1062 // Validate arguments of public methods
         => UseOtlpExporter(builder, name: null, configuration: null, configure: null);
+#pragma warning restore CA1062 // Validate arguments of public methods
 
     /// <summary><inheritdoc cref="UseOtlpExporter(IOpenTelemetryBuilder)"/></summary>
     /// <remarks><inheritdoc cref="UseOtlpExporter(IOpenTelemetryBuilder)" path="/remarks"/></remarks>
@@ -56,7 +58,9 @@ public static IOpenTelemetryBuilder UseOtlpExporter(
     {
         Guard.ThrowIfNull(baseUrl);
 
+#pragma warning disable CA1062 // Validate arguments of public methods
         return UseOtlpExporter(builder, name: null, configuration: null, configure: otlpBuilder =>
+#pragma warning restore CA1062 // Validate arguments of public methods
         {
             otlpBuilder.ConfigureDefaultExporterOptions(o =>
             {

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/Grpc/.editorconfig

@@ -0,0 +1,2 @@
+[*.cs]
+generated_code = true

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/Grpc/GrpcProtocolHelpers.cs

@@ -1,6 +1,8 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#nullable enable
+
 // Copyright 2019 The gRPC Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/Grpc/GrpcStatusDeserializer.cs

@@ -1,6 +1,8 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#nullable enable
+
 using System.Text;
 
 namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation.ExportClient.Grpc;

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/Grpc/Status.cs

@@ -1,6 +1,8 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#nullable enable
+
 // Copyright 2015 gRPC authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/Grpc/StatusCode.cs

@@ -1,6 +1,8 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#nullable enable
+
 // Copyright 2015 gRPC authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/Grpc/TrailingHeadersHelpers.cs

@@ -1,6 +1,8 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
+#nullable enable
+
 // Copyright 2019 The gRPC Authors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/OtlpExportClient.cs

@@ -14,19 +14,12 @@ internal abstract class OtlpExportClient : IExportClient
     private static readonly Version Http2RequestVersion = new(2, 0);
 
 #if NET
-    private static readonly bool SynchronousSendSupportedByCurrentPlatform;
-
-    static OtlpExportClient()
-    {
-#if NET
-        // See: https://github.com/dotnet/runtime/blob/280f2a0c60ce0378b8db49adc0eecc463d00fe5d/src/libraries/System.Net.Http/src/System/Net/Http/HttpClientHandler.AnyMobile.cs#L767
-        SynchronousSendSupportedByCurrentPlatform = !OperatingSystem.IsAndroid()
+    // See: https://github.com/dotnet/runtime/blob/280f2a0c60ce0378b8db49adc0eecc463d00fe5d/src/libraries/System.Net.Http/src/System/Net/Http/HttpClientHandler.AnyMobile.cs#L767
+    private static readonly bool SynchronousSendSupportedByCurrentPlatform = !OperatingSystem.IsAndroid()
             && !OperatingSystem.IsIOS()
             && !OperatingSystem.IsTvOS()
             && !OperatingSystem.IsBrowser();
 #endif
-    }
-#endif
 
     protected OtlpExportClient(OtlpExporterOptions options, HttpClient httpClient, string signalPath)
     {

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/OtlpGrpcExportClient.cs

@@ -46,7 +46,7 @@ public override ExportClientResponse SendExportRequest(byte[] buffer, int conten
             var trailingHeaders = httpResponse.TrailingHeaders();
             Status status = GrpcProtocolHelpers.GetResponseStatus(httpResponse, trailingHeaders);
 
-            if (status.Detail.Equals(Status.NoReplyDetailMessage))
+            if (status.Detail.Equals(Status.NoReplyDetailMessage, StringComparison.Ordinal))
             {
 #if NET
                 using var responseStream = httpResponse.Content.ReadAsStream(cancellationToken);

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ExportClient/OtlpRetry.cs

@@ -3,6 +3,9 @@
 
 using System.Net;
 using System.Net.Http.Headers;
+#if NET
+using System.Security.Cryptography;
+#endif
 using OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation.ExportClient.Grpc;
 
 namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation.ExportClient;
@@ -40,13 +43,12 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation.ExportClie
 /// </summary>
 internal static class OtlpRetry
 {
-    public const string GrpcStatusDetailsHeader = "grpc-status-details-bin";
     public const int InitialBackoffMilliseconds = 1000;
     private const int MaxBackoffMilliseconds = 5000;
     private const double BackoffMultiplier = 1.5;
 
 #if !NET
-    private static readonly Random Random = new Random();
+    private static readonly Random Random = new();
 #endif
 
     public static bool TryGetHttpRetryResult(ExportClientHttpResponse response, int retryDelayInMilliSeconds, out RetryResult retryResult)
@@ -156,9 +158,7 @@ private static bool TryGetRetryResult<TStatusCode, TCarrier>(TStatusCode statusC
             return false;
         }
 
-        var delayDuration = throttleDelay.HasValue
-            ? throttleDelay.Value
-            : TimeSpan.FromMilliseconds(GetRandomNumber(0, nextRetryDelayMilliseconds));
+        var delayDuration = throttleDelay ?? TimeSpan.FromMilliseconds(GetRandomNumber(0, nextRetryDelayMilliseconds));
 
         if (deadline.HasValue && IsDeadlineExceeded(deadline + delayDuration))
         {
@@ -246,13 +246,15 @@ private static bool IsHttpStatusCodeRetryable(HttpStatusCode statusCode, bool ha
     private static int GetRandomNumber(int min, int max)
     {
 #if NET
-        return Random.Shared.Next(min, max);
+        return RandomNumberGenerator.GetInt32(min, max);
 #else
         // TODO: Implement this better to minimize lock contention.
         // Consider pulling in Random.Shared implementation.
         lock (Random)
         {
+#pragma warning disable CA5394 // Do not use insecure randomness
             return Random.Next(min, max);
+#pragma warning restore CA5394 // Do not use insecure randomness
         }
 #endif
     }

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/Serializer/ProtobufOtlpLogSerializer.cs

@@ -223,7 +223,7 @@ internal static int WriteLogRecord(byte[] buffer, int writePosition, SdkLimitOpt
                 // Special casing {OriginalFormat}
                 // See https://github.com/open-telemetry/opentelemetry-dotnet/pull/3182
                 // for explanation.
-                if (attribute.Key.Equals("{OriginalFormat}") && !bodyPopulatedFromFormattedMessage)
+                if (attribute.Key.Equals("{OriginalFormat}", StringComparison.Ordinal) && !bodyPopulatedFromFormattedMessage)
                 {
                     otlpTagWriterState.WritePosition = WriteLogRecordBody(otlpTagWriterState.Buffer, otlpTagWriterState.WritePosition, (attribute.Value as string).AsSpan());
                     isLogRecordBodySet = true;
@@ -270,7 +270,7 @@ static void ProcessScope(LogRecordScope scope, SerializationState state)
         {
             foreach (var scopeItem in scope)
             {
-                if (scopeItem.Key.Equals("{OriginalFormat}") || string.IsNullOrEmpty(scopeItem.Key))
+                if (scopeItem.Key.Equals("{OriginalFormat}", StringComparison.Ordinal) || string.IsNullOrEmpty(scopeItem.Key))
                 {
                     // Ignore if the scope key is empty.
                     // Ignore if the scope key is {OriginalFormat}

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/Serializer/ProtobufOtlpMetricSerializer.cs

@@ -29,7 +29,7 @@ internal static int WriteMetricsData(ref byte[] buffer, int writePosition, Resou
             var metricName = metric.MeterName;
             if (!scopeMetricsList.TryGetValue(metricName, out var metrics))
             {
-                metrics = metricListPool.Count > 0 ? metricListPool.Pop() : new List<Metric>();
+                metrics = metricListPool.Count > 0 ? metricListPool.Pop() : [];
                 scopeMetricsList[metricName] = metrics;
             }
 
@@ -117,7 +117,7 @@ private static int WriteScopeMetric(byte[] buffer, int writePosition, string met
         int instrumentationScopeLengthPosition = writePosition;
         writePosition += ReserveSizeForLength;
 
-        Debug.Assert(metrics.Any(), "Metrics collection is not expected to be empty.");
+        Debug.Assert(metrics.Count > 0, "Metrics collection is not expected to be empty.");
         var meterVersion = metrics[0].MeterVersion;
         var meterTags = metrics[0].MeterTags;
 

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/Serializer/ProtobufSerializer.cs

@@ -325,7 +325,9 @@ internal static int WriteStringWithTag(byte[] buffer, int writePosition, int fie
         {
             // Note: Validate there is enough space in the buffer to hold the
             // string otherwise throw to trigger a resize of the buffer.
+#pragma warning disable CA2201 // Do not raise reserved exception types
             throw new IndexOutOfRangeException();
+#pragma warning restore CA2201 // Do not raise reserved exception types
         }
 
         unsafe

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/Transmission/OtlpExporterPersistentStorageTransmissionHandler.cs

@@ -19,7 +19,9 @@ internal sealed class OtlpExporterPersistentStorageTransmissionHandler : OtlpExp
     private bool disposed;
 
     public OtlpExporterPersistentStorageTransmissionHandler(IExportClient exportClient, double timeoutMilliseconds, string storagePath)
+#pragma warning disable CA2000 // Dispose objects before losing scope
         : this(new FileBlobProvider(storagePath), exportClient, timeoutMilliseconds)
+#pragma warning restore CA2000 // Dispose objects before losing scope
     {
     }
 
@@ -93,6 +95,8 @@ protected override void Dispose(bool disposing)
 
             this.disposed = true;
         }
+
+        base.Dispose(disposing);
     }
 
     private void RetryStoredRequests()

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj

@@ -17,6 +17,7 @@
     and https://github.com/dotnet/runtime/issues/92509 -->
     <NoWarn>$(NoWarn);SYSLIB1100;SYSLIB1101</NoWarn>
     <AllowUnsafeBlocks Condition="'$(TargetFramework)' == 'netstandard2.0' OR '$(TargetFramework)' == '$(NetFrameworkMinimumSupportedVersion)'">true</AllowUnsafeBlocks>
+    <AnalysisLevel>latest-all</AnalysisLevel>
   </PropertyGroup>
 
   <ItemGroup>

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpExportProtocol.cs

@@ -6,7 +6,9 @@ namespace OpenTelemetry.Exporter;
 /// <summary>
 /// Supported by OTLP exporter protocol types according to the specification https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
 /// </summary>
+#pragma warning disable CA1028 // Enum storage should be Int32
 public enum OtlpExportProtocol : byte
+#pragma warning restore CA1028 // Enum storage should be Int32
 {
     /// <summary>
     /// OTLP over gRPC (corresponds to 'grpc' Protocol configuration option). Used as default.

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpExporterOptionsExtensions.cs

@@ -40,7 +40,7 @@ public static THeaders GetHeaders<THeaders>(this OtlpExporterOptions options, Ac
                 if (commaIndex == -1)
                 {
                     pair = headersSpan;
-                    headersSpan = ReadOnlySpan<char>.Empty;
+                    headersSpan = [];
                 }
                 else
                 {
@@ -171,7 +171,11 @@ internal static Uri AppendPathIfNotPresent(this Uri uri, string path)
         var absoluteUri = uri.AbsoluteUri;
         var separator = string.Empty;
 
-        if (absoluteUri.EndsWith("/"))
+#if NET || NETSTANDARD2_1_OR_GREATER
+        if (absoluteUri.EndsWith('/'))
+#else
+        if (absoluteUri.EndsWith("/", StringComparison.Ordinal))
+#endif
         {
             // Endpoint already ends with 'path/'
             if (absoluteUri.EndsWith(string.Concat(path, "/"), StringComparison.OrdinalIgnoreCase))

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpLogExporter.cs

@@ -69,7 +69,9 @@ internal OtlpLogExporter(
     internal Resource Resource => this.resource ??= this.ParentProvider.GetResource();
 
     /// <inheritdoc/>
+#pragma warning disable CA1725 // Parameter names should match base declaration
     public override ExportResult Export(in Batch<LogRecord> logRecordBatch)
+#pragma warning restore CA1725 // Parameter names should match base declaration
     {
         // Prevents the exporter's gRPC and HTTP operations from being instrumented.
         using var scope = SuppressInstrumentationScope.Begin();

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpLogExporterHelperExtensions.cs

@@ -56,7 +56,9 @@ public static OpenTelemetryLoggerOptions AddOtlpExporter(
 
         var finalOptionsName = name ?? Options.DefaultName;
 
+#pragma warning disable CA1062 // Validate arguments of public methods
         return loggerOptions.AddProcessor(sp =>
+#pragma warning restore CA1062 // Validate arguments of public methods
         {
             var exporterOptions = GetOptions(sp, name, finalOptionsName, OtlpExporterOptions.CreateOtlpExporterOptions);
 
@@ -102,7 +104,9 @@ public static OpenTelemetryLoggerOptions AddOtlpExporter(
 
         var finalOptionsName = name ?? Options.DefaultName;
 
+#pragma warning disable CA1062 // Validate arguments of public methods
         return loggerOptions.AddProcessor(sp =>
+#pragma warning restore CA1062 // Validate arguments of public methods
         {
             var exporterOptions = GetOptions(sp, name, finalOptionsName, OtlpExporterOptions.CreateOtlpExporterOptions);
 
@@ -316,10 +320,12 @@ internal static BaseProcessor<LogRecord> BuildOtlpLogExporter(
          * "OtlpLogExporter");
          */
 
+#pragma warning disable CA2000 // Dispose objects before losing scope
         BaseExporter<LogRecord> otlpExporter = new OtlpLogExporter(
             exporterOptions!,
             sdkLimitOptions!,
             experimentalOptions!);
+#pragma warning restore CA2000 // Dispose objects before losing scope
 
         if (configureExporterInstance != null)
         {

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpMetricExporter.cs

@@ -62,7 +62,9 @@ internal OtlpMetricExporter(
     internal Resource Resource => this.resource ??= this.ParentProvider.GetResource();
 
     /// <inheritdoc />
+#pragma warning disable CA1725 // Parameter names should match base declaration
     public override ExportResult Export(in Batch<Metric> metrics)
+#pragma warning restore CA1725 // Parameter names should match base declaration
     {
         // Prevents the exporter's gRPC and HTTP operations from being instrumented.
         using var scope = SuppressInstrumentationScope.Begin();

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpMetricExporterExtensions.cs

@@ -186,7 +186,9 @@ internal static MetricReader BuildOtlpExporterMetricReader(
 
         exporterOptions!.TryEnableIHttpClientFactoryIntegration(serviceProvider!, "OtlpMetricExporter");
 
+#pragma warning disable CA2000 // Dispose objects before losing scope
         BaseExporter<Metric> metricExporter = new OtlpMetricExporter(exporterOptions!, experimentalOptions!);
+#pragma warning restore CA2000 // Dispose objects before losing scope
 
         if (configureExporterInstance != null)
         {

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpTraceExporter.cs

@@ -65,7 +65,9 @@ internal OtlpTraceExporter(
     internal Resource Resource => this.resource ??= this.ParentProvider.GetResource();
 
     /// <inheritdoc/>
+#pragma warning disable CA1725 // Parameter names should match base declaration
     public override ExportResult Export(in Batch<Activity> activityBatch)
+#pragma warning restore CA1725 // Parameter names should match base declaration
     {
         // Prevents the exporter's gRPC and HTTP operations from being instrumented.
         using var scope = SuppressInstrumentationScope.Begin();

src/OpenTelemetry.Exporter.OpenTelemetryProtocol/OtlpTraceExporterHelperExtensions.cs

@@ -147,7 +147,9 @@ internal static BaseProcessor<Activity> BuildOtlpExporterProcessor(
 
         exporterOptions!.TryEnableIHttpClientFactoryIntegration(serviceProvider!, "OtlpTraceExporter");
 
+#pragma warning disable CA2000 // Dispose objects before losing scope
         BaseExporter<Activity> otlpExporter = new OtlpTraceExporter(exporterOptions!, sdkLimitOptions!, experimentalOptions!);
+#pragma warning restore CA2000 // Dispose objects before losing scope
 
         if (configureExporterInstance != null)
         {