mongo_missing_indexes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 656e0d6771c56d4c4b8bd70eab09552ce06a296f
+  data.tar.gz: 7105302316c6d969f58228c60ac7f6c9ec62c1d3
+SHA512:
+  metadata.gz: 9285f24c056e4a512dbbd1cc834803f95008cebdefd52dfc660e26bab16d73da3120e9ebee31cfd136631b93d96ce4a4884a6b9b3834ab0dd968178fc8cbc93d
+  data.tar.gz: 432e05595fabd774a97d96d82f4a58fc5fbbb8ccd6b904508555fe0d6d61b4e3dafdebc9dbd33aa9e9c4b029c78746723a4c0d0377c6ed038ee86d5d1bcd6c4e

data/lib/mongo/missing_indexes.rb

@@ -0,0 +1,94 @@
+require 'mongo'
+require 'logger'
+require 'colored'
+require 'securerandom'
+
+class Mongo::MissingIndexes
+  class << self
+    def reset!
+      remove_instance_variable(:@logger) if defined?(@logger)
+      remove_instance_variable(:@enabled) if defined?(@enabled)
+    end
+
+    def enabled=(val)
+      @enabled = val
+
+      [
+        :find,
+        :count,
+        :update,
+      ].each do |method_name|
+        if @enabled
+          Mongo::Collection.class_eval <<-HERE, __FILE__, __LINE__
+            unless instance_methods.include?(:#{method_name}_aliased_from_missing_indexes)
+              alias_method :#{method_name}_aliased_from_missing_indexes, :#{method_name}
+
+              def #{method_name}(*args, &block)
+                #{method_name}_aliased_from_missing_indexes(*args, &block).tap do
+                  Mongo::MissingIndexes.instrument_database(self, :#{method_name}, *args, &block)
+                end
+              end
+            end
+          HERE
+        else
+          Mongo::Collection.class_eval <<-HERE, __FILE__, __LINE__
+            if instance_methods.include?(:#{method_name}_aliased_from_missing_indexes)
+              alias_method :#{method_name}, :#{method_name}_aliased_from_missing_indexes
+              undef_method :#{method_name}_aliased_from_missing_indexes
+            end
+          HERE
+        end
+      end
+    end
+
+    def enabled?
+      @enabled
+    end
+
+    def logger
+      defined?(@logger) ?
+        @logger :
+        @logger ||= defined?(Rails) ? Rails.logger : nil
+    end
+
+    attr_writer :logger
+
+    def instrument_database(collection, method_name, *args, &block)
+      if !logger
+        raise "Must provide a logger"
+      end
+
+      if method_name == :update
+        explain_method_name = :find
+        explain_args = [args[0]]
+      else
+        return if method_name == :find && args[0] == nil
+        explain_method_name = :find
+        explain_args = args
+      end
+
+      explain = collection.send("#{explain_method_name}_aliased_from_missing_indexes", *explain_args, &block).explain
+      non_index_query = false
+
+      if explain['stats']
+        if explain['stats']['type'] == "COLLSCAN"
+          non_index_query = true
+        end
+      elsif explain['queryPlanner']
+        if explain['queryPlanner']['winningPlan']['stage'] == "COLLSCAN"
+          non_index_query = true
+        end
+      end
+
+      if non_index_query
+        query_id = SecureRandom.uuid
+
+        logger.info("#{query_id} - unindexed query: #{collection.name}.#{method_name}(#{args.map { |a| a.inspect }.join(", ")})".red)
+        logger.info("#{query_id} -  Query backtrace:".yellow)
+        caller.map(&:to_s).each do |line|
+          logger.info("#{query_id} -    #{line}".yellow)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: mongo_missing_indexes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Scott Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies: []
+description: Detect missing indexes in mongo queries
+email: scott@railsnewbie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongo/missing_indexes.rb
+homepage: http://github.com/GoLearnUp/mongo_missing_indexes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Detect missing indexes in mongo queries
+test_files: []