mongo 2.4.0.rc1 → 2.4.0

data/lib/mongo/monitoring/event.rb

@@ -16,3 +16,9 @@ require 'mongo/monitoring/event/secure'
 require 'mongo/monitoring/event/command_started'
 require 'mongo/monitoring/event/command_succeeded'
 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/topology_changed'
+require 'mongo/monitoring/event/topology_closed'
+require 'mongo/monitoring/event/topology_opening'

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

@@ -0,0 +1,46 @@
+# Copyright (C) 2016 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 the server is closed.
+      #
+      # @since 2.4.0
+      class ServerClosed
+
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Topology ] topology The topology.
+        attr_reader :topology
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerClosed.new(address)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Integer ] topology The topology.
+        #
+        # @since 2.4.0
+        def initialize(address, topology)
+          @address = address
+          @topology = topology
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# Copyright (C) 2016 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's description changes.
+      #
+      # @since 2.4.0
+      class ServerDescriptionChanged
+
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Topology ] topology The topology.
+        attr_reader :topology
+
+        # @return [ Server::Description ] previous_description The previous server
+        #   description.
+        attr_reader :previous_description
+
+        # @return [ Server::Description ] new_description The new server
+        #   description.
+        attr_reader :new_description
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerDescriptionChanged.new(address, topology, previous, new)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Integer ] topology The topology.
+        # @param [ Server::Description ] previous_description The previous description.
+        # @param [ Server::Description ] new_description The new description.
+        #
+        # @since 2.4.0
+        def initialize(address, topology, previous_description, new_description)
+          @address = address
+          @topology = topology
+          @previous_description = previous_description
+          @new_description = new_description
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# Copyright (C) 2016 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 the server is opening.
+      #
+      # @since 2.4.0
+      class ServerOpening
+
+        # @return [ Address ] address The server address.
+        attr_reader :address
+
+        # @return [ Topology ] topology The topology.
+        attr_reader :topology
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   ServerOpening.new(address)
+        #
+        # @param [ Address ] address The server address.
+        # @param [ Integer ] topology The topology.
+        #
+        # @since 2.4.0
+        def initialize(address, topology)
+          @address = address
+          @topology = topology
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# Copyright (C) 2016 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 the topology changes.
+      #
+      # @since 2.4.0
+      class TopologyChanged
+
+        # @return [ Cluster::Topology ] previous_topology The previous topology.
+        attr_reader :previous_topology
+
+        # @return [ Cluster::Topology ] new_topology The new topology.
+        attr_reader :new_topology
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   TopologyChanged.new(previous, new)
+        #
+        # @param [ Cluster::Topology ] previous_topology The previous topology.
+        # @param [ Cluster::Topology ] new_topology The new topology.
+        #
+        # @since 2.4.0
+        def initialize(previous_topology, new_topology)
+          @previous_topology = previous_topology
+          @new_topology = new_topology
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# Copyright (C) 2016 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 the topology closes.
+      #
+      # @since 2.4.0
+      class TopologyClosed
+
+        # @return [ Topology ] topology The topology.
+        attr_reader :topology
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   TopologyClosed.new(topology)
+        #
+        # @param [ Integer ] topology The topology.
+        #
+        # @since 2.4.0
+        def initialize(topology)
+          @topology = topology
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# Copyright (C) 2016 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 the topology is opening.
+      #
+      # @since 2.4.0
+      class TopologyOpening
+
+        # @return [ Topology ] topology The topology.
+        attr_reader :topology
+
+        # Create the event.
+        #
+        # @example Create the event.
+        #   TopologyOpening.new(topology)
+        #
+        # @param [ Integer ] topology The topology.
+        #
+        # @since 2.4.0
+        def initialize(topology)
+          @topology = topology
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/publishable.rb

@@ -55,6 +55,14 @@ module Mongo
         end
       end
 
+      def publish_event(topic, event)
+        monitoring.succeeded(topic, event)
+      end
+
+      def publish_sdam_event(topic, event)
+        monitoring.succeeded(topic, event) if monitoring?
+      end
+
       private
 
       def command_started(address, operation_id, payload)
@@ -101,6 +109,10 @@ module Mongo
       def error?(document)
         document && (document['ok'] == 0 || document.key?('$err'))
       end
+
+      def monitoring?
+        options[:monitoring] != false
+      end
     end
   end
 end

data/lib/mongo/monitoring/sdam_log_subscriber.rb

@@ -0,0 +1,54 @@
+# Copyright (C) 2016 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
+
+    # Subscribes to SDAM events and logs them.
+    #
+    # @since 2.4.0
+    class SDAMLogSubscriber
+      include Loggable
+
+      # @return [ Hash ] options The options.
+      attr_reader :options
+
+      # Create the new log subscriber.
+      #
+      # @example Create the log subscriber.
+      #   SDAMLogSubscriber.new
+      #
+      # @param [ Hash ] options The options.
+      #
+      # @option options [ Logger ] :logger An optional custom logger.
+      #
+      # @since 2.4.0
+      def initialize(options = {})
+        @options = options
+      end
+
+      # Handle the SDAM succeeded event.
+      #
+      # @example Handle the event.
+      #   subscriber.succeeded(event)
+      #
+      # @param [ Event ] event The event.
+      #
+      # @since 2.4.0
+      def succeeded(event)
+        log_event(event) if logger.debug?
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/server_closed_log_subscriber.rb

@@ -0,0 +1,30 @@
+# Copyright (C) 2016 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
+
+    # Subscribes to Server Closed events and logs them.
+    #
+    # @since 2.4.0
+    class ServerClosedLogSubscriber < SDAMLogSubscriber
+
+      private
+
+      def log_event(event)
+        log_debug("Server #{event.address} connection closed.")
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/server_description_changed_log_subscriber.rb

@@ -0,0 +1,33 @@
+# Copyright (C) 2016 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
+
+    # Subscribes to Server Description Changed events and logs them.
+    #
+    # @since 2.4.0
+    class ServerDescriptionChangedLogSubscriber < SDAMLogSubscriber
+
+      private
+
+      def log_event(event)
+        log_debug(
+          "Server description for #{event.address} changed from " +
+          "'#{event.previous_description.server_type}' to '#{event.new_description.server_type}'."
+        )
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/server_opening_log_subscriber.rb

@@ -0,0 +1,30 @@
+# Copyright (C) 2016 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
+
+    # Subscribes to Server Opening events and logs them.
+    #
+    # @since 2.4.0
+    class ServerOpeningLogSubscriber < SDAMLogSubscriber
+
+      private
+
+      def log_event(event)
+        log_debug("Server #{event.address} initializing.")
+      end
+    end
+  end
+end