mongo 2.6.4 → 2.7.0.rc0

data/lib/mongo/monitoring/command_log_subscriber.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 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.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -20,6 +20,9 @@ require 'mongo/monitoring/event/command_failed'
 require 'mongo/monitoring/event/server_closed'
 require 'mongo/monitoring/event/server_description_changed'
 require 'mongo/monitoring/event/server_opening'
+require 'mongo/monitoring/event/server_heartbeat_started'
+require 'mongo/monitoring/event/server_heartbeat_succeeded'
+require 'mongo/monitoring/event/server_heartbeat_failed'
 require 'mongo/monitoring/event/topology_changed'
 require 'mongo/monitoring/event/topology_closed'
 require 'mongo/monitoring/event/topology_opening'

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 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/command_started.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -92,7 +92,7 @@ module Mongo
         #
         # @since 2.6.0
         def inspect
-          "#<{#{self.class} command=#{command_name}>"
+          "#<{#{self.class} #{database_name}.#{command_name} command=#{command}>"
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 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/secure.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@ module Mongo
   class Monitoring
     module Event
 
-      # Provides behaviour to redact sensitive information from commands and
+      # Provides behavior to redact sensitive information from commands and
       # replies.
       #
       # @since 2.1.0

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2018 MongoDB, Inc.
+# Copyright (C) 2016-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -40,6 +40,19 @@ module Mongo
           @address = address
           @topology = topology
         end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " address=#{address} topology=#{topology.summary}>"
+        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2018 MongoDB, Inc.
+# Copyright (C) 2016-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -52,6 +52,21 @@ module Mongo
           @previous_description = previous_description
           @new_description = new_description
         end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " address=#{address} topology=#{topology.summary}" +
+          # TODO Add summaries to descriptions and use them here
+          " prev=#{previous_description.inspect} new=#{new_description.inspect}>"
+        end
       end
     end
   end

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

@@ -0,0 +1,71 @@
+# Copyright (C) 2018-2019 MongoDB, 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 Mongo
+  class Monitoring
+    module Event
+
+      # Event fired when a server heartbeat is dispatched.
+      #
+      # @since 2.7.0
+      class ServerHeartbeatFailed < Mongo::Event::Base
+
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
+        attr_reader :round_trip_time
+
+        # Alias of round_trip_time.
+        alias :duration :round_trip_time
+
+        # @return [ Exception ] error The exception that occurred in ismaster call.
+        attr_reader :error
+
+        # Alias of error for SDAM spec compliance.
+        alias :failure :error
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerHeartbeatSucceeded.new(address, duration)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
+        #
+        # @since 2.7.0
+        # @api private
+        def initialize(address, round_trip_time, error)
+          @address = address
+          @round_trip_time = round_trip_time
+          @error = error
+        end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " address=#{address}" +
+          " error=#{error.inspect}>"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# Copyright (C) 2018-2019 MongoDB, 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 Mongo
+  class Monitoring
+    module Event
+
+      # Event fired when a server heartbeat is dispatched.
+      #
+      # @since 2.7.0
+      class ServerHeartbeatStarted < Mongo::Event::Base
+
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerHeartbeatStarted.new(address)
+        #
+        # @param [ Address ] address The server address.
+        #
+        # @since 2.7.0
+        # @api private
+        def initialize(address)
+          @address = address
+        end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " address=#{address}>"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# Copyright (C) 2018-2019 MongoDB, 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 Mongo
+  class Monitoring
+    module Event
+
+      # Event fired when a server heartbeat is dispatched.
+      #
+      # @since 2.7.0
+      class ServerHeartbeatSucceeded < Mongo::Event::Base
+
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Float ] round_trip_time Duration of ismaster call in seconds.
+        attr_reader :round_trip_time
+
+        # Alias of round_trip_time.
+        alias :duration :round_trip_time
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerHeartbeatSucceeded.new(address, duration)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Float ] round_trip_time Duration of ismaster call in seconds.
+        #
+        # @since 2.7.0
+        # @api private
+        def initialize(address, round_trip_time)
+          @address = address
+          @round_trip_time = round_trip_time
+        end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " address=#{address}>"
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2018 MongoDB, Inc.
+# Copyright (C) 2016-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -45,9 +45,13 @@ module Mongo
         #
         # @return [ String ] String summary of the event.
         #
-        # @since 2.6.0
-        def inspect
-          "#<#{self.class} address=#{address} topology=#{topology.class.name.sub(/.*::/, '')}>"
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " address=#{address} topology=#{topology.summary}>"
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2018 MongoDB, Inc.
+# Copyright (C) 2016-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -45,11 +45,14 @@ module Mongo
         #
         # @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(/.*::/, '')}>"
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " prev=#{previous_topology.summary}" +
+          " new=#{new_topology.summary}>"
         end
       end
     end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2018 MongoDB, Inc.
+# Copyright (C) 2016-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -35,6 +35,19 @@ module Mongo
         def initialize(topology)
           @topology = topology
         end
+
+        # Returns a concise yet useful summary of the event.
+        #
+        # @return [ String ] String summary of the event.
+        #
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " topology=#{topology.summary}>"
+        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2018 MongoDB, Inc.
+# Copyright (C) 2016-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -40,9 +40,13 @@ module Mongo
         #
         # @return [ String ] String summary of the event.
         #
-        # @since 2.6.0
-        def inspect
-          "#<#{self.class} topology=#{topology.class.name.sub(/.*::/, '')}>"
+        # @note This method is experimental and subject to change.
+        #
+        # @since 2.7.0
+        # @api experimental
+        def summary
+          "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
+          " topology=#{topology.summary}>"
         end
       end
     end

data/lib/mongo/monitoring/publishable.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2018 MongoDB, Inc.
+# Copyright (C) 2015-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
 module Mongo
   class Monitoring
 
-    # Defines behaviour for an object that can publish monitoring events.
+    # Defines behavior for an object that can publish monitoring events.
     #
     # @since 2.1.0
     module Publishable
@@ -24,38 +24,6 @@ module Mongo
       # @return [ Monitoring ] monitoring The monitoring.
       attr_reader :monitoring
 
-      # Publish a command event to the global monitoring.
-      #
-      # @example Publish a command event.
-      #   publish_command do |messages|
-      #     # ...
-      #   end
-      #
-      # @param [ Array<Message> ] messages The messages.
-      #
-      # @return [ Object ] The result of the yield.
-      #
-      # @since 2.1.0
-      def publish_command(messages, operation_id = Monitoring.next_operation_id)
-        start = Time.now
-        message = messages.first
-        message.set_request_id
-        payload = message.payload
-        send_duration = duration(start)
-        command_started(address, operation_id, payload)
-        receive_start = Time.now
-        begin
-          result = yield(messages)
-          total_duration = duration(receive_start) + send_duration
-          command_completed(result, address, operation_id, payload, total_duration)
-          result
-        rescue Exception => e
-          total_duration = duration(receive_start) + send_duration
-          command_failed(nil, address, operation_id, payload, e.message, total_duration)
-          raise e
-        end
-      end
-
       def publish_event(topic, event)
         monitoring.succeeded(topic, event)
       end
@@ -63,7 +31,7 @@ module Mongo
       def publish_sdam_event(topic, event)
         return unless monitoring?
 
-        log_debug("EVENT: #{event.inspect}")
+        log_debug("EVENT: #{event.summary}")
         monitoring.succeeded(topic, event)
       end