couchbase-opentelemetry 3.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e1312cc5095ec60121ba6d28d407d7600aa8aa8a441f446303ea5e5d176ca88
+  data.tar.gz: 4542b7625cc80c34bfd4fcf085f11e0459396c42bf52c8de747b2aa83786d2f0
+SHA512:
+  metadata.gz: 7c4a114d769450c05824c3a3b7c3677c54d621ed6ea93a0219c11f0b1f107e6d62aa29cce49dbfc21e2d0e9e16e596817280048b57c8ec0c91bcb230bd441a1d
+  data.tar.gz: 294181eb4b749822f1ea5b31128763052461afbbbd62881883c839895ffd4e2f356300eff4eecde8af6db4ba9007025f1b567f9059af79073fd0290ff7208aee

data/lib/couchbase/opentelemetry/meter.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+#  Copyright 2026-Present Couchbase, Inc.
+#
+#  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.
+
+require "couchbase/metrics/meter"
+require "couchbase/errors"
+require_relative "value_recorder"
+
+require "opentelemetry-metrics-api"
+
+module Couchbase
+  module OpenTelemetry
+    # @couchbase.stability
+    #  **Uncommitted:** This API may change in the future, as Metrics in OpenTelemetry Ruby are currently in development.
+    #
+    #  See the {https://opentelemetry.io/docs/languages/ruby/#status-and-releases OpenTelemetry Ruby documentation} for more information.
+    class Meter < ::Couchbase::Metrics::Meter
+      # Initializes a Couchbase OpenTelemetry Meter
+      #
+      # @param [::OpenTelemetry::Metrics::MeterProvider] meter_provider The OpenTelemetry meter provider
+      #
+      # @raise [Couchbase::Error::MeterError] if the meter cannot be created for any reason
+      #
+      # @example Initializing a Couchbase OpenTelemetry Meter with an OTLP Exporter
+      #   require "opentelemetry-metrics-sdk"
+      #
+      #   # Initialize a meter provider
+      #   meter_provider = ::OpenTelemetry::SDK::Metrics::MeterProvider.new
+      #   meter_provider.add_metric_reader(
+      #       ::OpenTelemetry::SDK::Metrics::Export::PeriodicMetricReader.new(
+      #           exporter: ::OpenTelemetry::Exporter::OTLP::Metrics::MetricsExporter.new(
+      #               endpoint: "https://<hostname>:<port>/v1/metrics"
+      #          )
+      #       )
+      #   )
+      #   # Initialize the Couchbase OpenTelemetry Meter
+      #   meter = Couchbase::OpenTelemetry::Meter.new(meter_provider)
+      #
+      #   # Set the meter in the cluster options
+      #   options = Couchbase::Options::Cluster.new(
+      #      authenticator: Couchbase::PasswordAuthenticator.new("Administrator", "password")
+      #      meter: meter
+      #   )
+      #
+      # @see https://www.rubydoc.info/gems/opentelemetry-metrics-sdk/OpenTelemetry/SDK/Metrics/MeterProvider
+      #  <tt>opentelemetry-metrics-sdk</tt> API Reference
+      def initialize(meter_provider)
+        super()
+        @histogram_cache = Concurrent::Map.new
+        begin
+          @wrapped = meter_provider.meter("com.couchbase.client/ruby")
+        rescue StandardError => e
+          raise Error::MeterError.new("Failed to create OpenTelemetry Meter: #{e.message}", nil, e)
+        end
+      end
+
+      def value_recorder(name, tags)
+        unit = tags.delete("__unit")
+
+        otel_histogram = @histogram_cache.compute_if_absent(name) do
+          @wrapped.create_histogram(name, unit: unit)
+        end
+
+        ValueRecorder.new(otel_histogram, tags, unit: unit)
+      rescue StandardError => e
+        raise Error::MeterError.new("Failed to create OpenTelemetry Histogram: #{e.message}", nil, e)
+      end
+    end
+  end
+end

data/lib/couchbase/opentelemetry/request_span.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+#  Copyright 2026-Present Couchbase, Inc.
+#
+#  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.
+
+require "couchbase/tracing/request_span"
+
+require "opentelemetry-api"
+
+module Couchbase
+  module OpenTelemetry
+    class RequestSpan < ::Couchbase::Tracing::RequestSpan
+      def initialize(span)
+        super()
+
+        @wrapped = span
+      end
+
+      def set_attribute(key, value)
+        @wrapped.set_attribute(key, value)
+      end
+
+      def status=(status_code)
+        @wrapped.status = if status_code == :ok
+                            ::OpenTelemetry::Trace::Status.ok
+                          elsif status_code == :error
+                            ::OpenTelemetry::Trace::Status.error
+                          else
+                            ::OpenTelemetry::Trace::Status.unset
+                          end
+      end
+
+      def finish(end_timestamp: nil)
+        @wrapped.finish(end_timestamp: end_timestamp)
+      end
+    end
+  end
+end

data/lib/couchbase/opentelemetry/request_tracer.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+#  Copyright 2026-Present Couchbase, Inc.
+#
+#  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.
+
+require "opentelemetry-api"
+
+require "couchbase/tracing/request_tracer"
+require "couchbase/errors"
+require_relative "request_span"
+
+module Couchbase
+  module OpenTelemetry
+    class RequestTracer < ::Couchbase::Tracing::RequestTracer
+      # Initializes a Couchbase OpenTelemetry Request Tracer
+      #
+      # @param [::OpenTelemetry::Trace::TracerProvider] tracer_provider The OpenTelemetry tracer provider
+      #
+      # @raise [Couchbase::Error::TracerError] if the tracer cannot be created for any reason
+      #
+      # @example Initializing a Couchbase OpenTelemetry Request Tracer with an OTLP Exporter
+      #   require "opentelemetry-sdk"
+      #
+      #   # Initialize a tracer provider
+      #   tracer_provider = ::OpenTelemetry::SDK::Trace::TracerProvider.new
+      #   tracer_provider.add_span_processor(
+      #       ::OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
+      #           exporter: ::OpenTelemetry::Exporter::OTLP::Exporter.new(
+      #               endpoint: "https://<hostname>:<port>/v1/traces"
+      #          )
+      #       )
+      #   )
+      #   # Initialize the Couchbase OpenTelemetry Request Tracer
+      #   tracer = Couchbase::OpenTelemetry::RequestTracer.new(tracer_provider)
+      #
+      #   # Set the tracer in the cluster options
+      #   options = Couchbase::Options::Cluster.new(
+      #      authenticator: Couchbase::PasswordAuthenticator.new("Administrator", "password")
+      #      tracer: tracer
+      #   )
+      #
+      # @see https://www.rubydoc.info/gems/opentelemetry-sdk/OpenTelemetry/SDK/Trace/TracerProvider
+      #  <tt>opentelemetry-sdk</tt> API Reference
+      def initialize(tracer_provider)
+        super()
+        begin
+          @wrapped = tracer_provider.tracer("com.couchbase.client/ruby")
+        rescue StandardError => e
+          raise Error::TracerError.new("Failed to create OpenTelemetry tracer: #{e.message}", nil, e)
+        end
+      end
+
+      def request_span(name, parent: nil, start_timestamp: nil)
+        parent_context = parent.nil? ? nil : ::OpenTelemetry::Trace.context_with_span(parent.instance_variable_get(:@wrapped))
+        RequestSpan.new(
+          @wrapped.start_span(
+            name,
+            with_parent: parent_context,
+            start_timestamp: start_timestamp,
+            kind: :client,
+          ),
+        )
+      rescue StandardError => e
+        raise Error::TracerError.new("Failed to create OpenTelemetry span: #{e.message}", nil, e)
+      end
+    end
+  end
+end

data/lib/couchbase/opentelemetry/value_recorder.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+#  Copyright 2026-Present Couchbase, Inc.
+#
+#  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.
+
+require "couchbase/metrics/value_recorder"
+
+module Couchbase
+  module OpenTelemetry
+    class ValueRecorder < ::Couchbase::Metrics::ValueRecorder
+      def initialize(recorder, tags, unit: nil)
+        super()
+        @wrapped = recorder
+        @tags = tags
+        @unit = unit
+      end
+
+      def record_value(value)
+        value =
+          case @unit
+          when "s"
+            value / 1_000_000.0
+          else
+            value
+          end
+
+        @wrapped.record(value, attributes: @tags)
+      end
+    end
+  end
+end

data/lib/couchbase/opentelemetry/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+#  Copyright 2026-Present Couchbase, Inc.
+#
+#  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.
+
+module Couchbase
+  module OpenTelemetry
+    # Version of the Couchbase OpenTelemetry integration gem
+    VERSION = "3.8.0"
+  end
+end

data/lib/couchbase/opentelemetry.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+#  Copyright 2026-Present Couchbase, Inc.
+#
+#  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.
+
+require_relative "opentelemetry/request_tracer"
+require_relative "opentelemetry/meter"
+require_relative "opentelemetry/version"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: couchbase-opentelemetry
+version: !ruby/object:Gem::Version
+  version: 3.8.0
+platform: ruby
+authors:
+- Sergey Avseyev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2026-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-metrics-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: OpenTelemetry integration for the Couchbase Ruby Client
+email:
+- sergey.avseyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/couchbase/opentelemetry.rb
+- lib/couchbase/opentelemetry/meter.rb
+- lib/couchbase/opentelemetry/request_span.rb
+- lib/couchbase/opentelemetry/request_tracer.rb
+- lib/couchbase/opentelemetry/value_recorder.rb
+- lib/couchbase/opentelemetry/version.rb
+homepage: https://www.couchbase.com
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://docs.couchbase.com/ruby-sdk/current/hello-world/start-using-sdk.html
+  bug_tracker_uri: https://jira.issues.couchbase.com/browse/RCBC
+  mailing_list_uri: https://www.couchbase.com/forums/c/ruby-sdk
+  source_code_uri: https://github.com/couchbase/couchbase-ruby-client/tree/3.8.0
+  changelog_uri: https://github.com/couchbase/couchbase-ruby-client/releases/tag/3.8.0
+  documentation_uri: https://docs.couchbase.com/sdk-api/couchbase-ruby-client-3.8.0/index.html
+  github_repo: https://github.com/couchbase/couchbase-ruby-client
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key: 
+specification_version: 4
+summary: OpenTelemetry integration for the Couchbase Ruby Client
+test_files: []