mongo 2.0.6 → 2.1.0.beta

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

@@ -0,0 +1,88 @@
+# Copyright (C) 2015 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 that is fired when a command operation starts.
+      #
+      # @since 2.1.0
+      class CommandStarted
+
+        # @return [ Server::Address ] address The server address.
+        attr_reader :address
+
+        # @return [ BSON::Document ] command The command arguments.
+        attr_reader :command
+
+        # @return [ String ] command_name The name of the command.
+        attr_reader :command_name
+
+        # @return [ String ] database_name The name of the database_name.
+        attr_reader :database_name
+
+        # @return [ Integer ] operation_id The operation id.
+        attr_reader :operation_id
+
+        # @return [ Integer ] request_id The request id.
+        attr_reader :request_id
+
+        # Create the new event.
+        #
+        # @example Create the event.
+        #
+        # @param [ String ] command_name The name of the command.
+        # @param [ String ] database_name The database_name name.
+        # @param [ Server::Address ] address The server address.
+        # @param [ Integer ] request_id The request id.
+        # @param [ Integer ] operation_id The operation id.
+        # @param [ BSON::Document ] command The command arguments.
+        #
+        # @since 2.1.0
+        def initialize(command_name, database_name, address, request_id, operation_id, command)
+          @command_name = command_name
+          @database_name = database_name
+          @address = address
+          @request_id = request_id
+          @operation_id = operation_id
+          @command = command
+        end
+
+        # Create the event from a wire protocol message payload.
+        #
+        # @example Create the event.
+        #   CommandStarted.generate(address, 1, payload)
+        #
+        # @param [ Server::Address ] address The server address.
+        # @param [ Integer ] operation_id The operation id.
+        # @param [ Hash ] payload The message payload.
+        #
+        # @return [ CommandStarted ] The event.
+        #
+        # @since 2.1.0
+        def self.generate(address, operation_id, payload)
+          new(
+            payload[:command_name],
+            payload[:database_name],
+            address,
+            payload[:request_id],
+            operation_id,
+            payload[:command]
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# Copyright (C) 2015 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 that is fired when a command operation succeeds.
+      #
+      # @since 2.1.0
+      class CommandSucceeded
+
+        # @return [ Server::Address ] address The server address.
+        attr_reader :address
+
+        # @return [ String ] command_name The name of the command.
+        attr_reader :command_name
+
+        # @return [ BSON::Document ] reply The command reply.
+        attr_reader :reply
+
+        # @return [ String ] database_name The name of the database.
+        attr_reader :database_name
+
+        # @return [ Float ] duration The duration of the event.
+        attr_reader :duration
+
+        # @return [ Integer ] operation_id The operation id.
+        attr_reader :operation_id
+
+        # @return [ Integer ] request_id The request id.
+        attr_reader :request_id
+
+        # Create the new event.
+        #
+        # @example Create the event.
+        #
+        # @param [ String ] command_name The name of the command.
+        # @param [ String ] database_name The database name.
+        # @param [ Server::Address ] address The server address.
+        # @param [ Integer ] request_id The request id.
+        # @param [ Integer ] operation_id The operation id.
+        # @param [ BSON::Document ] reply The command reply.
+        # @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, reply, duration)
+          @command_name = command_name
+          @database_name = database_name
+          @address = address
+          @request_id = request_id
+          @operation_id = operation_id
+          @reply = reply
+          @duration = duration
+        end
+
+        # Create the event from a wire protocol message payload.
+        #
+        # @example Create the event.
+        #   CommandSucceeded.generate(address, 1, command_payload, reply_payload, 0.5)
+        #
+        # @param [ Server::Address ] address The server address.
+        # @param [ Integer ] operation_id The operation id.
+        # @param [ Hash ] command_payload The command message payload.
+        # @param [ Hash ] reply_payload The reply message payload.
+        # @param [ Float ] duration The duration of the command in seconds.
+        #
+        # @return [ CommandCompleted ] The event.
+        #
+        # @since 2.1.0
+        def self.generate(address, operation_id, command_payload, reply_payload, duration)
+          new(
+            command_payload[:command_name],
+            command_payload[:database_name],
+            address,
+            command_payload[:request_id],
+            operation_id,
+            reply_payload ? reply_payload[:reply] : nil,
+            duration
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/publishable.rb

@@ -0,0 +1,96 @@
+# Copyright (C) 2015 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
+
+    # Defines behaviour for an object that can publish monitoring events.
+    #
+    # @since 2.1.0
+    module Publishable
+
+      # @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
+        payload = messages.first.payload
+        command_started(address, operation_id, payload)
+        begin
+          result = yield(messages)
+          command_completed(result, address, operation_id, payload, start)
+          result
+        rescue Exception => e
+          command_failed(address, operation_id, payload, e.message, start)
+          raise e
+        end
+      end
+
+      private
+
+      def command_started(address, operation_id, payload)
+        monitoring.started(
+          Monitoring::COMMAND,
+          Event::CommandStarted.generate(address, operation_id, payload)
+        )
+      end
+
+      def command_completed(result, address, operation_id, payload, start)
+        document = result ? (result.documents || []).first : nil
+        parser = Error::Parser.new(document)
+        if parser.message.empty?
+          command_succeeded(result, address, operation_id, payload, start)
+        else
+          command_failed(address, operation_id, payload, parser.message, start)
+        end
+      end
+
+      def command_succeeded(result, address, operation_id, payload, start)
+        monitoring.succeeded(
+          Monitoring::COMMAND,
+          Event::CommandSucceeded.generate(
+            address,
+            operation_id,
+            payload,
+            result ? result.payload : nil,
+            duration(start)
+          )
+        )
+      end
+
+      def command_failed(address, operation_id, payload, message, start)
+        monitoring.failed(
+          Monitoring::COMMAND,
+          Event::CommandFailed.generate(address, operation_id, payload, message, duration(start))
+        )
+      end
+
+      def duration(start)
+        Time.now - start
+      end
+    end
+  end
+end

data/lib/mongo/operation.rb

@@ -23,3 +23,4 @@ require 'mongo/operation/aggregate'
 require 'mongo/operation/command'
 require 'mongo/operation/kill_cursors'
 require 'mongo/operation/map_reduce'
+require 'mongo/operation/parallel_scan'

data/lib/mongo/operation/executable.rb

@@ -32,7 +32,7 @@ module Mongo
       # @since 2.0.0
       def execute(context)
         context.with_connection do |connection|
-          connection.dispatch([ message ])
+          connection.dispatch([ message ], operation_id)
         end
       end
 

data/lib/mongo/operation/parallel_scan.rb

@@ -0,0 +1,76 @@
+# Copyright (C) 2009-2014 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.
+
+require 'mongo/operation/parallel_scan/result'
+
+module Mongo
+  module Operation
+
+    # A MongoDB parallel scan operation.
+    #
+    # @example Create the parallel scan operation.
+    #   ParallelScan.new({
+    #     :db_name  => 'test_db',
+    #     :coll_name = > 'test_collection',
+    #     :cursor_count => 5
+    #   })
+    #
+    # Initialization:
+    #   param [ Hash ] spec The specifications for the operation.
+    #
+    #   option spec :db_name [ String ] The name of the database on which
+    #     the operation should be executed.
+    #   option spec :coll_name [ String ] The collection to scan.
+    #   option spec :cursor_count [ Integer ] The number of cursors to use.
+    #   option spec :options [ Hash ] Options for the command.
+    #
+    # @since 2.0.0
+    class ParallelScan
+      include Executable
+      include Specifiable
+      include Limited
+      include ReadPreferrable
+
+      # Execute the parallel scan operation.
+      #
+      # @example Execute the operation.
+      #   operation.execute(context)
+      #
+      # @param [ Mongo::Server::Context ] context The context for this operation.
+      #
+      # @return [ Result ] The operation response, if there is one.
+      #
+      # @since 2.0.0
+      def execute(context)
+        execute_message(context)
+      end
+
+      private
+
+      def execute_message(context)
+        context.with_connection do |connection|
+          Result.new(connection.dispatch([ message(context) ])).validate!
+        end
+      end
+
+      def selector
+        { :parallelCollectionScan => coll_name, :numCursors => cursor_count }
+      end
+
+      def query_coll
+        Database::COMMAND
+      end
+    end
+  end
+end

data/lib/mongo/operation/parallel_scan/result.rb

@@ -0,0 +1,72 @@
+
+# Copyright (C) 2009-2014 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
+  module Operation
+    class ParallelScan
+
+      # Defines custom behaviour of results in a parallel scan.
+      #
+      # @since 2.0.0
+      class Result < Operation::Result
+
+        # Get the name of the cursor field.
+        #
+        # @since 2.0.0
+        CURSOR = 'cursor'.freeze
+
+        # The name of the cursors field in the result.
+        #
+        # @since 2.0.0
+        CURSORS = 'cursors'.freeze
+
+        # Get the name of the id field.
+        #
+        # @since 2.0.0
+        ID = 'id'.freeze
+
+        # Get all the cursor ids from the result.
+        #
+        # @example Get the cursor ids.
+        #   result.cursor_ids
+        #
+        # @return [ Array<Integer> ] The cursor ids.
+        #
+        # @since 2.0.0
+        def cursor_ids
+          documents.map{ |doc| doc[CURSOR][ID] }
+        end
+
+        # Get the documents from parallel scan.
+        #
+        # @example Get the documents.
+        #   result.documents
+        #
+        # @return [ Array<BSON::Document> ] The documents.
+        #
+        # @since 2.0.0
+        def documents
+          reply.documents[0][CURSORS]
+        end
+
+        private
+
+        def first
+          @first ||= reply.documents[0] || {}
+        end
+      end
+    end
+  end
+end