opentelemetry-metrics-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e083b923d5961c60a77e23cec51451171a627cdebaad0aad91c64dedb6f940e4
+  data.tar.gz: 7ec8d56f0f9fcc2db01d173d755351f7d3365632070861ac1d5f920613f7c77e
+SHA512:
+  metadata.gz: 1fe0235ce6aa725df40a48324dfedc6ccc4735bc250b90909964d6bc8d9af0c5c5586fbb174871ba292b2dac78f6971f7881dc6016d55dc5029dc7c0f8b74268
+  data.tar.gz: 6c7460fb94836f0754b9b7ba6f64a807f6477c4715518ae803db9b89da8618b549f140422f6e9749c33ac505c616419356b10fc091bc560e00654a4d6905e40c

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry Metrics API
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/**/*.rb
+./lib/opentelemetry.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Release History: opentelemetry-metrics-api
+
+### v0.1.0 / 2024-07-31
+
+Initial release.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright The OpenTelemetry Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,74 @@
+# opentelemetry-metrics-api
+
+The `opentelemetry-metrics-api` gem is an alpha implementation of the [OpenTelemetry Metrics API][metrics-api] for Ruby applications. Using `opentelemetry-metrics-api`, a library or application can code against the OpenTelemetry interfaces to produce metric data.
+
+## What is OpenTelemetry?
+
+[OpenTelemetry][opentelemetry-home] is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
+
+OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
+
+## How does this gem fit in?
+
+The `opentelemetry-metrics-api` gem defines the core OpenTelemetry interfaces in the form of abstract classes and no-op implementations. That is, it defines interfaces and data types sufficient for a library or application to code against to produce telemetry data, but does not actually collect, analyze, or export the data.
+
+To collect and analyze telemetry data, _applications_ should also install a concrete implementation of the API, such as the `opentelemetry-metrics-sdk` gem. However, _libraries_ that produce telemetry data should depend only on `opentelemetry-metrics-api`, deferring the choise of concrete implementation to the application developer.
+
+This code is still under development and is not a complete implementation of the Metrics API. Until the code becomes stable, Metrics API functionality will live outside the `opentelemetry-api` library.
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-metrics-api
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-metrics-api` in your `Gemfile`.
+
+Then, use the OpenTelemetry interfaces to produces traces and other telemetry data. Following is a basic example.
+
+```ruby
+require 'opentelemetry-metrics-api'
+
+# Obtain the current default meter provider
+provider = OpenTelemetry.meter_provider
+
+# Create a meter
+meter = provider.meter('my_app', '1.0')
+
+# Record a metric
+histogram = meter.create_histogram('histogram', unit: 's', description: 'duration in seconds')
+
+# Record a metric.
+histogram.record(123, attributes: {'foo' => 'bar'})
+```
+
+For additional examples, see the [examples on github][examples-github].
+
+## How can I get involved?
+
+The `opentelemetry-metrics-api` gem source is [on github][repo-github], along with related gems including `opentelemetry-metrics-sdk`.
+
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+
+There's still work to be done, to get to a spec-compliant metrics implementation and we'd love to have more folks contributing to the project. Check the [repo][repo-github] for issues and PRs labeled with `metrics` to see what's available.
+
+## Feedback
+
+During this experimental stage, we're looking for lots of community feedback about this gem. Please add your comments to Issue [#1662][1662].
+
+## License
+
+The `opentelemetry-api` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[metrics-api]: https://opentelemetry.io/docs/specs/otel/metrics/api/
+[opentelemetry-home]: https://opentelemetry.io
+[bundler-home]: https://bundler.io
+[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[examples-github]: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/examples
+[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
+[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+[1662]: https://github.com/open-telemetry/opentelemetry-ruby/issues/1662

data/lib/opentelemetry/internal/proxy_instrument.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Internal
+    # @api private
+    class ProxyInstrument
+      def initialize(kind, name, unit, desc, callable)
+        @kind = kind
+        @name = name
+        @unit = unit
+        @desc = desc
+        @callable = callable
+        @delegate = nil
+      end
+
+      def upgrade_with(meter)
+        @delegate = case @kind
+                    when :counter, :histogram, :up_down_counter
+                      meter.send("create_#{@kind}", @name, unit: @unit, description: @desc)
+                    when :observable_counter, :observable_gauge, :observable_up_down_counter
+                      meter.send("create_#{@kind}", @name, unit: @unit, description: @desc, callback: @callback)
+                    end
+      end
+
+      def add(amount, attributes: nil)
+        @delegate&.add(amount, attributes: attributes)
+      end
+
+      def record(amount, attributes: nil)
+        @delegate&.record(amount, attributes: attributes)
+      end
+    end
+  end
+end

data/lib/opentelemetry/internal/proxy_meter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Internal
+    # @api private
+    #
+    # {ProxyMeter} is an implementation of {OpenTelemetry::Trace::Meter}. It is returned from
+    # the ProxyMeterProvider until a delegate meter provider is installed. After the delegate
+    # meter provider is installed, the ProxyMeter will delegate to the corresponding "real"
+    # meter.
+    class ProxyMeter < Metrics::Meter
+      # Returns a new {ProxyMeter} instance.
+      #
+      # @return [ProxyMeter]
+      def initialize
+        super
+        @delegate = nil
+      end
+
+      # Set the delegate Meter. If this is called more than once, a warning will
+      # be logged and superfluous calls will be ignored.
+      #
+      # @param [Meter] meter The Meter to delegate to
+      def delegate=(meter)
+        @mutex.synchronize do
+          if @delegate.nil?
+            @delegate = meter
+            @instrument_registry.each_value { |instrument| instrument.upgrade_with(meter) }
+          else
+            OpenTelemetry.logger.warn 'Attempt to reset delegate in ProxyMeter ignored.'
+          end
+        end
+      end
+
+      private
+
+      def create_instrument(kind, name, unit, description, callback)
+        super do
+          next ProxyInstrument.new(kind, name, unit, description, callback) if @delegate.nil?
+
+          case kind
+          when :counter then @delegate.create_counter(name, unit: unit, description: description)
+          when :histogram then @delegate.create_histogram(name, unit: unit, description: description)
+          when :up_down_counter then @delegate.create_up_down_counter(name, unit: unit, description: description)
+          when :observable_counter then @delegate.create_observable_counter(name, unit: unit, description: description, callback: callback)
+          when :observable_gauge then @delegate.create_observable_gauge(name, unit: unit, description: description, callback: callback)
+          when :observable_up_down_counter then @delegate.create_observable_up_down_counter(name, unit: unit, description: description, callback: callback)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/internal/proxy_meter_provider.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Internal
+    # @api private
+    #
+    # {ProxyMeterProvider} is an implementation of {OpenTelemetry::Metrics::MeterProvider}.
+    # It is the default global Meter provider returned by OpenTelemetry.meter_provider.
+    # It delegates to a "real" MeterProvider after the global meter provider is registered.
+    # It returns {ProxyMeter} instances until the delegate is installed.
+    class ProxyMeterProvider < Metrics::MeterProvider
+      Key = Struct.new(:name, :version)
+      private_constant(:Key)
+
+      # Returns a new {ProxyMeterProvider} instance.
+      #
+      # @return [ProxyMeterProvider]
+      def initialize
+        @mutex = Mutex.new
+        @registry = {}
+        @delegate = nil
+      end
+
+      # Set the delegate Meter provider. If this is called more than once, a warning will
+      # be logged and superfluous calls will be ignored.
+      #
+      # @param [MeterProvider] provider The Meter provider to delegate to
+      def delegate=(provider)
+        unless @delegate.nil?
+          OpenTelemetry.logger.warn 'Attempt to reset delegate in ProxyMeterProvider ignored.'
+          return
+        end
+
+        @mutex.synchronize do
+          @delegate = provider
+          @registry.each { |key, meter| meter.delegate = provider.meter(key.name, version: key.version) }
+        end
+      end
+
+      # Returns a {Meter} instance.
+      #
+      # @param [optional String] name Instrumentation package name
+      # @param [optional String] version Instrumentation package version
+      #
+      # @return [Meter]
+      def meter(name = nil, version: nil)
+        @mutex.synchronize do
+          return @delegate.meter(name, version: version) unless @delegate.nil?
+
+          @registry[Key.new(name, version)] ||= ProxyMeter.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    module Instrument
+      # No-op implementation of Counter.
+      class Counter
+        # Increment the Counter by a fixed amount.
+        #
+        # @param [numeric] increment The increment amount, which MUST be a non-negative numeric value.
+        # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+        #   Values must be non-nil and (array of) string, boolean or numeric type.
+        #   Array values must not contain nil elements and all elements must be of
+        #   the same basic type (string, numeric, boolean).
+        def add(increment, attributes: nil); end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    module Instrument
+      # No-op implementation of Histogram.
+      class Histogram
+        # Updates the statistics with the specified amount.
+        #
+        # @param [numeric] amount The amount of the Measurement, which MUST be a non-negative numeric value.
+        # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+        #   Values must be non-nil and (array of) string, boolean or numeric type.
+        #   Array values must not contain nil elements and all elements must be of
+        #   the same basic type (string, numeric, boolean).
+        def record(amount, attributes: nil); end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    module Instrument
+      # No-op implementation of ObservableCounter.
+      class ObservableCounter
+        # TODO
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    module Instrument
+      # No-op implementation of ObservableGauge.
+      class ObservableGauge
+        # TODO
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    module Instrument
+      # No-op implementation of ObservableUpDownCounter.
+      class ObservableUpDownCounter
+        # TODO
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    module Instrument
+      # No-op implementation of UpDownCounter.
+      class UpDownCounter
+        # Increment or decrement the UpDownCounter by a fixed amount.
+        #
+        # @param [Numeric] amount The amount to be added, can be positive, negative or zero.
+        # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric, Boolean>}] attributes
+        #   Values must be non-nil and (array of) string, boolean or numeric type.
+        #   Array values must not contain nil elements and all elements must be of
+        #   the same basic type (string, numeric, boolean).
+        def add(amount, attributes: nil); end
+      end
+    end
+  end
+end

data/lib/opentelemetry/metrics/instrument.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/metrics/instrument/counter'
+require 'opentelemetry/metrics/instrument/histogram'
+require 'opentelemetry/metrics/instrument/observable_counter'
+require 'opentelemetry/metrics/instrument/observable_gauge'
+require 'opentelemetry/metrics/instrument/observable_up_down_counter'
+require 'opentelemetry/metrics/instrument/up_down_counter'
+
+module OpenTelemetry
+  module Metrics
+    # Instruments are used to report Measurements.
+    module Instrument
+    end
+  end
+end

data/lib/opentelemetry/metrics/measurement.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    Measurement = Struct.new(:value, :attributes)
+  end
+end

data/lib/opentelemetry/metrics/meter.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    # No-op implementation of Meter.
+    class Meter
+      COUNTER = Instrument::Counter.new
+      OBSERVABLE_COUNTER = Instrument::ObservableCounter.new
+      HISTOGRAM = Instrument::Histogram.new
+      OBSERVABLE_GAUGE = Instrument::ObservableGauge.new
+      UP_DOWN_COUNTER = Instrument::UpDownCounter.new
+      OBSERVABLE_UP_DOWN_COUNTER = Instrument::ObservableUpDownCounter.new
+
+      NAME_REGEX = /\A[a-zA-Z][-.\w]{0,62}\z/
+
+      private_constant(:COUNTER, :OBSERVABLE_COUNTER, :HISTOGRAM, :OBSERVABLE_GAUGE, :UP_DOWN_COUNTER, :OBSERVABLE_UP_DOWN_COUNTER)
+
+      DuplicateInstrumentError = Class.new(OpenTelemetry::Error)
+      InstrumentNameError = Class.new(OpenTelemetry::Error)
+      InstrumentUnitError = Class.new(OpenTelemetry::Error)
+      InstrumentDescriptionError = Class.new(OpenTelemetry::Error)
+
+      def initialize
+        @mutex = Mutex.new
+        @instrument_registry = {}
+      end
+
+      def create_counter(name, unit: nil, description: nil)
+        create_instrument(:counter, name, unit, description, nil) { COUNTER }
+      end
+
+      def create_histogram(name, unit: nil, description: nil)
+        create_instrument(:histogram, name, unit, description, nil) { HISTOGRAM }
+      end
+
+      def create_up_down_counter(name, unit: nil, description: nil)
+        create_instrument(:up_down_counter, name, unit, description, nil) { UP_DOWN_COUNTER }
+      end
+
+      def create_observable_counter(name, callback:, unit: nil, description: nil)
+        create_instrument(:observable_counter, name, unit, description, callback) { OBSERVABLE_COUNTER }
+      end
+
+      def create_observable_gauge(name, callback:, unit: nil, description: nil)
+        create_instrument(:observable_gauge, name, unit, description, callback) { OBSERVABLE_GAUGE }
+      end
+
+      def create_observable_up_down_counter(name, callback:, unit: nil, description: nil)
+        create_instrument(:observable_up_down_counter, name, unit, description, callback) { OBSERVABLE_UP_DOWN_COUNTER }
+      end
+
+      private
+
+      def create_instrument(kind, name, unit, description, callback)
+        raise InstrumentNameError if name.nil?
+        raise InstrumentNameError if name.empty?
+        raise InstrumentNameError unless NAME_REGEX.match?(name)
+        raise InstrumentUnitError if unit && (!unit.ascii_only? || unit.size > 63)
+        raise InstrumentDescriptionError if description && (description.size > 1023 || !utf8mb3_encoding?(description.dup))
+
+        @mutex.synchronize do
+          OpenTelemetry.logger.warn("duplicate instrument registration occurred for instrument #{name}") if @instrument_registry.include? name
+
+          @instrument_registry[name] = yield
+        end
+      end
+
+      def utf8mb3_encoding?(string)
+        string.force_encoding('UTF-8').valid_encoding? &&
+          string.each_char { |c| return false if c.bytesize >= 4 }
+      end
+    end
+  end
+end

data/lib/opentelemetry/metrics/meter_provider.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    # No-op implementation of a meter provider.
+    class MeterProvider
+      # Returns a {Meter} instance.
+      #
+      # @param [String] name Instrumentation package name
+      # @param [optional String] version Instrumentation package version
+      #
+      # @return [Meter]
+      def meter(name, version: nil)
+        @meter ||= Meter.new
+      end
+    end
+  end
+end

data/lib/opentelemetry/metrics/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Metrics
+    ## Current OpenTelemetry metrics version
+    VERSION = '0.1.0'
+  end
+end

data/lib/opentelemetry/metrics.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  # The Metrics API ... TBD.
+  module Metrics
+  end
+end
+
+require 'opentelemetry/metrics/instrument'
+require 'opentelemetry/metrics/measurement'
+require 'opentelemetry/metrics/meter'
+require 'opentelemetry/metrics/meter_provider'

data/lib/opentelemetry-metrics-api.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry'
+require 'opentelemetry/metrics'
+require 'opentelemetry/metrics/version'
+require 'opentelemetry/internal/proxy_instrument'
+require 'opentelemetry/internal/proxy_meter_provider'
+require 'opentelemetry/internal/proxy_meter'
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+module OpenTelemetry
+  @meter_provider = Internal::ProxyMeterProvider.new
+
+  # Register the global meter provider.
+  #
+  # @param [MeterProvider] provider A meter provider to register as the
+  #   global instance.
+  def meter_provider=(provider)
+    @mutex.synchronize do
+      if @meter_provider.instance_of? Internal::ProxyMeterProvider
+        logger.debug("Upgrading default proxy meter provider to #{provider.class}")
+        @meter_provider.delegate = provider
+      end
+      @meter_provider = provider
+    end
+  end
+
+  # @return [Object, Metrics::MeterProvider] registered meter provider or a
+  #   default no-op implementation of the meter provider.
+  def meter_provider
+    @mutex.synchronize { @meter_provider }
+  end
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: opentelemetry-metrics-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OpenTelemetry Authors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ipsa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-test-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.51.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: 
+email:
+- cncf-opentelemetry-contributors@lists.cncf.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/opentelemetry-metrics-api.rb
+- lib/opentelemetry/internal/proxy_instrument.rb
+- lib/opentelemetry/internal/proxy_meter.rb
+- lib/opentelemetry/internal/proxy_meter_provider.rb
+- lib/opentelemetry/metrics.rb
+- lib/opentelemetry/metrics/instrument.rb
+- lib/opentelemetry/metrics/instrument/counter.rb
+- lib/opentelemetry/metrics/instrument/histogram.rb
+- lib/opentelemetry/metrics/instrument/observable_counter.rb
+- lib/opentelemetry/metrics/instrument/observable_gauge.rb
+- lib/opentelemetry/metrics/instrument/observable_up_down_counter.rb
+- lib/opentelemetry/metrics/instrument/up_down_counter.rb
+- lib/opentelemetry/metrics/measurement.rb
+- lib/opentelemetry/metrics/meter.rb
+- lib/opentelemetry/metrics/meter_provider.rb
+- lib/opentelemetry/metrics/version.rb
+homepage: https://github.com/open-telemetry/opentelemetry-ruby
+licenses:
+- Apache-2.0
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-api/v0.1.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/metrics_api
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-metrics-api/v0.1.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: A stats collection and distributed tracing framework
+test_files: []