opentelemetry-metrics-sdk 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab6bcf236973bf3076b7ed474af0b5f6d1800109b50ea962ee30e5c26e8e2939
-  data.tar.gz: 98b5732131f76d66d2a8aa9dec222540d46bcde1c505611838dac389c84633f2
+  metadata.gz: f80c6d95eeb420fc59002214a2486d588027050dd75c3e675946b52e13db1623
+  data.tar.gz: 401efba2cf641811e0bd21db5f9d1ba73ec41d876a859d98009c1a4a148a38b0
 SHA512:
-  metadata.gz: 2e67ddd388122be3e244bfb72089fc22df9c00e7f0ccbe1d7407cfa666c91e5eee65056b5430cc35ae034bf8d55073c6b24848736afcd38d06b7a4e07e757154
-  data.tar.gz: 967900597a808f03bfc221773a5c5095fa4f8ea0f94b1cae2b4c30ed16e2e30c4e49d8bda30774a63b924cf836f50d1d3a68bdc589b9455de3588a57846859ea
+  metadata.gz: b3f55fad01c447ce033120386ccb5c0841585aba1e787c7865477a398d1502f098bfdb566918eb29e38e8bae83eb9c2903657d32a7e834331a7cbae3a0ccf055
+  data.tar.gz: 265d205ecbfac906c2cdd3d0c29e86b3e2c1b53568c544da0283d1dd71fee40e88d0084d41b28a0aab60f33c79a00db8b2cccfa12df127d822b4547032e6e21c

data/CHANGELOG.md

@@ -1,26 +1,35 @@
 # Release History: opentelemetry-metrics-sdk
 
+### v0.6.1 / 2025-04-09
+
+* FIXED: Use condition signal to replace sleep and remove timeout.timeout…
+
+### v0.6.0 / 2025-02-25
+
+- ADDED: Support 3.1 Min Version
+- FIXED: Add is_monotonic flag to sum
+
 ### v0.5.0 / 2025-01-08
 
-* ADDED: Add synchronous gauge
+- ADDED: Add synchronous gauge
 
 ### v0.4.1 / 2024-12-04
 
-* FIXED: Handle float value in NumberDataPoint
+- FIXED: Handle float value in NumberDataPoint
 
 ### v0.4.0 / 2024-11-20
 
-* ADDED: Update metrics configuration patch
+- ADDED: Update metrics configuration patch
 
 ### v0.3.0 / 2024-10-22
 
-* ADDED: Add basic metrics view
-* FIXED: Coerce aggregation_temporality to symbol
-* FIXED: Add warning if invalid meter name given
+- ADDED: Add basic metrics view
+- FIXED: Coerce aggregation_temporality to symbol
+- FIXED: Add warning if invalid meter name given
 
 ### v0.2.0 / 2024-08-27
 
-* ADDED: Add basic periodic exporting metric_reader
+- ADDED: Add basic periodic exporting metric_reader
 
 ### v0.1.0 / 2024-07-31
 

data/README.md

@@ -25,6 +25,7 @@ At this time, you should be able to:
   * observable up down counters
 * Export using a pull exporter
 * Use delta aggregation temporality
+* Periodic Exporting Metric Reader
 
 We do not yet have support for:
 
@@ -32,7 +33,6 @@ We do not yet have support for:
 * Cumulative aggregation temporality
 * Metrics Views
 * Metrics Exemplars
-* Periodic Exporting Metric Reader
 * Push metric exporting
 
 These lists are incomplete and are intended to give a broad description of what's available.

data/lib/opentelemetry/sdk/metrics/aggregation/sum.rb

@@ -13,9 +13,10 @@ module OpenTelemetry
         class Sum
           attr_reader :aggregation_temporality
 
-          def initialize(aggregation_temporality: ENV.fetch('OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE', :delta))
+          def initialize(aggregation_temporality: ENV.fetch('OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE', :delta), monotonic: false)
             # TODO: the default should be :cumulative, see issue #1555
             @aggregation_temporality = aggregation_temporality.to_sym
+            @monotonic = monotonic
           end
 
           def collect(start_time, end_time, data_points)
@@ -38,7 +39,13 @@ module OpenTelemetry
             end
           end
 
+          def monotonic?
+            @monotonic
+          end
+
           def update(increment, attributes, data_points)
+            return if @monotonic && increment < 0
+
             ndp = data_points[attributes] || data_points[attributes] = NumberDataPoint.new(
               attributes,
               nil,

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

@@ -33,14 +33,22 @@ module OpenTelemetry
             @thread   = nil
             @continue = false
             @mutex = Mutex.new
+            @condition = ConditionVariable.new
             @export_mutex = Mutex.new
 
             start
           end
 
+          # Shuts the @thread down and set @continue to false; it will block
+          # until the shutdown thread is finished.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred.
           def shutdown(timeout: nil)
             thread = lock do
               @continue = false # force termination in next iteration
+              @condition.signal
               @thread
             end
             thread&.join(@export_interval)
@@ -52,15 +60,35 @@ module OpenTelemetry
             Export::FAILURE
           end
 
+          # Export all metrics to the configured `Exporter` that have not yet
+          # been exported.
+          #
+          # This method should only be called in cases where it is absolutely
+          # necessary, such as when using some FaaS providers that may suspend
+          # the process after an invocation, but before the `PeriodicMetricReader` exports
+          # the completed metrics.
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred.
           def force_flush(timeout: nil)
-            export(timeout: timeout)
+            export(timeout:)
             Export::SUCCESS
           rescue StandardError
             Export::FAILURE
           end
 
+          # Check both @thread and @continue object to determine if current
+          # PeriodicMetricReader is still alive. If one of them is true/alive,
+          # then PeriodicMetricReader is determined as alive
+          def alive?
+            @continue || @thread.alive?
+          end
+
           private
 
+          # Start a thread that continously export metrics within fixed duration.
+          # The wait mechanism is using to check @mutex lock with conditional variable
           def start
             @continue = true
             if @exporter.nil?
@@ -70,19 +98,21 @@ module OpenTelemetry
             else
               @thread = Thread.new do
                 while @continue
-                  sleep(@export_interval)
-                  begin
-                    Timeout.timeout(@export_timeout) do
-                      export(timeout: @export_timeout)
-                    end
-                  rescue Timeout::Error => e
-                    OpenTelemetry.handle_error(exception: e, message: 'PeriodicMetricReader timeout.')
+                  lock do
+                    @condition.wait(@mutex, @export_interval)
+                    export(timeout: @export_timeout)
                   end
                 end
               end
             end
           end
 
+          # Helper function for the defined exporter to export metrics.
+          # It only exports if the collected metrics are not an empty array (collect returns an Array).
+          #
+          # @param [optional Numeric] timeout An optional timeout in seconds.
+          # @return [Integer] SUCCESS if no error occurred, FAILURE if a
+          #   non-specific failure occurred
           def export(timeout: nil)
             @export_mutex.synchronize do
               collected_metrics = collect

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

@@ -42,7 +42,7 @@ module OpenTelemetry
           private
 
           def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new
+            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new(monotonic: true)
           end
         end
       end

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

@@ -35,7 +35,7 @@ module OpenTelemetry
           private
 
           def default_aggregation
-            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new
+            OpenTelemetry::SDK::Metrics::Aggregation::Sum.new(monotonic: false)
           end
         end
       end

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

@@ -18,7 +18,8 @@ module OpenTelemetry
                                 :data_points,               # Hash{Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>} => Numeric}
                                 :aggregation_temporality,   # Symbol
                                 :start_time_unix_nano,      # Integer nanoseconds since Epoch
-                                :time_unix_nano)            # Integer nanoseconds since Epoch
+                                :time_unix_nano,            # Integer nanoseconds since Epoch
+                                :is_monotonic)              # Boolean
       end
     end
   end

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

@@ -67,6 +67,8 @@ module OpenTelemetry
 
           def aggregate_metric_data(start_time, end_time, aggregation: nil)
             aggregator = aggregation || @default_aggregation
+            is_monotonic = aggregator.respond_to?(:monotonic?) ? aggregator.monotonic? : nil
+
             MetricData.new(
               @name,
               @description,
@@ -77,7 +79,8 @@ module OpenTelemetry
               aggregator.collect(start_time, end_time, @data_points),
               aggregator.aggregation_temporality,
               start_time,
-              end_time
+              end_time,
+              is_monotonic
             )
           end
 

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-metrics-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-09 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -240,10 +240,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-sdk/v0.5.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-sdk/v0.6.1/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/metrics_sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-sdk/v0.5.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-sdk/v0.6.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -252,14 +252,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: A stats collection and distributed tracing framework