mongo 2.25.0 → 2.26.1

data/lib/mongo/tracing/open_telemetry/operation_tracer.rb

@@ -37,6 +37,8 @@ module Mongo
         def initialize(otel_tracer, parent_tracer)
           @otel_tracer = otel_tracer
           @parent_tracer = parent_tracer
+          @operation_names = {}
+          @operation_names_mutex = Mutex.new
         end
 
         # Trace a MongoDB operation.
@@ -53,21 +55,43 @@ module Mongo
         # @yield the block representing the operation to be traced.
         #
         # @return [ Object ] the result of the operation.
-        #
-        # rubocop:disable Lint/RescueException
         def trace_operation(operation, operation_context, op_name: nil, &block)
           span = create_operation_span(operation, operation_context, op_name)
-          execute_with_span(span, operation, &block)
+          # With no SDK and no valid parent, the API returns a span with an
+          # invalid context. It cannot be made current, recorded or
+          # propagated, so it gets no work at all, not even finishing it.
+          return yield unless span.context.valid?
+
+          trace_with_span(span, operation, &block)
+        end
+
+        private
+
+        # Runs the operation with the span made current, and finishes the span.
+        # A span that is not recording is still made current, so that the
+        # command spans created within it nest under it, but gets no further
+        # attributes and no outcome: the SDK would discard them.
+        #
+        # @param span [ OpenTelemetry::Trace::Span ] a span with a valid context.
+        # @param operation [ Mongo::Operation ] the operation.
+        #
+        # @return [ Object ] the result of the operation.
+        #
+        # rubocop:disable Lint/RescueException
+        def trace_with_span(span, operation, &block)
+          recording = span.recording?
+          if recording && !operation.cursor_id.nil?
+            span.set_attribute('db.mongodb.cursor_id', operation.cursor_id)
+          end
+          execute_with_span(span, operation, recording, &block)
         rescue Exception => e
-          handle_span_exception(span, e)
+          handle_span_exception(span, e) if recording
           raise e
         ensure
-          span&.finish
+          span.finish
         end
         # rubocop:enable Lint/RescueException
 
-        private
-
         # Creates an OpenTelemetry span for the operation.
         #
         # @param operation [ Mongo::Operation ] the operation.
@@ -89,14 +113,15 @@ module Mongo
         #
         # @param span [ OpenTelemetry::Trace::Span ] the span.
         # @param operation [ Mongo::Operation ] the operation.
+        # @param recording [ true | false ] whether the span is recording.
         #
         # @yield the block to execute.
         #
         # @return [ Object ] the result of the block.
-        def execute_with_span(span, operation)
+        def execute_with_span(span, operation, recording)
           ::OpenTelemetry::Trace.with_span(span) do |s, c|
             yield.tap do |result|
-              process_cursor_context(result, operation.cursor_id, c, s)
+              process_cursor_context(result, operation.cursor_id, c, s, recording)
             end
           end
         end
@@ -106,8 +131,6 @@ module Mongo
         # @param span [ OpenTelemetry::Trace::Span ] the span.
         # @param exception [ Exception ] the exception.
         def handle_span_exception(span, exception)
-          return unless span
-
           span.record_exception(exception)
           span.status = ::OpenTelemetry::Trace::Status.error(
             "Unhandled exception of type: #{exception.class}"
@@ -115,16 +138,28 @@ module Mongo
         end
 
         # Returns the operation name from the provided name or operation class.
+        # The name derived from the class is cached per class. There are few
+        # operation classes, so the cache needs no bound. It is guarded by a
+        # mutex because not every Ruby runtime makes Hash writes thread-safe.
         #
         # @param operation [ Mongo::Operation ] the operation.
         # @param op_name [ String | nil ] optional operation name.
         #
         # @return [ String ] the operation name in lowercase.
         def operation_name(operation, op_name = nil)
-          op_name || operation.class.name.split('::').last.downcase
+          return op_name if op_name
+
+          klass = operation.class
+          @operation_names_mutex.synchronize do
+            @operation_names[klass] ||= klass.name.split('::').last.downcase
+          end
         end
 
-        # Builds span attributes for the operation.
+        # Builds the attributes passed at span creation. The cursor id is set
+        # by trace_with_span once the span is known to record.
+        # db.operation.summary is outside the spec's recommended creation set,
+        # but it is the span name, which is built anyway, and an attribute
+        # passed at creation is cheaper than one set later.
         #
         # @param operation [ Mongo::Operation ] the operation.
         # @param op_name [ String | nil ] optional operation name.
@@ -136,8 +171,7 @@ module Mongo
             'db.namespace' => operation.db_name.to_s,
             'db.collection.name' => collection_name(operation),
             'db.operation.name' => operation_name(operation, op_name),
-            'db.operation.summary' => operation_span_name(operation, op_name),
-            'db.mongodb.cursor_id' => operation.cursor_id,
+            'db.operation.summary' => operation_span_name(operation, op_name)
           }.compact
         end
 
@@ -150,7 +184,8 @@ module Mongo
         # @param cursor_id [ Integer | nil ] the cursor ID before the operation.
         # @param context [ OpenTelemetry::Context ] the OpenTelemetry context.
         # @param span [ OpenTelemetry::Trace::Span ] the current span.
-        def process_cursor_context(result, cursor_id, context, span)
+        # @param recording [ true | false ] whether the span is recording.
+        def process_cursor_context(result, cursor_id, context, span, recording)
           return unless result.is_a?(Cursor)
 
           if result.id.zero?
@@ -159,7 +194,7 @@ module Mongo
           elsif result.id && cursor_id.nil?
             # New cursor created, store its context.
             cursor_context_map[result.id] = context
-            span.set_attribute('db.mongodb.cursor_id', result.id)
+            span.set_attribute('db.mongodb.cursor_id', result.id) if recording
           end
         end
 

data/lib/mongo/tracing/open_telemetry/tracer.rb

@@ -200,6 +200,9 @@ module Mongo
         # Generates a unique key for transaction tracking.
         #
         # Returns nil for implicit sessions or sessions not in a transaction.
+        # Every operation in a transaction needs the key, so it is cached on
+        # the session together with the transaction number it was built for.
+        # Two threads may build it at the same time; they build the same key.
         #
         # @param session [ Mongo::Session ] the session.
         #
@@ -207,7 +210,13 @@ module Mongo
         def transaction_map_key(session)
           return if session.nil? || session.implicit? || !session.in_transaction?
 
-          "#{session.session_id['id'].to_uuid}-#{session.txn_num}"
+          txn_num = session.txn_num
+          cached = session.tracing_transaction_key
+          return cached[1] if cached && cached[0] == txn_num
+
+          key = "#{session.session_id['id'].to_uuid}-#{txn_num}"
+          session.tracing_transaction_key = [ txn_num, key ].freeze
+          key
         end
 
         private

data/lib/mongo/uri/options_mapper.rb

@@ -614,7 +614,7 @@ module Mongo
       #
       # @return [ Hash | nil ] The auth mechanism properties hash.
       def convert_auth_mech_props(_name, value)
-        properties = hash_extractor('authMechanismProperties', value)
+        properties = hash_extractor('authMechanismProperties', value, invalidate_on_error: true)
         if properties
           properties.each do |k, v|
             properties[k] = (v.downcase == 'true') if k.to_s.downcase == 'canonicalize_host_name' && v
@@ -863,16 +863,27 @@ module Mongo
 
       # Extract values from the string and put them into a nested hash.
       #
+      # Multiple key-value pairs are delimited by a comma. Within each pair,
+      # the key is everything up to the first colon and the value is everything
+      # after it, so values may themselves contain colons (for example
+      # TOKEN_RESOURCE:mongodb://host).
+      #
       # @param [ String ] name Name of the URI option being processed.
       # @param [ String ] value The string to build a hash from.
+      # @param [ true | false ] invalidate_on_error When a pair is malformed
+      #   (has no value), discard the whole option and return nil instead of
+      #   skipping just that pair. Used for options such as
+      #   authMechanismProperties whose values must not contain commas.
       #
-      # @return [ Hash ] The hash built from the string.
-      def hash_extractor(name, value)
+      # @return [ Hash | nil ] The hash built from the string, or nil.
+      def hash_extractor(name, value, invalidate_on_error: false)
         h = {}
         value.split(',').each do |tag|
-          k, v = tag.split(':')
+          k, v = tag.split(':', 2)
           if v.nil?
             log_warn("Invalid hash value for #{name}: key `#{k}` does not have a value: #{value}")
+            return nil if invalidate_on_error
+
             next
           end
 

data/lib/mongo/version.rb

@@ -5,5 +5,5 @@ module Mongo
   #
   # Note that this file is automatically updated via `rake candidate:create`.
   # Manual changes to this file will be overwritten by that rake task.
-  VERSION = '2.25.0'
+  VERSION = '2.26.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo
 version: !ruby/object:Gem::Version
-  version: 2.25.0
+  version: 2.26.1
 platform: ruby
 authors:
 - The MongoDB Ruby Team
@@ -561,7 +561,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.23
 specification_version: 4
 summary: Ruby driver for MongoDB
 test_files: []