Comment out temporarily deprecated classes and methods, and mark them as phase 2

Author: Nacho Bonafonte

Examples/Stable Metric Sample/README.md

@@ -0,0 +1,12 @@
+###  Stable metrics
+
+ Stable metrics is the working name for the otel-swift implementation of the current OpenTelemetry metrics specification.
+ The existing otel-swift metric implementation is old and out-of-spec. While Stable Metrics is in an experimental phase it will maintaion
+ the "stable" prefix, and can be expected to be present on overlapping constructs in the implementation.
+ Expected time line will be as follows:
+  Phase 1:
+    Provide access to Stable Metrics along side existing Metrics. Once Stable Metrics are considered stable we will move onto phase 2.
+  Phase 2:
+    Mark all existing Metric APIs as deprecated. This will maintained for a period TBD
+  Phase 3:
+    Remove deprecated metrics api and remove Stable prefix from Stable metrics.

Sources/OpenTelemetryApi/Metrics/Instruments/Sum/CounterMetric.swift

@@ -6,7 +6,8 @@
 import Foundation
 
 /// Counter instrument.
-@available(*,deprecated)
+// Phase 2
+//@available(*,deprecated)
 public protocol CounterMetric {
     associatedtype T
 

Sources/OpenTelemetryApi/Metrics/LabelSet.swift

@@ -6,7 +6,8 @@
 import Foundation
 
 /// Normalized name value pairs of metric labels.
-@available(*, deprecated, message: "LabelSet removed from Metric API in OTEP-90")
+// Phase 2
+//@available(*, deprecated, message: "LabelSet removed from Metric API in OTEP-90")
 open class LabelSet: Hashable {
     public private(set) var labels: [String: String]
 

Sources/OpenTelemetryApi/Metrics/Meter.swift

@@ -8,39 +8,44 @@ import Foundation
 /// Main interface to obtain metric instruments.
 ///
 ///
-@available(*, deprecated, renamed: "StableMeter")
+// Phase 2
+//@available(*, deprecated, renamed: "StableMeter")
 public protocol Meter {
 
     /// Creates Int counter with given name.
     /// - Parameters:
     ///   - name: The name of the counter.
     ///   - monotonic: indicates if only positive values are expected.
     /// - Returns:The counter instance.
-    @available(*,deprecated, message: "counter instruments are now monotonic only. Use UpDownCounter for non-monotonic.")
+    // Phase 2
+//@available(*,deprecated, message: "counter instruments are now monotonic only. Use UpDownCounter for non-monotonic.")
     func createIntCounter(name: String, monotonic: Bool) -> AnyCounterMetric<Int>
 
     /// Creates double counter with given name.
     /// - Parameters:
     ///   - name: indicates if only positive values are expected.
     ///   - monotonic: The name of the counter.
     /// - Returns:The counter instance.
-    @available(*,deprecated, message: "counter instruments are now monotonic only. Use UpDownCounter for non-monotonic.")
+    // Phase 2
+//@available(*,deprecated, message: "counter instruments are now monotonic only. Use UpDownCounter for non-monotonic.")
     func createDoubleCounter(name: String, monotonic: Bool) -> AnyCounterMetric<Double>
 
     /// Creates Int Measure with given name.
     /// - Parameters:
     ///   - name: The name of the measure.
     ///   - absolute: indicates if only positive values are expected.
     /// - Returns:The measure instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createIntMeasure(name: String, absolute: Bool) -> AnyMeasureMetric<Int>
 
     /// Creates double Measure with given name.
     /// - Parameters:
     ///   - name: The name of the measure.
     ///   - absolute: indicates if only positive values are expected.
     /// - Returns:The measure instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createDoubleMeasure(name: String, absolute: Bool) -> AnyMeasureMetric<Double>
 
     /// Creates Int Histogram with given name and boundaries.
@@ -49,7 +54,8 @@ public protocol Meter {
     ///   - explicitBoundaries: The boundary for sorting values into buckets
     ///   - absolute: indicates if only positive values are expected.
     /// - Returns:The histogram instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createIntHistogram(name: String, explicitBoundaries: Array<Int>?, absolute: Bool) -> AnyHistogramMetric<Int>
 
     /// Creates Double Histogram with given name and boundaries.
@@ -58,7 +64,8 @@ public protocol Meter {
     ///   - explicitBoundaries: The boundary for sorting values into buckets
     ///   - absolute: indicates if only positive values are expected.
     /// - Returns:The histogram instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createDoubleHistogram(name: String, explicitBoundaries: Array<Double>?, absolute: Bool) -> AnyHistogramMetric<Double>
 
         // Creates a double histogram given the name, boundaries, counts, and start and end dates.
@@ -82,7 +89,8 @@ public protocol Meter {
     ///   - callback: The callback to be called to observe metric value.
     ///   - absolute: indicates if only positive values are expected.
     /// - Returns:The observer instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createIntObserver(name: String, absolute: Bool, callback: @escaping (IntObserverMetric) -> Void) -> IntObserverMetric
 
     /// Creates Double Observer with given name.
@@ -91,60 +99,70 @@ public protocol Meter {
     ///   - callback: The callback to be called to observe metric value.
     ///   - absolute: indicates if only positive values are expected.
     /// - Returns:The observer instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createDoubleObserver(name: String, absolute: Bool, callback: @escaping (DoubleObserverMetric) -> Void) -> DoubleObserverMetric
 
     /// Creates Double Observable Gauge with given name.
     /// - Parameters:
     ///   - name: The name of the gauge.
     ///   - callback: The callback to be called to observe metric value.
     /// - Returns:The gauge instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createIntObservableGauge(name: String, callback: @escaping (IntObserverMetric) -> Void) -> IntObserverMetric
 
     /// Creates Int Observable Gauge with given name.
     /// - Parameters:
     ///   - name: The name of the gauge.
     ///   - callback: The callback to be called to observe metric value.
     ///   - Returns:The gauge instance.
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createDoubleObservableGauge(name: String, callback: @escaping (DoubleObserverMetric) -> Void) -> DoubleObserverMetric
 
     /// Constructs or retrieves the LabelSet from the given dictionary.
     /// - Parameters:
     ///   - labels: dictionary with  key-value pairs.
     /// - Returns:The LabelSet with given label key value pairs.
-    @available(*,deprecated, message: "removed from metrics spec in OTEP-90")
+    // Phase 2
+//@available(*,deprecated, message: "removed from metrics spec in OTEP-90")
     func getLabelSet(labels: [String: String]) -> LabelSet
 }
 
 public extension Meter {
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createIntCounter(name: String) -> AnyCounterMetric<Int> {
         return createIntCounter(name: name, monotonic: true)
     }
 
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createDoubleCounter(name: String) -> AnyCounterMetric<Double> {
         return createDoubleCounter(name: name, monotonic: true)
     }
 
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createIntMeasure(name: String) -> AnyMeasureMetric<Int> {
         return createIntMeasure(name: name, absolute: true)
     }
 
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createDoubleMeasure(name: String) -> AnyMeasureMetric<Double> {
         return createDoubleMeasure(name: name, absolute: true)
     }
 
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createIntObserver(name: String, callback: @escaping (IntObserverMetric) -> Void) -> IntObserverMetric {
         return createIntObserver(name: name, absolute: true, callback: callback)
     }
 
-    @available(*,deprecated)
+    // Phase 2
+//@available(*,deprecated)
     func createDoubleObserver(name: String, callback: @escaping (DoubleObserverMetric) -> Void) -> DoubleObserverMetric {
         return createDoubleObserver(name: name, absolute: true, callback: callback)
     }

Sources/OpenTelemetryApi/Metrics/MeterProvider.swift

@@ -7,13 +7,15 @@ import Foundation
 
 /// Creates Meters for an instrumentation library.
 /// Libraries should use this class as follows to obtain Meter instance.
-@available(*, deprecated, renamed: "StableMeterProvider")
+// Phase 2
+//@available(*, deprecated, renamed: "StableMeterProvider")
 public protocol MeterProvider: AnyObject {
     /// Returns a Meter for a given name and version.
     /// - Parameters:
     ///   - instrumentationName: Name of the instrumentation library.
     ///   - instrumentationVersion: Version of the instrumentation library (optional).
     /// - Returns: Meter for the given name and version information.
-    @available(*, deprecated, renamed: "StableMeterProvider.get(name:version:schema_url:)")
+    // Phase 2
+    //@available(*, deprecated, renamed: "StableMeterProvider.get(name:version:schema_url:)")
     func get(instrumentationName: String, instrumentationVersion: String?) -> Meter
 }

Sources/OpenTelemetrySdk/Metrics/Export/MetricProcessor.swift

@@ -4,7 +4,8 @@
  */
 
 import Foundation
-@available(*, deprecated, renamed: "StableMetricReader")
+// Phase 2
+//@available(*, deprecated, renamed: "StableMetricReader")
 public protocol MetricProcessor {
     /// Finish the current collection cycle and return the metrics it holds.
     /// This is called at the end of one collection cycle by the Controller.

Sources/OpenTelemetrySdk/Metrics/MeterProviderSdk.swift

@@ -6,7 +6,8 @@
 import Foundation
 import OpenTelemetryApi
 
-@available(*, deprecated, renamed: "StableMeterProviderSdk")
+// Phase 2
+//@available(*, deprecated, renamed: "StableMeterProviderSdk")
 public class MeterProviderSdk: MeterProvider {
     private let lock = Lock()
     public static let defaultPushInterval: TimeInterval = 60

Sources/OpenTelemetrySdk/Metrics/Stable/State/AsynchronousMetricStorage.swift

@@ -39,7 +39,7 @@ public class AsynchronousMetricStorage: MetricStorage {
     func record(measurement: Measurement) {
         let processedAttributes = attributeProcessor.process(incoming: measurement.attributes)
         let start = aggregationTemporality == AggregationTemporality.delta ? registeredReader.lastCollectedEpochNanos : measurement.startEpochNano
-        var newMeasurement = measurement.hasDoubleValue ? Measurement.doubleMeasurement(startEpochNano: start, endEpochNano: measurement.epochNano, value: measurement.doubleValue, attributes: measurement.attributes) : Measurement.longMeasurement(startEpochNano: start, endEpochNano: measurement.epochNano, value: measurement.longValue, attributes: measurement.attributes)
+        let newMeasurement = measurement.hasDoubleValue ? Measurement.doubleMeasurement(startEpochNano: start, endEpochNano: measurement.epochNano, value: measurement.doubleValue, attributes: processedAttributes) : Measurement.longMeasurement(startEpochNano: start, endEpochNano: measurement.epochNano, value: measurement.longValue, attributes: processedAttributes)
         do {
             try recordPoint(point: aggregator.toPoint(measurement: newMeasurement))
         } catch let HistogramAggregatorError.unsupportedOperation(error) {