opentelemetry-metrics-sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68999276f28a3e390725b6aebabc70a8846818e93fa9d6520f09c7992376bbbf
-  data.tar.gz: 923878943342c36c768458f3f46fa34275faaf739a5257ca2d61a0bb46eccf5e
+  metadata.gz: ce5f31c7463140b3dee9d8209ded3c831964b3b6a0edff4837ec5308481d6fc3
+  data.tar.gz: 4c900df8d7e8eb7f8c783ad73c11136a0931d21f447c75daaa254a51653e8cb2
 SHA512:
-  metadata.gz: 4f8a1bf6946c7a1bc27955369fa540dfb1ca481b393a5e1bfd4eb9c1957b0ed404fa6c9007dbc4af0314bcbcf8eb2dfdb5ef76d838d24a87ef635016c78238ea
-  data.tar.gz: e487825f271ba21fe3f491cbd497635d22cd224c3ba370b6de93b22367deb2bce11867db0d60a7860152a3cf255152c922ba6c452c5f8c9a01d5563ee8733025
+  metadata.gz: 84702ecb88071fa4d30803cdc7e71656643eb73593a4783d98fef7d1350955d03c7a3b17e5a50a61e3cc10726eb25dd6e234170ea979347c42893fb0f18abd15
+  data.tar.gz: 6072767e9f13652e20e376971f8c327ef52b8ef2a8d0e149819574cc5caaae0addb4d313b583e894a3c71b06ddd2bf264c030bca58a41309a359895cc0b5f8eb

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-metrics-sdk
 
+### v0.2.0 / 2024-08-27
+
+* ADDED: Add basic periodic exporting metric_reader
+
 ### v0.1.0 / 2024-07-31
 
 Initial release.

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

@@ -23,7 +23,7 @@ module OpenTelemetry
             export(collect)
           end
 
-          def export(metrics)
+          def export(metrics, timeout: nil)
             @mutex.synchronize do
               @metric_snapshots << metrics
             end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module SDK
+    module Metrics
+      module Export
+        # PeriodicMetricReader provides a minimal example implementation.
+        class PeriodicMetricReader < MetricReader
+          # Returns a new instance of the {PeriodicMetricReader}.
+          #
+          # @param [Integer] export_interval_millis the maximum interval time.
+          #   Defaults to the value of the OTEL_METRIC_EXPORT_INTERVAL environment
+          #   variable, if set, or 60_000.
+          # @param [Integer] export_timeout_millis the maximum export timeout.
+          #   Defaults to the value of the OTEL_METRIC_EXPORT_TIMEOUT environment
+          #   variable, if set, or 30_000.
+          # @param [MetricReader] exporter the (duck type) MetricReader to where the
+          #   recorded metrics are pushed after certain interval.
+          #
+          # @return a new instance of the {PeriodicMetricReader}.
+          def initialize(export_interval_millis: Float(ENV.fetch('OTEL_METRIC_EXPORT_INTERVAL', 60_000)),
+                         export_timeout_millis: Float(ENV.fetch('OTEL_METRIC_EXPORT_TIMEOUT', 30_000)),
+                         exporter: nil)
+            super()
+
+            @export_interval = export_interval_millis / 1000.0
+            @export_timeout = export_timeout_millis / 1000.0
+            @exporter = exporter
+            @thread   = nil
+            @continue = false
+            @mutex = Mutex.new
+            @export_mutex = Mutex.new
+
+            start
+          end
+
+          def shutdown(timeout: nil)
+            thread = lock do
+              @continue = false # force termination in next iteration
+              @thread
+            end
+            thread&.join(@export_interval)
+            @exporter.force_flush if @exporter.respond_to?(:force_flush)
+            @exporter.shutdown
+            Export::SUCCESS
+          rescue StandardError => e
+            OpenTelemetry.handle_error(exception: e, message: 'Fail to shutdown PeriodicMetricReader.')
+            Export::FAILURE
+          end
+
+          def force_flush(timeout: nil)
+            export(timeout: timeout)
+            Export::SUCCESS
+          rescue StandardError
+            Export::FAILURE
+          end
+
+          private
+
+          def start
+            @continue = true
+            if @exporter.nil?
+              OpenTelemetry.logger.warn 'Missing exporter in PeriodicMetricReader.'
+            elsif @thread&.alive?
+              OpenTelemetry.logger.warn 'PeriodicMetricReader is still running. Please shutdown it if it needs to restart.'
+            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.')
+                  end
+                end
+              end
+            end
+          end
+
+          def export(timeout: nil)
+            @export_mutex.synchronize do
+              collected_metrics = collect
+              @exporter.export(collected_metrics, timeout: timeout || @export_timeout) unless collected_metrics.empty?
+            end
+          end
+
+          def lock(&block)
+            @mutex.synchronize(&block)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -26,3 +26,4 @@ end
 require 'opentelemetry/sdk/metrics/export/metric_reader'
 require 'opentelemetry/sdk/metrics/export/in_memory_metric_pull_exporter'
 require 'opentelemetry/sdk/metrics/export/console_metric_pull_exporter'
+require 'opentelemetry/sdk/metrics/export/periodic_metric_reader'

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

@@ -28,7 +28,7 @@ module OpenTelemetry
 
         # @api private
         def add_metric_reader(metric_reader)
-          @instrument_registry.each do |_n, instrument|
+          @instrument_registry.each_value do |instrument|
             instrument.register_with_new_metric_store(metric_reader.metric_store)
           end
         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.1.0'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-metrics-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-31 00:00:00.000000000 Z
+date: 2024-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: '1.65'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: '1.65'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +215,7 @@ files:
 - lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb
 - lib/opentelemetry/sdk/metrics/export/in_memory_metric_pull_exporter.rb
 - lib/opentelemetry/sdk/metrics/export/metric_reader.rb
+- lib/opentelemetry/sdk/metrics/export/periodic_metric_reader.rb
 - lib/opentelemetry/sdk/metrics/instrument.rb
 - lib/opentelemetry/sdk/metrics/instrument/counter.rb
 - lib/opentelemetry/sdk/metrics/instrument/histogram.rb
@@ -234,10 +235,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.1.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-sdk/v0.2.0/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.1.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-sdk/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: