mongo 2.5.3 → 2.6.0

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -68,7 +68,7 @@ module Mongo
       # @since 2.1.0
       def succeeded(event)
         if logger.debug?
-          log_debug("#{prefix(event)} | SUCCEEDED | #{event.duration}s")
+          log_debug("#{prefix(event)} | SUCCEEDED | #{'%.3f' % event.duration}s")
         end
       end
 

data/lib/mongo/monitoring/event.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'mongo/event'
 require 'mongo/monitoring/event/secure'
 require 'mongo/monitoring/event/command_started'
 require 'mongo/monitoring/event/command_succeeded'

data/lib/mongo/monitoring/event/command_failed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event that is fired when a command operation fails.
       #
       # @since 2.1.0
-      class CommandFailed
+      class CommandFailed < Mongo::Event::Base
 
         # @return [ Server::Address ] address The server address.
         attr_reader :address
@@ -33,7 +33,14 @@ module Mongo
         # @return [ Float ] duration The duration of the command in seconds.
         attr_reader :duration
 
-        # @return [ String ] message The error message.
+        # @return [ BSON::Document ] failure The error document, if present.
+        #   This will only be filled out for errors communicated by a
+        #   MongoDB server. In other situations, for example in case of
+        #   a network error, this attribute may be nil.
+        attr_reader :failure
+
+        # @return [ String ] message The error message. Unlike the error
+        #   document, the error message should always be present.
         attr_reader :message
 
         # @return [ Integer ] operation_id The operation id.
@@ -52,16 +59,19 @@ module Mongo
         # @param [ Integer ] request_id The request id.
         # @param [ Integer ] operation_id The operation id.
         # @param [ String ] message The error message.
+        # @param [ BSON::Document ] failure The error document, if any.
         # @param [ Float ] duration The duration the command took in seconds.
         #
         # @since 2.1.0
-        def initialize(command_name, database_name, address, request_id, operation_id, message, duration)
-          @command_name = command_name
+        # @api private
+        def initialize(command_name, database_name, address, request_id, operation_id, message, failure, duration)
+          @command_name = command_name.to_s
           @database_name = database_name
           @address = address
           @request_id = request_id
           @operation_id = operation_id
           @message = message
+          @failure = failure
           @duration = duration
         end
 
@@ -74,12 +84,14 @@ module Mongo
         # @param [ Integer ] operation_id The operation id.
         # @param [ Hash ] payload The message payload.
         # @param [ String ] message The error message.
+        # @param [ BSON::Document ] failure The error document, if any.
         # @param [ Float ] duration The duration of the command in seconds.
         #
         # @return [ CommandFailed ] The event.
         #
         # @since 2.1.0
-        def self.generate(address, operation_id, payload, message, duration)
+        # @api private
+        def self.generate(address, operation_id, payload, message, failure, duration)
           new(
             payload[:command_name],
             payload[:database_name],
@@ -87,6 +99,7 @@ module Mongo
             payload[:request_id],
             operation_id,
             message,
+            failure,
             duration
           )
         end

data/lib/mongo/monitoring/event/command_started.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event that is fired when a command operation starts.
       #
       # @since 2.1.0
-      class CommandStarted
+      class CommandStarted < Mongo::Event::Base
         include Secure
 
         # @return [ Server::Address ] address The server address.
@@ -52,8 +52,9 @@ module Mongo
         # @param [ BSON::Document ] command The command arguments.
         #
         # @since 2.1.0
+        # @api private
         def initialize(command_name, database_name, address, request_id, operation_id, command)
-          @command_name = command_name
+          @command_name = command_name.to_s
           @database_name = database_name
           @address = address
           @request_id = request_id
@@ -73,6 +74,7 @@ module Mongo
         # @return [ CommandStarted ] The event.
         #
         # @since 2.1.0
+        # @api private
         def self.generate(address, operation_id, payload)
           new(
             payload[:command_name],
@@ -83,6 +85,15 @@ module Mongo
             payload[:command]
           )
         end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @since 2.6.0
+        def inspect
+          "#<{#{self.class} command=#{command_name}>"
+        end
       end
     end
   end

data/lib/mongo/monitoring/event/command_succeeded.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event that is fired when a command operation succeeds.
       #
       # @since 2.1.0
-      class CommandSucceeded
+      class CommandSucceeded < Mongo::Event::Base
         include Secure
 
         # @return [ Server::Address ] address The server address.
@@ -56,8 +56,9 @@ module Mongo
         # @param [ Float ] duration The duration the command took in seconds.
         #
         # @since 2.1.0
+        # @api private
         def initialize(command_name, database_name, address, request_id, operation_id, reply, duration)
-          @command_name = command_name
+          @command_name = command_name.to_s
           @database_name = database_name
           @address = address
           @request_id = request_id
@@ -80,6 +81,7 @@ module Mongo
         # @return [ CommandCompleted ] The event.
         #
         # @since 2.1.0
+        # @api private
         def self.generate(address, operation_id, command_payload, reply_payload, duration)
           new(
             command_payload[:command_name],

data/lib/mongo/monitoring/event/secure.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring/event/server_closed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event fired when the server is closed.
       #
       # @since 2.4.0
-      class ServerClosed
+      class ServerClosed < Mongo::Event::Base
 
         # @return [ Address ] address The server address.
         attr_reader :address

data/lib/mongo/monitoring/event/server_description_changed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event fired when a server's description changes.
       #
       # @since 2.4.0
-      class ServerDescriptionChanged
+      class ServerDescriptionChanged < Mongo::Event::Base
 
         # @return [ Address ] address The server address.
         attr_reader :address

data/lib/mongo/monitoring/event/server_opening.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event fired when the server is opening.
       #
       # @since 2.4.0
-      class ServerOpening
+      class ServerOpening < Mongo::Event::Base
 
         # @return [ Address ] address The server address.
         attr_reader :address
@@ -40,6 +40,15 @@ module Mongo
           @address = address
           @topology = topology
         end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @since 2.6.0
+        def inspect
+          "#<#{self.class} address=#{address} topology=#{topology.class.name.sub(/.*::/, '')}>"
+        end
       end
     end
   end

data/lib/mongo/monitoring/event/topology_changed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event fired when the topology changes.
       #
       # @since 2.4.0
-      class TopologyChanged
+      class TopologyChanged < Mongo::Event::Base
 
         # @return [ Cluster::Topology ] previous_topology The previous topology.
         attr_reader :previous_topology
@@ -40,6 +40,17 @@ module Mongo
           @previous_topology = previous_topology
           @new_topology = new_topology
         end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @since 2.6.0
+        def inspect
+          "#<Mongo::Monitoring::Event::TopologyChanged" +
+          " prev=#{previous_topology.class.name.sub(/.*::/, '')}" +
+          " new=#{new_topology.class.name.sub(/.*::/, '')}>"
+        end
       end
     end
   end

data/lib/mongo/monitoring/event/topology_closed.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event fired when the topology closes.
       #
       # @since 2.4.0
-      class TopologyClosed
+      class TopologyClosed < Mongo::Event::Base
 
         # @return [ Topology ] topology The topology.
         attr_reader :topology

data/lib/mongo/monitoring/event/topology_opening.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ module Mongo
       # Event fired when the topology is opening.
       #
       # @since 2.4.0
-      class TopologyOpening
+      class TopologyOpening < Mongo::Event::Base
 
         # @return [ Topology ] topology The topology.
         attr_reader :topology
@@ -35,6 +35,15 @@ module Mongo
         def initialize(topology)
           @topology = topology
         end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @since 2.6.0
+        def inspect
+          "#<#{self.class} topology=#{topology.class.name.sub(/.*::/, '')}>"
+        end
       end
     end
   end

data/lib/mongo/monitoring/publishable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 MongoDB, Inc.
+# Copyright (C) 2015-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@ module Mongo
     #
     # @since 2.1.0
     module Publishable
+      include Loggable
 
       # @return [ Monitoring ] monitoring The monitoring.
       attr_reader :monitoring
@@ -50,7 +51,7 @@ module Mongo
           result
         rescue Exception => e
           total_duration = duration(receive_start) + send_duration
-          command_failed(address, operation_id, payload, e.message, total_duration)
+          command_failed(nil, address, operation_id, payload, e.message, total_duration)
           raise e
         end
       end
@@ -60,7 +61,10 @@ module Mongo
       end
 
       def publish_sdam_event(topic, event)
-        monitoring.succeeded(topic, event) if monitoring?
+        return unless monitoring?
+
+        log_debug("EVENT: #{event.inspect}")
+        monitoring.succeeded(topic, event)
       end
 
       private
@@ -76,7 +80,7 @@ module Mongo
         document = result ? (result.documents || []).first : nil
         if error?(document)
           parser = Error::Parser.new(document)
-          command_failed(address, operation_id, payload, parser.message, duration)
+          command_failed(document, address, operation_id, payload, parser.message, duration)
         else
           command_succeeded(result, address, operation_id, payload, duration)
         end
@@ -95,10 +99,10 @@ module Mongo
         )
       end
 
-      def command_failed(address, operation_id, payload, message, duration)
+      def command_failed(failure, address, operation_id, payload, message, duration)
         monitoring.failed(
           Monitoring::COMMAND,
-          Event::CommandFailed.generate(address, operation_id, payload, message, duration)
+          Event::CommandFailed.generate(address, operation_id, payload, message, failure, duration)
         )
       end
 

data/lib/mongo/monitoring/sdam_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring/server_closed_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring/server_description_changed_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring/server_opening_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring/topology_changed_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/monitoring/topology_opening_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 MongoDB, Inc.
+# Copyright (C) 2016-2018 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.

data/lib/mongo/operation/aggregate/op_msg.rb

@@ -41,6 +41,9 @@ module Mongo
           result = Result.new(dispatch_message(server))
           process_result(result, server)
           result.validate!
+        rescue Mongo::Error::SocketError => e
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          raise e
         end
 
         private

data/lib/mongo/operation/create/op_msg.rb

@@ -26,6 +26,15 @@ module Mongo
         include Executable
         include SessionsSupported
 
+        def execute(server)
+          result = Result.new(dispatch_message(server))
+          process_result(result, server)
+          result.validate!
+        rescue Mongo::Error::SocketError => e
+          e.send(:add_label, Mongo::Error::TRANSIENT_TRANSACTION_ERROR_LABEL) if session.in_transaction?
+          raise e
+        end
+
         private
 
         def message(server)