opentelemetry-metrics-sdk 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaa97b8e63eb4737a973f36e8861a9884e7eccba6b3df0355b9074769a5d89c3
-  data.tar.gz: 70fb46dfb922370d54a647e37b80608f6f2d237979cd9a7fe4d0c40cf7132aea
+  metadata.gz: 6eb7640bb97e64464de8e6496fe67028f989313651d9112544f9caa17bd1e3d2
+  data.tar.gz: 07ec1f7b6a9af36e6972a6f6a8a8b6561f791318e34b3164dc44e8e4f38206a4
 SHA512:
-  metadata.gz: 673c6ce995204f0cba090c12cd7e841d75dd4766ffb44dee8d9690b938774c4889fd0c562f798281bc961085354d0146f983da55419499f683773c3f9a33071e
-  data.tar.gz: 510c0413cd0c921193a068a9184c2ddb8f3c1618512fe6c7c88b010486a7fadc2c74ce37b1020fa63b94bc399c26428bbadfb0e7cf5050916937179d04e30c98
+  metadata.gz: 110b7d06b87b6b6d83267241dd77c835bcdbbe136e97ef7aaa08c43048fa538fea034475ef8cdad5dc99394dc6f086f397338a13592bb23afa58f7fdcafeb417
+  data.tar.gz: 8ca110b0164d1cf116e22013a1ebab15c5ad786e7947cdbcca372c9d3a9cb485ae8a4bd98c0d323e377ce2653d06c38cd07d416ce2936939b50d83450e92fc55

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-metrics-sdk
 
+### v0.22.0 / 2026-10-20
+
+* ADDED: Support OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION env var (#2389)
+
 ### v0.21.0 / 2026-10-13
 
 * ADDED: Fix duplicate instrument registration warning (#2417)

data/lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb

@@ -12,7 +12,7 @@ module OpenTelemetry
         #
         # Potentially useful for exploratory purposes.
         class ConsoleMetricPullExporter < MetricReader
-          def initialize(aggregation_cardinality_limit: nil)
+          def initialize(aggregation_cardinality_limit: nil, default_aggregation: nil)
             super
             @stopped = false
           end

data/lib/opentelemetry/sdk/metrics/export/in_memory_metric_pull_exporter.rb

@@ -13,7 +13,7 @@ module OpenTelemetry
         class InMemoryMetricPullExporter < MetricReader
           attr_reader :metric_snapshots
 
-          def initialize(aggregation_cardinality_limit: nil)
+          def initialize(aggregation_cardinality_limit: nil, default_aggregation: nil)
             super
             @metric_snapshots = []
             @mutex = Mutex.new

data/lib/opentelemetry/sdk/metrics/export/metric_reader.rb

@@ -17,10 +17,32 @@ module OpenTelemetry
 
           private_constant :SINGLE_PROVIDER_ERROR
 
+          # The default aggregation for each instrument kind, as defined by the
+          # metrics SDK specification.
+          # https://opentelemetry.io/docs/specs/otel/metrics/sdk/#default-aggregation
+          DEFAULT_AGGREGATION = {
+            counter: OpenTelemetry::SDK::Metrics::Aggregation::Sum,
+            up_down_counter: OpenTelemetry::SDK::Metrics::Aggregation::Sum,
+            observable_counter: OpenTelemetry::SDK::Metrics::Aggregation::Sum,
+            observable_up_down_counter: OpenTelemetry::SDK::Metrics::Aggregation::Sum,
+            gauge: OpenTelemetry::SDK::Metrics::Aggregation::LastValue,
+            observable_gauge: OpenTelemetry::SDK::Metrics::Aggregation::LastValue,
+            histogram: OpenTelemetry::SDK::Metrics::Aggregation::ExplicitBucketHistogram
+          }.freeze
+
           attr_reader :metric_store
 
-          def initialize(aggregation_cardinality_limit: nil)
+          # @return [Hash{Symbol => Class}] the aggregation class to use for each
+          #   instrument kind, resolved once at construction.
+          attr_reader :default_aggregation
+
+          # @param [optional Integer] aggregation_cardinality_limit the maximum number of
+          #   data points to keep per metric stream.
+          # @param [optional Hash{Symbol => Class}] default_aggregation aggregation classes
+          #   keyed by instrument kind, applied on top of {DEFAULT_AGGREGATION}.
+          def initialize(aggregation_cardinality_limit: nil, default_aggregation: nil)
             @mutex = Mutex.new
+            @default_aggregation = DEFAULT_AGGREGATION.merge(default_aggregation || {})
             @metric_store = OpenTelemetry::SDK::Metrics::State::MetricStore.new(cardinality_limit: aggregation_cardinality_limit)
           end
 

data/lib/opentelemetry/sdk/metrics/export/periodic_metric_reader.rb

@@ -26,7 +26,9 @@ module OpenTelemetry
                          export_timeout_millis: Float(ENV.fetch('OTEL_METRIC_EXPORT_TIMEOUT', 30_000)),
                          exporter: nil,
                          aggregation_cardinality_limit: nil)
-            super(aggregation_cardinality_limit: aggregation_cardinality_limit)
+            # The exporter knows what the destination prefers, so this reader defers to it.
+            super(aggregation_cardinality_limit: aggregation_cardinality_limit,
+                  default_aggregation: (exporter.default_aggregation if exporter.respond_to?(:default_aggregation)))
 
             @export_interval = export_interval_millis / 1000.0
             @export_timeout = export_timeout_millis / 1000.0

data/lib/opentelemetry/sdk/metrics/instrument/asynchronous_instrument.rb

@@ -13,6 +13,8 @@ module OpenTelemetry
         class AsynchronousInstrument
           NOOP_EXEMPLAR_RESERVOIR = Exemplar::NoopExemplarReservoir.new
 
+          attr_reader :exemplar_reservoir
+
           def initialize(name, unit, description, callback, instrumentation_scope, meter_provider, exemplar_filter, exemplar_reservoir)
             @name = name
             @unit = unit
@@ -31,7 +33,7 @@ module OpenTelemetry
           end
 
           # @api private
-          def register_with_new_metric_store(metric_store, aggregation: default_aggregation)
+          def register_with_new_metric_store(metric_store, aggregation: nil, default_aggregation: nil)
             ms = OpenTelemetry::SDK::Metrics::State::AsynchronousMetricStream.new(
               @name,
               @description,
@@ -44,7 +46,8 @@ module OpenTelemetry
               @timeout,
               @attributes,
               @exemplar_filter,
-              @exemplar_reservoir
+              @exemplar_reservoir,
+              default_aggregation: default_aggregation
             )
             @metric_streams << ms
             metric_store.add_metric_stream(ms)

data/lib/opentelemetry/sdk/metrics/instrument/counter.rb

@@ -38,12 +38,6 @@ module OpenTelemetry
             OpenTelemetry.handle_error(exception: e)
             nil
           end
-
-          private
-
-          def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new(exemplar_reservoir: @exemplar_reservoir, monotonic: true)
-          end
         end
       end
     end

data/lib/opentelemetry/sdk/metrics/instrument/gauge.rb

@@ -34,12 +34,6 @@ module OpenTelemetry
             OpenTelemetry.handle_error(exception: e)
             nil
           end
-
-          private
-
-          def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::LastValue.new(exemplar_reservoir: @exemplar_reservoir)
-          end
         end
       end
     end

data/lib/opentelemetry/sdk/metrics/instrument/histogram.rb

@@ -31,14 +31,6 @@ module OpenTelemetry
             OpenTelemetry.handle_error(exception: e)
             nil
           end
-
-          private
-
-          def default_aggregation
-            # TODO: at this point, histogram always take the default DEFAULT_BOUNDARIES. In future, the histogram should be able to
-            # define the custom boundaries so for exemplar_reservoir can also takes the bounaries as parameter
-            OpenTelemetry::SDK::Metrics::Aggregation::ExplicitBucketHistogram.new(exemplar_reservoir: @exemplar_reservoir)
-          end
         end
       end
     end

data/lib/opentelemetry/sdk/metrics/instrument/observable_counter.rb

@@ -28,12 +28,6 @@ module OpenTelemetry
           def observe(timeout: nil, attributes: {})
             update(timeout, attributes)
           end
-
-          private
-
-          def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new(exemplar_reservoir: @exemplar_reservoir, monotonic: true, instrument_kind: instrument_kind)
-          end
         end
       end
     end

data/lib/opentelemetry/sdk/metrics/instrument/observable_gauge.rb

@@ -28,12 +28,6 @@ module OpenTelemetry
           def observe(timeout: nil, attributes: {})
             update(timeout, attributes)
           end
-
-          private
-
-          def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::LastValue.new(exemplar_reservoir: @exemplar_reservoir)
-          end
         end
       end
     end

data/lib/opentelemetry/sdk/metrics/instrument/observable_up_down_counter.rb

@@ -28,12 +28,6 @@ module OpenTelemetry
           def observe(timeout: nil, attributes: {})
             update(timeout, attributes)
           end
-
-          private
-
-          def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new(aggregation_temporality: :cumulative, exemplar_reservoir: @exemplar_reservoir, monotonic: false)
-          end
         end
       end
     end

data/lib/opentelemetry/sdk/metrics/instrument/synchronous_instrument.rb

@@ -11,6 +11,8 @@ module OpenTelemetry
         # {SynchronousInstrument} contains the common functionality shared across
         # the synchronous instruments SDK instruments.
         class SynchronousInstrument
+          attr_reader :exemplar_reservoir
+
           def initialize(name, unit, description, instrumentation_scope, meter_provider, exemplar_filter, exemplar_reservoir)
             @name = name
             @unit = unit
@@ -25,7 +27,7 @@ module OpenTelemetry
           end
 
           # @api private
-          def register_with_new_metric_store(metric_store, aggregation: default_aggregation)
+          def register_with_new_metric_store(metric_store, aggregation: nil, default_aggregation: nil)
             ms = OpenTelemetry::SDK::Metrics::State::MetricStream.new(
               @name,
               @description,
@@ -35,7 +37,8 @@ module OpenTelemetry
               @instrumentation_scope,
               aggregation,
               @exemplar_filter,
-              @exemplar_reservoir
+              @exemplar_reservoir,
+              default_aggregation: default_aggregation
             )
             @metric_streams << ms
             metric_store.add_metric_stream(ms)

data/lib/opentelemetry/sdk/metrics/instrument/up_down_counter.rb

@@ -31,12 +31,6 @@ module OpenTelemetry
             OpenTelemetry.handle_error(exception: e)
             nil
           end
-
-          private
-
-          def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new(aggregation_temporality: :cumulative, exemplar_reservoir: @exemplar_reservoir, monotonic: false)
-          end
         end
       end
     end

data/lib/opentelemetry/sdk/metrics/meter.rb

@@ -67,7 +67,8 @@ module OpenTelemetry
         # Iterates a snapshot so a concurrent registration cannot mutate the hash mid-iteration.
         def add_metric_reader(metric_reader)
           @instrument_descriptors.values.flatten.each do |descriptor|
-            descriptor.instrument.register_with_new_metric_store(metric_reader.metric_store)
+            descriptor.instrument.register_with_new_metric_store(metric_reader.metric_store,
+                                                                 default_aggregation: MeterProvider.reader_config(metric_reader))
           end
         end
 

data/lib/opentelemetry/sdk/metrics/meter_provider.rb

@@ -144,11 +144,19 @@ module OpenTelemetry
         end
         private :register_metric_reader
 
+        # @api private
+        #
+        # Returns the reader's preferred aggregation classes, or nil for a reader that
+        # does not provide any. Readers are duck typed, so the method may be absent.
+        def self.reader_config(metric_reader)
+          metric_reader.default_aggregation if metric_reader.respond_to?(:default_aggregation)
+        end
+
         # @api private
         def register_synchronous_instrument(instrument)
           @mutex.synchronize do
             @metric_readers.each do |mr|
-              instrument.register_with_new_metric_store(mr.metric_store)
+              instrument.register_with_new_metric_store(mr.metric_store, default_aggregation: MeterProvider.reader_config(mr))
             end
           end
         end

data/lib/opentelemetry/sdk/metrics/state/asynchronous_metric_stream.rb

@@ -27,10 +27,12 @@ module OpenTelemetry
             timeout,
             attributes,
             exemplar_filter,
-            exemplar_reservoir
+            exemplar_reservoir,
+            default_aggregation: nil
           )
             # Call parent constructor with common parameters
-            super(name, description, unit, instrument_kind, meter_provider, instrumentation_scope, aggregation, exemplar_filter, exemplar_reservoir)
+            super(name, description, unit, instrument_kind, meter_provider, instrumentation_scope, aggregation, exemplar_filter, exemplar_reservoir,
+                  default_aggregation: default_aggregation)
 
             # Initialize asynchronous-specific attributes
             @callback = callback

data/lib/opentelemetry/sdk/metrics/state/metric_stream.rb

@@ -29,7 +29,8 @@ module OpenTelemetry
             instrumentation_scope,
             aggregation,
             exemplar_filter,
-            exemplar_reservoir
+            exemplar_reservoir,
+            default_aggregation: nil
           )
             @name = name
             @description = description
@@ -37,7 +38,7 @@ module OpenTelemetry
             @instrument_kind = instrument_kind
             @meter_provider = meter_provider
             @instrumentation_scope = instrumentation_scope
-            @default_aggregation = aggregation
+            @default_aggregation = aggregation || build_aggregation(default_aggregation, exemplar_reservoir)
             @data_points = {}
             @registered_views = {}
             @exemplar_filter = exemplar_filter
@@ -47,6 +48,31 @@ module OpenTelemetry
             @mutex = Mutex.new
           end
 
+          # Builds this stream's aggregation from the metric reader's preferred
+          # aggregation classes, falling back to the spec defaults.
+          #
+          # @param [Hash{Symbol => Class}, nil] preferred aggregation classes by instrument kind
+          # @param [Object, nil] exemplar_reservoir the instrument's exemplar reservoir
+          # @return [Object] a new aggregation, owned by this stream
+          def build_aggregation(preferred, exemplar_reservoir)
+            defaults = OpenTelemetry::SDK::Metrics::Export::MetricReader::DEFAULT_AGGREGATION
+            aggregation_class = (preferred || defaults)[@instrument_kind] || defaults[@instrument_kind]
+
+            if aggregation_class.nil?
+              OpenTelemetry.logger.warn("Unknown instrument kind: #{@instrument_kind}, defaulting to Drop aggregation")
+              aggregation_class = OpenTelemetry::SDK::Metrics::Aggregation::Drop
+            end
+
+            kwargs = { exemplar_reservoir: exemplar_reservoir }
+            if aggregation_class <= OpenTelemetry::SDK::Metrics::Aggregation::Sum
+              kwargs[:monotonic] = %i[counter observable_counter].include?(@instrument_kind)
+              kwargs[:instrument_kind] = @instrument_kind
+              kwargs[:aggregation_temporality] = :cumulative if %i[up_down_counter observable_up_down_counter].include?(@instrument_kind)
+            end
+
+            aggregation_class.new(**kwargs)
+          end
+
           # Returns a snapshot of this stream's aggregated metric data.
           def collect(start_time, end_time)
             @mutex.synchronize do

data/lib/opentelemetry/sdk/metrics/version.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module SDK
     module Metrics
       # Current OpenTelemetry metrics sdk version
-      VERSION = '0.21.0'
+      VERSION = '0.22.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-metrics-sdk
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -122,10 +122,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-metrics-sdk/0.21.0/file/CHANGELOG.md
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-metrics-sdk/v0.21.0/metrics_sdk
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-metrics-sdk/0.22.0/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/opentelemetry-metrics-sdk/v0.22.0/metrics_sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-metrics-sdk/0.21.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-metrics-sdk/0.22.0
 rdoc_options: []
 require_paths:
 - lib