couchbase 3.7.0-x86_64-linux → 3.8.1-x86_64-linux

data/lib/couchbase/scope.rb

@@ -29,10 +29,11 @@ module Couchbase
     # @param [Couchbase::Backend] backend
     # @param [String] bucket_name name of the bucket
     # @param [String] scope_name name of the scope
-    def initialize(backend, bucket_name, scope_name)
+    def initialize(backend, bucket_name, scope_name, observability)
       @backend = backend
       @bucket_name = bucket_name
       @name = scope_name
+      @observability = observability
     end
 
     # Opens the default collection for this scope
@@ -41,7 +42,7 @@ module Couchbase
     #
     # @return [Collection]
     def collection(collection_name)
-      Collection.new(@backend, @bucket_name, @name, collection_name)
+      Collection.new(@backend, @bucket_name, @name, collection_name, @observability)
     end
 
     # Performs a query against the query (N1QL) services.
@@ -60,30 +61,34 @@ module Couchbase
     #
     # @return [QueryResult]
     def query(statement, options = Options::Query::DEFAULT)
-      resp = @backend.document_query(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name))
+      @observability.record_operation(Observability::OP_QUERY, options.parent_span, self, :query) do |obs_handler|
+        obs_handler.add_query_statement(statement, options)
 
-      Cluster::QueryResult.new do |res|
-        res.meta_data = Cluster::QueryMetaData.new do |meta|
-          meta.status = resp[:meta][:status]
-          meta.request_id = resp[:meta][:request_id]
-          meta.client_context_id = resp[:meta][:client_context_id]
-          meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
-          meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
-          meta.metrics = Cluster::QueryMetrics.new do |metrics|
-            if resp[:meta][:metrics]
-              metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
-              metrics.execution_time = resp[:meta][:metrics][:execution_time]
-              metrics.sort_count = resp[:meta][:metrics][:sort_count]
-              metrics.result_count = resp[:meta][:metrics][:result_count]
-              metrics.result_size = resp[:meta][:metrics][:result_size]
-              metrics.mutation_count = resp[:meta][:metrics][:mutation_count]
-              metrics.error_count = resp[:meta][:metrics][:error_count]
-              metrics.warning_count = resp[:meta][:metrics][:warning_count]
+        resp = @backend.document_query(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name), obs_handler)
+
+        Cluster::QueryResult.new do |res|
+          res.meta_data = Cluster::QueryMetaData.new do |meta|
+            meta.status = resp[:meta][:status]
+            meta.request_id = resp[:meta][:request_id]
+            meta.client_context_id = resp[:meta][:client_context_id]
+            meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
+            meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
+            meta.metrics = Cluster::QueryMetrics.new do |metrics|
+              if resp[:meta][:metrics]
+                metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
+                metrics.execution_time = resp[:meta][:metrics][:execution_time]
+                metrics.sort_count = resp[:meta][:metrics][:sort_count]
+                metrics.result_count = resp[:meta][:metrics][:result_count]
+                metrics.result_size = resp[:meta][:metrics][:result_size]
+                metrics.mutation_count = resp[:meta][:metrics][:mutation_count]
+                metrics.error_count = resp[:meta][:metrics][:error_count]
+                metrics.warning_count = resp[:meta][:metrics][:warning_count]
+              end
             end
+            meta.warnings = resp[:warnings].map { |warn| Cluster::QueryWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
           end
-          meta.warnings = resp[:warnings].map { |warn| Cluster::QueryWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
+          res.instance_variable_set(:@rows, resp[:rows])
         end
-        res.instance_variable_set(:@rows, resp[:rows])
       end
     end
 
@@ -100,30 +105,34 @@ module Couchbase
     #
     # @return [AnalyticsResult]
     def analytics_query(statement, options = Options::Analytics::DEFAULT)
-      resp = @backend.document_analytics(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name))
+      @observability.record_operation(Observability::OP_ANALYTICS_QUERY, options.parent_span, self, :analytics) do |obs_handler|
+        obs_handler.add_query_statement(statement, options)
+
+        resp = @backend.document_analytics(statement, options.to_backend(scope_name: @name, bucket_name: @bucket_name))
 
-      Cluster::AnalyticsResult.new do |res|
-        res.transcoder = options.transcoder
-        res.meta_data = Cluster::AnalyticsMetaData.new do |meta|
-          meta.status = resp[:meta][:status]
-          meta.request_id = resp[:meta][:request_id]
-          meta.client_context_id = resp[:meta][:client_context_id]
-          meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
-          meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
-          meta.metrics = Cluster::AnalyticsMetrics.new do |metrics|
-            if resp[:meta][:metrics]
-              metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
-              metrics.execution_time = resp[:meta][:metrics][:execution_time]
-              metrics.result_count = resp[:meta][:metrics][:result_count]
-              metrics.result_size = resp[:meta][:metrics][:result_size]
-              metrics.error_count = resp[:meta][:metrics][:error_count]
-              metrics.warning_count = resp[:meta][:metrics][:warning_count]
-              metrics.processed_objects = resp[:meta][:metrics][:processed_objects]
+        Cluster::AnalyticsResult.new do |res|
+          res.transcoder = options.transcoder
+          res.meta_data = Cluster::AnalyticsMetaData.new do |meta|
+            meta.status = resp[:meta][:status]
+            meta.request_id = resp[:meta][:request_id]
+            meta.client_context_id = resp[:meta][:client_context_id]
+            meta.signature = JSON.parse(resp[:meta][:signature]) if resp[:meta][:signature]
+            meta.profile = JSON.parse(resp[:meta][:profile]) if resp[:meta][:profile]
+            meta.metrics = Cluster::AnalyticsMetrics.new do |metrics|
+              if resp[:meta][:metrics]
+                metrics.elapsed_time = resp[:meta][:metrics][:elapsed_time]
+                metrics.execution_time = resp[:meta][:metrics][:execution_time]
+                metrics.result_count = resp[:meta][:metrics][:result_count]
+                metrics.result_size = resp[:meta][:metrics][:result_size]
+                metrics.error_count = resp[:meta][:metrics][:error_count]
+                metrics.warning_count = resp[:meta][:metrics][:warning_count]
+                metrics.processed_objects = resp[:meta][:metrics][:processed_objects]
+              end
             end
+            res[:warnings] = resp[:warnings].map { |warn| Cluster::AnalyticsWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
           end
-          res[:warnings] = resp[:warnings].map { |warn| Cluster::AnalyticsWarning.new(warn[:code], warn[:message]) } if resp[:warnings]
+          res.instance_variable_set(:@rows, resp[:rows])
         end
-        res.instance_variable_set(:@rows, resp[:rows])
       end
     end
 
@@ -145,8 +154,10 @@ module Couchbase
     #
     # @return [SearchResult]
     def search_query(index_name, query, options = Options::Search::DEFAULT)
-      resp = @backend.document_search(@bucket_name, @name, index_name, JSON.generate(query), {}, options.to_backend)
-      convert_search_result(resp, options)
+      @observability.record_operation(Observability::OP_SEARCH_QUERY, options.parent_span, self, :search) do |obs_handler|
+        resp = @backend.document_search(@bucket_name, @name, index_name, JSON.generate(query), {}, options.to_backend, obs_handler)
+        convert_search_result(resp, options)
+      end
     end
 
     # Performs a request against the Full Text Search (FTS) service.
@@ -157,14 +168,17 @@ module Couchbase
     #
     # @return [SearchResult]
     def search(index_name, search_request, options = Options::Search::DEFAULT)
-      encoded_query, encoded_req = search_request.to_backend
-      resp = @backend.document_search(@bucket_name, @name, index_name, encoded_query, encoded_req, options.to_backend(show_request: false))
-      convert_search_result(resp, options)
+      @observability.record_operation(Observability::OP_SEARCH_QUERY, options.parent_span, self, :search) do |obs_handler|
+        encoded_query, encoded_req = search_request.to_backend
+        resp = @backend.document_search(@bucket_name, @name, index_name, encoded_query, encoded_req,
+                                        options.to_backend(show_request: false), obs_handler)
+        convert_search_result(resp, options)
+      end
     end
 
     # @return [Management::ScopeSearchIndexManager]
     def search_indexes
-      Management::ScopeSearchIndexManager.new(@backend, @bucket_name, @name)
+      Management::ScopeSearchIndexManager.new(@backend, @bucket_name, @name, @observability)
     end
 
     private

data/lib/couchbase/search_options.rb

@@ -84,8 +84,8 @@ module Couchbase
     end
 
     # @return [String]
-    def to_json(*args)
-      to_h.to_json(*args)
+    def to_json(*)
+      to_h.to_json(*)
     end
 
     # Prepare {MatchQuery} body
@@ -1128,8 +1128,8 @@ module Couchbase
     end
 
     # @api private
-    def to_json(*args)
-      to_h.to_json(*args)
+    def to_json(*)
+      to_h.to_json(*)
     end
   end
 
@@ -1173,8 +1173,8 @@ module Couchbase
       end
 
       # @api private
-      def to_json(*args)
-        {by: :score, desc: desc}.to_json(*args)
+      def to_json(*)
+        {by: :score, desc: desc}.to_json(*)
       end
     end
 
@@ -1189,8 +1189,8 @@ module Couchbase
       end
 
       # @api private
-      def to_json(*args)
-        {by: :id, desc: desc}.to_json(*args)
+      def to_json(*)
+        {by: :id, desc: desc}.to_json(*)
       end
     end
 
@@ -1219,8 +1219,8 @@ module Couchbase
       end
 
       # @api private
-      def to_json(*args)
-        {by: :field, field: field, desc: desc, type: type, missing: missing, mode: mode}.to_json(*args)
+      def to_json(*)
+        {by: :field, field: field, desc: desc, type: type, missing: missing, mode: mode}.to_json(*)
       end
     end
 
@@ -1253,8 +1253,8 @@ module Couchbase
       end
 
       # @api private
-      def to_json(*args)
-        {by: :geo_distance, field: field, desc: desc, location: [longitude, latitude], unit: unit}.to_json(*args)
+      def to_json(*)
+        {by: :geo_distance, field: field, desc: desc, location: [longitude, latitude], unit: unit}.to_json(*)
       end
     end
   end
@@ -1292,8 +1292,8 @@ module Couchbase
       end
 
       # @api private
-      def to_json(*args)
-        {field: field, size: size}.to_json(*args)
+      def to_json(*)
+        {field: field, size: size}.to_json(*)
       end
     end
 
@@ -1319,8 +1319,8 @@ module Couchbase
       end
 
       # @api private
-      def to_json(*args)
-        {field: field, size: size, numeric_ranges: @ranges}.to_json(*args)
+      def to_json(*)
+        {field: field, size: size, numeric_ranges: @ranges}.to_json(*)
       end
     end
 
@@ -1351,8 +1351,8 @@ module Couchbase
       end
 
       # @api private
-      def to_json(*args)
-        {field: field, size: size, date_ranges: @ranges}.to_json(*args)
+      def to_json(*)
+        {field: field, size: size, date_ranges: @ranges}.to_json(*)
       end
     end
   end

data/lib/couchbase/tracing/noop_span.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#  Copyright 2025-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 'request_span'
+
+module Couchbase
+  module Tracing
+    class NoopSpan < RequestSpan
+      def set_attribute(*); end
+
+      def status=(*); end
+
+      def finish(*); end
+    end
+  end
+end

data/lib/couchbase/tracing/noop_tracer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+#  Copyright 2025-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 'noop_span'
+
+module Couchbase
+  module Tracing
+    class NoopTracer < RequestTracer
+      def request_span(*)
+        SPAN_INSTANCE
+      end
+
+      SPAN_INSTANCE = NoopSpan.new.freeze
+    end
+  end
+end

data/lib/couchbase/tracing/request_span.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#  Copyright 2025-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 Tracing
+    # @!macro volatile
+    class RequestSpan
+      def set_attribute(key, value)
+        raise NotImplementedError, "The RequestSpan does not implement #set_attribute"
+      end
+
+      def status=(status_code)
+        raise NotImplementedError, "The RequestSpan does not implement #status="
+      end
+
+      def finish(end_timestamp: nil)
+        raise NotImplementedError, "The RequestSpan does not implement #finish"
+      end
+    end
+  end
+end

data/lib/couchbase/tracing/request_tracer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+#  Copyright 2025-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 Tracing
+    # @!macro volatile
+    class RequestTracer
+      def request_span(name, parent: nil, start_timestamp: nil)
+        raise NotImplementedError, "The tracer does not implement #request_span"
+      end
+
+      def close; end
+    end
+  end
+end

data/lib/couchbase/tracing/threshold_logging_span.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+#  Copyright 2025-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 'couchbase/utils/observability_constants'
+
+module Couchbase
+  module Tracing
+    class ThresholdLoggingSpan < RequestSpan
+      attr_accessor :name
+      attr_accessor :should_report
+      attr_accessor :service
+      attr_accessor :encode_duration_us
+      attr_accessor :last_dispatch_duration_us
+      attr_accessor :total_dispatch_duration_us
+      attr_accessor :last_server_duration_us
+      attr_accessor :total_server_duration_us
+      attr_accessor :last_local_id
+      attr_accessor :operation_id
+      attr_accessor :last_peer_address
+      attr_accessor :last_peer_port
+
+      def initialize(name, start_timestamp: nil, parent: nil, tracer: nil)
+        super()
+        @name = name
+        @parent = parent
+        @tracer = tracer
+
+        @start_timestamp = if start_timestamp.nil?
+                             Time.now
+                           else
+                             start_timestamp
+                           end
+      end
+
+      def set_attribute(key, value)
+        case key
+        when Observability::ATTR_OPERATION_ID
+          @operation_id = value
+        when Observability::ATTR_LOCAL_ID
+          @last_local_id = value
+        when Observability::ATTR_PEER_ADDRESS
+          @last_peer_address = value
+        when Observability::ATTR_PEER_PORT
+          @last_peer_port = value
+        when Observability::ATTR_SERVICE
+          @service = value
+        when Observability::ATTR_SERVER_DURATION
+          @last_server_duration_us = value
+        end
+      end
+
+      def status=(*); end
+
+      def finish(end_timestamp: nil)
+        duration_us = (((end_timestamp || Time.now) - @start_timestamp) * 1_000_000).round
+        case name
+        when Observability::STEP_REQUEST_ENCODING
+          return if @parent.nil?
+
+          @parent.should_report = true
+          @parent.encode_duration_us = duration_us
+        when Observability::STEP_DISPATCH_TO_SERVER
+          return if @parent.nil?
+
+          @parent.should_report = true
+          @parent.last_dispatch_duration_us = duration_us
+          @parent.total_dispatch_duration_us = 0 if @parent.total_dispatch_duration_us.nil?
+          @parent.total_dispatch_duration_us += duration_us
+          unless @last_server_duration_us.nil?
+            @parent.last_server_duration_us = @last_server_duration_us
+            @parent.total_server_duration_us = 0 if @parent.total_server_duration_us.nil?
+            @parent.total_server_duration_us += @last_server_duration_us
+          end
+          @parent.last_local_id = @last_local_id
+          @parent.operation_id = @operation_id
+          @parent.last_peer_address = @last_peer_address
+          @parent.last_peer_port = @last_peer_port
+        else
+          @should_report ||= @parent.nil?
+          return unless @should_report && !@service.nil?
+
+          @tracer.record_operation(@service, ThresholdLoggingTracer::Item.new(
+                                               total_duration_us: duration_us,
+                                               encode_duration_us: @encode_duration_us,
+                                               last_dispatch_duration_us: @last_dispatch_duration_us,
+                                               total_dispatch_duration_us: @total_dispatch_duration_us,
+                                               last_server_duration_us: @last_server_duration_us,
+                                               total_server_duration_us: @total_server_duration_us,
+                                               operation_name: @name,
+                                               last_local_id: @last_local_id,
+                                               operation_id: @operation_id,
+                                               last_remote_socket: "#{@last_peer_address}:#{@last_peer_port}",
+                                             ))
+        end
+      end
+    end
+  end
+end