mongo 2.0.6 → 2.1.0.beta

data/lib/mongo/error.rb

@@ -43,11 +43,16 @@ module Mongo
     # @since 2.0.0
     WRITE_ERRORS = 'writeErrors'.freeze
 
-    # The constant for write concern errors.
+    # The constant for a write concern error.
     #
     # @since 2.0.0
     WRITE_CONCERN_ERROR = 'writeConcernError'.freeze
 
+    # The constant for write concern errors.
+    #
+    # @since 2.1.0
+    WRITE_CONCERN_ERRORS = 'writeConcernErrors'.freeze
+
     # Constant for an unknown error.
     #
     # @since 2.0.0
@@ -75,7 +80,6 @@ require 'mongo/error/invalid_server_preference'
 require 'mongo/error/invalid_signature'
 require 'mongo/error/invalid_update_document'
 require 'mongo/error/invalid_uri'
-require 'mongo/error/invalid_uri_option'
 require 'mongo/error/max_bson_size'
 require 'mongo/error/max_message_size'
 require 'mongo/error/multi_index_drop'

data/lib/mongo/error/parser.rb

@@ -36,7 +36,7 @@ module Mongo
       #
       # @since 2.0.0
       def initialize(document)
-        @document = document
+        @document = document || {}
         parse!
       end
 

data/lib/mongo/event/description_changed.rb

@@ -42,7 +42,7 @@ module Mongo
       # @example Handle the event.
       #   server_added.handle('127.0.0.1:27018')
       #
-      # @param [ Address ] address The added host.
+      # @param [ Server::Description ] updated The changed description.
       #
       # @since 2.0.0
       def handle(updated)

data/lib/mongo/grid/file.rb

@@ -30,7 +30,7 @@ module Mongo
       # @return [ Array<Chunk> ] chunks The file chunks.
       attr_reader :chunks
 
-      # @return [ IO ] data The raw datafor the file.
+      # @return [ IO ] data The raw data for the file.
       attr_reader :data
 
       # @return [ Metadata ] metadata The file metadata.

data/lib/mongo/grid/fs.rb

@@ -70,15 +70,12 @@ module Mongo
       #
       # @param [ Grid::File ] file The file to insert.
       #
-      # @return [ Result ] The result of the insert.
+      # @return [ BSON::ObjectId ] The file id.
       #
       # @since 2.0.0
       def insert_one(file)
         files_collection.insert_one(file.metadata)
-        inserts = file.chunks.reduce([]) do |ops, chunk|
-          ops << { :insert_one => chunk }
-        end
-        result = chunks_collection.bulk_write(inserts, ordered: true)
+        result = chunks_collection.insert_many(file.chunks)
         validate_md5!(file) if write_concern.get_last_error
         file.id
       end

data/lib/mongo/monitoring.rb

@@ -0,0 +1,199 @@
+# 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.
+
+require 'mongo/monitoring/event'
+require 'mongo/monitoring/publishable'
+require 'mongo/monitoring/command_log_subscriber'
+
+module Mongo
+
+  # The class defines behaviour for the performance monitoring API.
+  #
+  # @since 2.1.0
+  class Monitoring
+
+    # The command topic.
+    #
+    # @since 2.1.0
+    COMMAND = 'Command'.freeze
+
+    @@operation_id = 0
+    @@operation_id_lock = Mutex.new
+
+    # Used for generating unique operation ids to link events together.
+    #
+    # @example Get the next operation id.
+    #   Monitoring.next_operation_id
+    #
+    # @return [ Integer ] The next operation id.
+    #
+    # @since 2.1.0
+    def self.next_operation_id
+      @@operation_id_lock.synchronize do
+        @@operation_id += 1
+      end
+    end
+
+    # Provides behaviour around global subscribers.
+    #
+    # @since 2.1.0
+    module Global
+      extend self
+
+      # Subscribe a listener to an event topic.
+      #
+      # @example Subscribe to the topic.
+      #   Monitoring::Global.subscribe(QUERY, subscriber)
+      #
+      # @param [ String ] topic The event topic.
+      # @param [ Object ] subscriber The subscriber to handle the event.
+      #
+      # @since 2.1.0
+      def subscribe(topic, subscriber)
+        subscribers_for(topic).push(subscriber)
+      end
+
+      # Get all the global subscribers.
+      #
+      # @example Get all the global subscribers.
+      #   Monitoring::Global.subscribers
+      #
+      # @return [ Hash<String, Object> ] The subscribers.
+      #
+      # @since 2.1.0
+      def subscribers
+        @subscribers ||= {}
+      end
+
+      private
+
+      def subscribers_for(topic)
+        subscribers[topic] ||= []
+      end
+    end
+
+    # Adds our internal command logging to the global subscribers.
+    #
+    # @since 2.1.0
+    Global.subscribe(COMMAND, CommandLogSubscriber.new)
+
+    # Initialize the monitoring.
+    #
+    # @api private
+    #
+    # @example Create the new monitoring.
+    #   Monitoring.new(:monitoring => true)
+    #
+    # @param [ Hash ] options The options.
+    #
+    # @since 2.1.0
+    def initialize(options = {})
+      if options[:monitoring] != false
+        Global.subscribers.each do |topic, subscribers|
+          subscribers.each do |subscriber|
+            subscribe(topic, subscriber)
+          end
+        end
+      end
+    end
+
+    # Publish a started event.
+    #
+    # @example Publish a started event.
+    #   monitoring.started(COMMAND, event)
+    #
+    # @param [ String ] topic The event topic.
+    # @param [ Event ] event The event to publish.
+    #
+    # @since 2.1.0
+    def started(topic, event)
+      subscribers_for(topic).each{ |subscriber| subscriber.started(event) }
+    end
+
+    # Publish a succeeded event.
+    #
+    # @example Publish a succeeded event.
+    #   monitoring.succeeded(COMMAND, event)
+    #
+    # @param [ String ] topic The event topic.
+    # @param [ Event ] event The event to publish.
+    #
+    # @since 2.1.0
+    def succeeded(topic, event)
+      subscribers_for(topic).each{ |subscriber| subscriber.succeeded(event) }
+    end
+
+    # Publish a failed event.
+    #
+    # @example Publish a failed event.
+    #   monitoring.failed(COMMAND, event)
+    #
+    # @param [ String ] topic The event topic.
+    # @param [ Event ] event The event to publish.
+    #
+    # @since 2.1.0
+    def failed(topic, event)
+      subscribers_for(topic).each{ |subscriber| subscriber.failed(event) }
+    end
+
+    # Subscribe a listener to an event topic.
+    #
+    # @example Subscribe to the topic.
+    #   monitoring.subscribe(QUERY, subscriber)
+    #
+    # @param [ String ] topic The event topic.
+    # @param [ Object ] subscriber The subscriber to handle the event.
+    #
+    # @since 2.1.0
+    def subscribe(topic, subscriber)
+      subscribers_for(topic).push(subscriber)
+    end
+
+    # Get all the subscribers.
+    #
+    # @example Get all the subscribers.
+    #   monitoring.subscribers
+    #
+    # @return [ Hash<String, Object> ] The subscribers.
+    #
+    # @since 2.1.0
+    def subscribers
+      @subscribers ||= {}
+    end
+
+    # Determine if there are any subscribers for a particular event.
+    #
+    # @example Are there subscribers?
+    #   monitoring.subscribers?(COMMAND)
+    #
+    # @param [ String ] topic The event topic.
+    #
+    # @return [ true, false ] If there are subscribers for the topic.
+    #
+    # @since 2.1.0
+    def subscribers?(topic)
+      !subscribers_for(topic).empty?
+    end
+
+    private
+
+    def initialize_copy(original)
+      @subscribers = original.subscribers.dup
+    end
+
+    def subscribers_for(topic)
+      subscribers[topic] ||= []
+    end
+  end
+end

data/lib/mongo/monitoring/command_log_subscriber.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
+
+    # Subscribes to command events and logs them.
+    #
+    # @since 2.1.0
+    class CommandLogSubscriber
+
+      # Constant for the max number of characters to print when inspecting
+      # a query field.
+      #
+      # @since 2.1.0
+      LOG_STRING_LIMIT = 250
+
+      # Handle the command started event.
+      #
+      # @example Handle the event.
+      #   subscriber.started(event)
+      #
+      # @param [ CommandStartedEvent ] event The event.
+      #
+      # @since 2.1.0
+      def started(event)
+        if Logger.logger.debug?
+          log("#{prefix(event)} | STARTED | #{format(event.command)}")
+        end
+      end
+
+      # Handle the command succeeded event.
+      #
+      # @example Handle the event.
+      #   subscriber.succeeded(event)
+      #
+      # @param [ CommandSucceededEvent ] event The event.
+      #
+      # @since 2.1.0
+      def succeeded(event)
+        if Logger.logger.debug?
+          log("#{prefix(event)} | SUCCEEDED | #{event.duration}s")
+        end
+      end
+
+      # Handle the command failed event.
+      #
+      # @example Handle the event.
+      #   subscriber.failed(event)
+      #
+      # @param [ CommandFailedEvent ] event The event.
+      #
+      # @since 2.1.0
+      def failed(event)
+        if Logger.logger.debug?
+          log("#{prefix(event)} | FAILED | #{event.message} | #{event.duration}s")
+        end
+      end
+
+      private
+
+      def format(args)
+        ((s = args.inspect).length > LOG_STRING_LIMIT) ? "#{s[0..LOG_STRING_LIMIT]}..." : s
+      rescue ArgumentError
+        '<Unable to inspect arguments>'
+      end
+
+      def log(message)
+        Logger.logger.debug(message)
+      end
+
+      def prefix(event)
+        "MONGODB | #{event.address.to_s} | #{event.database_name}.#{event.command_name}"
+      end
+    end
+  end
+end

data/lib/mongo/monitoring/event.rb

@@ -0,0 +1,17 @@
+# 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.
+
+require 'mongo/monitoring/event/command_started'
+require 'mongo/monitoring/event/command_succeeded'
+require 'mongo/monitoring/event/command_failed'

data/lib/mongo/monitoring/event/command_failed.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 fails.
+      #
+      # @since 2.1.0
+      class CommandFailed
+
+        # @return [ Server::Address ] address The server address.
+        attr_reader :address
+
+        # @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 [ Float ] duration The duration of the command in seconds.
+        attr_reader :duration
+
+        # @return [ String ] message The error message.
+        attr_reader :message
+
+        # @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 [ String ] message The error message.
+        # @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
+          @database_name = database_name
+          @address = address
+          @request_id = request_id
+          @operation_id = operation_id
+          @message = message
+          @duration = duration
+        end
+
+        # Create the event from a wire protocol message payload.
+        #
+        # @example Create the event.
+        #   CommandFailed.generate(address, 1, payload, duration)
+        #
+        # @param [ Server::Address ] address The server address.
+        # @param [ Integer ] operation_id The operation id.
+        # @param [ Hash ] payload The message payload.
+        # @param [ String ] message The error message.
+        # @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)
+          new(
+            payload[:command_name],
+            payload[:database_name],
+            address,
+            payload[:request_id],
+            operation_id,
+            message,
+            duration
+          )
+        end
+      end
+    end
+  end
+end