[sdk-metrics] Promote cardinality limit view API from experimental to stable (open-telemetry#5926)

xiang17 · rajkumar-rangaraj · web-flow · commit 8de335c48682 · 2024-10-28T09:51:10.000-07:00
Co-authored-by: Rajkumar Rangaraj &lt;rajrang@microsoft.com&gt;
diff --git a/OpenTelemetry.sln b/OpenTelemetry.sln
@@ -305,7 +305,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "experimental-apis", "experi
 	ProjectSection(SolutionItems) = preProject
 		docs\diagnostics\experimental-apis\OTEL1000.md = docs\diagnostics\experimental-apis\OTEL1000.md
 		docs\diagnostics\experimental-apis\OTEL1001.md = docs\diagnostics\experimental-apis\OTEL1001.md
-		docs\diagnostics\experimental-apis\OTEL1003.md = docs\diagnostics\experimental-apis\OTEL1003.md
 		docs\diagnostics\experimental-apis\OTEL1004.md = docs\diagnostics\experimental-apis\OTEL1004.md
 		docs\diagnostics\experimental-apis\README.md = docs\diagnostics\experimental-apis\README.md
 	EndProjectSection
diff --git a/build/Common.props b/build/Common.props
@@ -13,7 +13,7 @@
     <NuGetAuditMode>all</NuGetAuditMode>
     <NuGetAuditLevel>low</NuGetAuditLevel>
     <!-- Suppress warnings for repo code using experimental features -->
-    <NoWarn>$(NoWarn);OTEL1000;OTEL1001;OTEL1002;OTEL1003;OTEL1004</NoWarn>
+    <NoWarn>$(NoWarn);OTEL1000;OTEL1001;OTEL1002;OTEL1004</NoWarn>
     <!--temporarily disable. See 3958-->
     <!--<AnalysisLevel>latest-All</AnalysisLevel>-->
   </PropertyGroup>
diff --git a/docs/diagnostics/experimental-apis/OTEL1003.md b/docs/diagnostics/experimental-apis/OTEL1003.md
diff --git a/docs/diagnostics/experimental-apis/README.md b/docs/diagnostics/experimental-apis/README.md
@@ -27,12 +27,6 @@ Description: Logs Bridge API
 
 Details: [OTEL1001](./OTEL1001.md)
 
-### OTEL1003
-
-Description: MetricStreamConfiguration CardinalityLimit Support
-
-Details: [OTEL1003](./OTEL1003.md)
-
 ### OTEL1004
 
 Description: ExemplarReservoir Support
@@ -58,3 +52,11 @@ Description: Metrics Exemplar Support
 Details: [OTEL1002](https://github.com/open-telemetry/opentelemetry-dotnet/blob/b8ea807bae1a5d9b0f3d6d23b1e1e10f5e096a25/docs/diagnostics/experimental-apis/OTEL1002.md)
 
 Released stable: `1.9.0`
+
+### OTEL1003
+
+Description: MetricStreamConfiguration CardinalityLimit Support
+
+Details: [OTEL1003](https://github.com/open-telemetry/opentelemetry-dotnet/blob/9f41eadf03f3dcc5e76c686b61fb39849f046312/docs/diagnostics/experimental-apis/OTEL1003.md)
+
+Released stable: `1.10.0`
diff --git a/docs/metrics/customizing-the-sdk/README.md b/docs/metrics/customizing-the-sdk/README.md
@@ -403,9 +403,8 @@ metrics managed by a given `MeterProvider`, use the
 
 > [!CAUTION]
 > `MeterProviderBuilder.SetMaxMetricPointsPerMetricStream` is marked `Obsolete`
-  in pre-release builds and has been replaced by
-  `MetricStreamConfiguration.CardinalityLimit`. For details see:
-  [OTEL1003](../../diagnostics/experimental-apis/OTEL1003.md).
+  in stable builds since 1.10.0 and has been replaced by
+  `MetricStreamConfiguration.CardinalityLimit`.
 
 ```csharp
 using var meterProvider = Sdk.CreateMeterProviderBuilder()
@@ -421,11 +420,6 @@ To set the [cardinality limit](../README.md#cardinality-limits) for an
 individual metric, use the `MetricStreamConfiguration.CardinalityLimit` property
 on the View API:
 
-> [!NOTE]
-> `MetricStreamConfiguration.CardinalityLimit` is an experimental API only
-  available in pre-release builds. For details see:
-  [OTEL1003](../../diagnostics/experimental-apis/OTEL1003.md).
-
 ```csharp
 var meterProvider = Sdk.CreateMeterProviderBuilder()
     .AddMeter("MyCompany.MyProduct.MyLibrary")
diff --git a/src/OpenTelemetry/.publicApi/Experimental/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/Experimental/PublicAPI.Unshipped.txt
@@ -17,8 +17,6 @@ OpenTelemetry.Metrics.FixedSizeExemplarReservoir.Capacity.get -> int
 OpenTelemetry.Metrics.FixedSizeExemplarReservoir.FixedSizeExemplarReservoir(int capacity) -> void
 OpenTelemetry.Metrics.FixedSizeExemplarReservoir.UpdateExemplar(int exemplarIndex, in OpenTelemetry.Metrics.ExemplarMeasurement<double> measurement) -> void
 OpenTelemetry.Metrics.FixedSizeExemplarReservoir.UpdateExemplar(int exemplarIndex, in OpenTelemetry.Metrics.ExemplarMeasurement<long> measurement) -> void
-OpenTelemetry.Metrics.MetricStreamConfiguration.CardinalityLimit.get -> int?
-OpenTelemetry.Metrics.MetricStreamConfiguration.CardinalityLimit.set -> void
 OpenTelemetry.Metrics.MetricStreamConfiguration.ExemplarReservoirFactory.get -> System.Func<OpenTelemetry.Metrics.ExemplarReservoir?>?
 OpenTelemetry.Metrics.MetricStreamConfiguration.ExemplarReservoirFactory.set -> void
 override sealed OpenTelemetry.Metrics.FixedSizeExemplarReservoir.Collect() -> OpenTelemetry.Metrics.ReadOnlyExemplarCollection
diff --git a/src/OpenTelemetry/.publicApi/Stable/PublicAPI.Unshipped.txt b/src/OpenTelemetry/.publicApi/Stable/PublicAPI.Unshipped.txt
@@ -1,3 +1,5 @@
+OpenTelemetry.Metrics.MetricStreamConfiguration.CardinalityLimit.get -> int?
+OpenTelemetry.Metrics.MetricStreamConfiguration.CardinalityLimit.set -> void
 OpenTelemetry.OpenTelemetrySdk
 OpenTelemetry.OpenTelemetrySdk.Dispose() -> void
 OpenTelemetry.OpenTelemetrySdk.LoggerProvider.get -> OpenTelemetry.Logs.LoggerProvider!
diff --git a/src/OpenTelemetry/CHANGELOG.md b/src/OpenTelemetry/CHANGELOG.md
@@ -6,6 +6,11 @@ Notes](../../RELEASENOTES.md).
 
 ## Unreleased
 
+* The experimental APIs previously covered by `OTEL1003`
+  (`MetricStreamConfiguration.CardinalityLimit`) will now be part of the public
+  API and supported in stable builds.
+  ([#5926](https://github.com/open-telemetry/opentelemetry-dotnet/pull/5926))
+
 * Promoted overflow attribute from experimental to stable and removed the
   `OTEL_DOTNET_EXPERIMENTAL_METRICS_EMIT_OVERFLOW_ATTRIBUTE` environment variable.
 
diff --git a/src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderExtensions.cs b/src/OpenTelemetry/Metrics/Builder/MeterProviderBuilderExtensions.cs
@@ -238,9 +238,7 @@ public static MeterProviderBuilder SetMaxMetricStreams(this MeterProviderBuilder
     /// <param name="meterProviderBuilder"><see cref="MeterProviderBuilder"/>.</param>
     /// <param name="maxMetricPointsPerMetricStream">Maximum number of metric points allowed per metric stream.</param>
     /// <returns>The supplied <see cref="MeterProviderBuilder"/> for chaining.</returns>
-#if EXPOSE_EXPERIMENTAL_FEATURES
-    [Obsolete("Use MetricStreamConfiguration.CardinalityLimit via the AddView API instead. This method will be removed in a future version.")]
-#endif
+    [Obsolete("Use MetricStreamConfiguration.CardinalityLimit via the AddView API instead. This method is marked as obsolete in version 1.10.0 and will be removed in a future version.")]
     public static MeterProviderBuilder SetMaxMetricPointsPerMetricStream(this MeterProviderBuilder meterProviderBuilder, int maxMetricPointsPerMetricStream)
     {
         Guard.ThrowIfOutOfRange(maxMetricPointsPerMetricStream, min: 1);
diff --git a/src/OpenTelemetry/Metrics/View/MetricStreamConfiguration.cs b/src/OpenTelemetry/Metrics/View/MetricStreamConfiguration.cs
@@ -98,14 +98,11 @@ public string[]? TagKeys
         }
     }
 
-#if EXPOSE_EXPERIMENTAL_FEATURES
     /// <summary>
     /// Gets or sets a positive integer value defining the maximum number of
     /// data points allowed for the metric managed by the view.
     /// </summary>
     /// <remarks>
-    /// <para><b>WARNING</b>: This is an experimental API which might change or
-    /// be removed in the future. Use at your own risk.</para>
     /// <para>Spec reference: <see
     /// href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#cardinality-limits">Cardinality
     /// limits</see>.</para>
@@ -116,14 +113,7 @@ public string[]? TagKeys
     /// If not set the default
     /// MeterProvider cardinality limit of 2000 will apply.
     /// </remarks>
-#if NET
-    [Experimental(DiagnosticDefinitions.CardinalityLimitExperimentalApi, UrlFormat = DiagnosticDefinitions.ExperimentalApiUrlFormat)]
-#endif
-    public
-#else
-    internal
-#endif
-    int? CardinalityLimit
+    public int? CardinalityLimit
     {
         get => this.cardinalityLimit;
         set
diff --git a/src/Shared/DiagnosticDefinitions.cs b/src/Shared/DiagnosticDefinitions.cs
@@ -9,10 +9,10 @@ internal static class DiagnosticDefinitions
 
     public const string LoggerProviderExperimentalApi = "OTEL1000";
     public const string LogsBridgeExperimentalApi = "OTEL1001";
-    public const string CardinalityLimitExperimentalApi = "OTEL1003";
     public const string ExemplarReservoirExperimentalApi = "OTEL1004";
 
     /* Definitions which have been released stable:
     public const string ExemplarExperimentalApi = "OTEL1002";
+    public const string CardinalityLimitExperimentalApi = "OTEL1003";
      */
 }
diff --git a/test/OpenTelemetry.Tests/Metrics/MetricViewTests.cs b/test/OpenTelemetry.Tests/Metrics/MetricViewTests.cs
@@ -1093,7 +1093,7 @@ public void ViewConflict_OneInstrument_DifferentDescription()
     [Theory]
     [InlineData(true)]
     [InlineData(false)]
-    public void CardinalityLimitofMatchingViewTakesPrecedenceOverMeterProvider(bool setDefault)
+    public void CardinalityLimitOfMatchingViewTakesPrecedenceOverMeterProvider(bool setDefault)
     {
         using var meter = new Meter(Utils.GetCurrentMethodName());
         var exportedItems = new List<Metric>();

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+OpenTelemetry.Metrics.MetricStreamConfiguration.CardinalityLimit.get -> int?`
	`2`	`+OpenTelemetry.Metrics.MetricStreamConfiguration.CardinalityLimit.set -> void`
`1`	`3`	`OpenTelemetry.OpenTelemetrySdk`
`2`	`4`	`OpenTelemetry.OpenTelemetrySdk.Dispose() -> void`
`3`	`5`	`OpenTelemetry.OpenTelemetrySdk.LoggerProvider.get -> OpenTelemetry.Logs.LoggerProvider!`