mongo_profiler 0.0.1

data/lib/mongo_profiler/profiler.rb

@@ -0,0 +1,4 @@
+module MongoProfiler
+  class Profiler
+  end
+end

data/lib/mongo_profiler/stats.rb

@@ -0,0 +1,25 @@
+module MongoProfiler
+  class Stats
+    def initialize(stats_client)
+      @stats_client = stats_client
+    end
+
+    def populate(_caller, total_time)
+      file   = sanitaze_stat_key _caller.file.split('/').last
+      method = sanitaze_stat_key _caller.method
+
+      stat_name     = "mongo_profiler.#{MongoProfiler.application_name}.#{file}.#{method}"
+
+      total_time_ms = total_time * 1000
+
+      @stats_client.increment stat_name
+      @stats_client.timing    stat_name, total_time_ms
+    end
+
+    private
+
+    def sanitaze_stat_key(key)
+      key.gsub(/\W/, '_')
+    end
+  end
+end

data/lib/mongo_profiler/version.rb

@@ -0,0 +1,3 @@
+module MongoProfiler
+  VERSION = '0.0.1'
+end

data/lib/mongo_profiler/web.rb

@@ -0,0 +1,85 @@
+# https://github.com/mperham/sidekiq/wiki/Monitoring
+require 'erb'
+require 'yaml'
+require 'sinatra/base'
+require 'json'
+
+require 'mongo_profiler/web_helpers'
+
+module MongoProfiler
+  class Web < Sinatra::Base
+
+    set :root,           File.expand_path(File.dirname(__FILE__) + "/../../web")
+    set :public_folder,  Proc.new { "#{root}/assets" }
+    set :views,          Proc.new { "#{root}/views" }
+
+    helpers WebHelpers
+
+
+    get '/' do
+      @profiles = MongoProfiler.collection.
+        group({ key:     %i[method file application_name group_id],
+                reduce:  'function(curr, result) { result.total_time += curr.total_time; result.total += 1 }',
+                initial: { total: 0, total_time: 0 } })
+
+        # group profilers by group_id and sort by created_at DESC
+        @grouped_profiles = @profiles.group_by { |profile| profile['group_id'] }.to_a.reverse
+
+        erb :index
+    end
+
+    post '/profiler/enable' do
+      MongoProfiler.enable!
+
+      redirect to('/')
+    end
+
+    post '/profiler/disable' do
+      MongoProfiler.disable!
+
+      redirect to('/')
+    end
+
+    get '/profiler/groups/:group_id' do
+      @group_id = params[:group_id]
+      @profiles = MongoProfiler.collection.find(group_id: @group_id).to_a
+
+      @sample_profile = @profiles.first
+
+      @profiles_count = @profiles.count
+      @profiles_total_time = @profiles.reduce(0) { |sum, p| sum + p['total_time'] }
+
+      @grouped_profiles = @profiles.group_by { |profile| profile['method'] }
+
+      erb :group_id
+    end
+
+    get '/profiler/:_id' do
+      @profile_id = BSON::ObjectId(params[:_id])
+      @profile = MongoProfiler.collection.find_one(_id: @profile_id)
+      @instrument_payload = JSON.parse(@profile['instrument_payload'])
+
+      @collection_name = @instrument_payload['collection']
+      @selector        = @instrument_payload['selector']
+
+      begin
+        @selector.each_pair do |key, value|
+          if value.is_a? Hash
+            if value.first[0] == '$oid'
+              @selector[key] = BSON::ObjectId(value.first[1])
+            end
+          end
+        end
+        @explain = MongoProfiler.database[@collection_name].find(@selector).explain
+      rescue => e
+        @explain = { error: "Unable to generate explain: #{e.message}" }
+      end
+
+      # http://docs.mongodb.org/manual/core/capped-collections/
+      # You can update documents in a collection after inserting them. However, these updates cannot cause the documents to grow. If the update operation causes the document to grow beyond their original size, the update operation will fail.
+      # If you plan to update documents in a capped collection, create an index so that these update operations do not require a table scan.
+      # MongoRubyProfiler.collection.update({ _id: BSON::ObjectId(params[:_id]) }, '$set' => { explain: explain } )
+      erb :show
+    end
+  end
+end

data/lib/mongo_profiler/web_helpers.rb

@@ -0,0 +1,65 @@
+require 'uri'
+
+module MongoProfiler
+  module WebHelpers
+    def root_path
+      "#{env['SCRIPT_NAME']}/"
+    end
+
+    def graphite_graph_timers_url(profile, from, size, title)
+      file             = profile['file']
+      method           = profile['method']
+      application_name = profile['application_name']
+
+      URI.escape(["#{MongoProfiler.graphite_url}/render?",
+                  "from=#{from}&",
+                  'until=now&width=400&height=250&',
+                  "target=#{graphite_timers_target(application_name, file, method, size)}",
+                  "&title=#{title}"].join)
+    end
+
+    def graphite_graph_count_url(profile, from, size, title)
+      file             = profile['file']
+      method           = profile['method']
+      application_name = profile['application_name']
+
+      URI.escape(["#{MongoProfiler.graphite_url}/render?",
+                  "from=#{from}&",
+                  'until=now&width=400&height=250&',
+                  "target=#{graphite_count_target(application_name, file, method, size)}",
+                  "&title=#{title}"].join)
+    end
+
+    def print_backtrace_entry(entry)
+      if entry.include?('gem/ruby') || entry.include?('rubies/ruby') || entry.include?('bundle/ruby')
+        entry
+      else
+        %{<span class="btn-info">#{entry}</span>}
+      end
+    end
+
+    private
+
+    def graphite_timers_target(application_name, file, method, size)
+      file       = file.split('/').last
+      file_key   = sanitaze_stat_key(file)
+      method_key = sanitaze_stat_key(method)
+
+      "alias(summarize(stats.timers.#{MongoProfiler.stats_prefix}mongo_profiler.#{application_name}.#{file_key}.#{method_key}.mean, '#{size}', 'mean'), '#{file}##{method}')"
+    end
+
+    def graphite_count_target(application_name, file, method, size)
+      file       = file.split('/').last
+      file_key   = sanitaze_stat_key(file)
+      method_key = sanitaze_stat_key(method)
+
+      binding.pry
+
+      "alias(summarize(stats_counts.#{MongoProfiler.stats_prefix}mongo_profiler.#{application_name}.#{file_key}.#{method_key}, '#{size}', 'sum'), '#{file}##{method}')"
+    end
+
+    def sanitaze_stat_key(key)
+      key.gsub(/\W/, '_')
+    end
+  end
+end

data/mongo_profiler.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo_profiler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongo_profiler"
+  spec.version       = MongoProfiler::VERSION
+  spec.authors       = ["Pablo Cantero"]
+  spec.email         = ["pablo@pablocantero.com"]
+  spec.summary       = %q{Ruby profiling tool for MongoDB}
+  spec.description   = %q{A Ruby profiling tool for MongoDB}
+  spec.homepage      = "https://github.com/phstc/mongo_profiler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mongo", "1.9.2"
+  spec.add_development_dependency "bson_ext"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "shotgun"
+  spec.add_development_dependency "rack-test"
+end

data/spec/mongo_profiler/caller_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+module MongoProfiler
+  describe Caller do
+    subject { described_class.new(_caller) }
+
+    let(:_caller) {
+      [
+        "/Users/pablo/workspace/project/spec/mongo_profiler_spec.rb:7:in `new'",
+        "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+        "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `fetch'",
+        "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block in let'"
+      ]
+    }
+
+    its(:file)    { should end_with('project/spec/mongo_profiler_spec.rb') }
+    its(:line)    { should eq 7 }
+    its(:method)  { should eq 'new' }
+    its(:_caller) { should eq _caller }
+
+    context 'when stacktrace starts with bundle or gem' do
+      let(:_caller) {
+        [
+          "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+          "/Users/pablo/bundle/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+          "/Users/pablo/workspace/project/spec/mongo_profiler_spec.rb:7:in `new'",
+          "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `fetch'",
+          "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block in let'"
+        ]
+      }
+
+      its(:file)    { should end_with('project/spec/mongo_profiler_spec.rb') }
+      its(:line)    { should eq 7 }
+      its(:method)  { should eq 'new' }
+      its(:_caller) { should eq _caller }
+    end
+
+    describe '#mongo_profiler_caller' do
+
+      context 'when mongo_profiler' do
+        let(:_caller) {
+          [
+            "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+            "/Users/pablo/bundle/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+            "/Users/pablo/workspace/project/spec/mongo_profiler.rb:7:in `new'",
+            "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `fetch'",
+            "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block in let'"
+          ]
+        }
+
+        its(:mongo_profiler_caller?) { should be_true }
+
+        context 'when _spec' do
+          let(:_caller) {
+            [
+              "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+              "/Users/pablo/bundle/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+              "/Users/pablo/workspace/project/spec/mongo_profiler_spec.rb:7:in `new'",
+              "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `fetch'",
+              "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block in let'"
+            ]
+          }
+
+          its(:mongo_profiler_caller?) { should be_false }
+        end
+      end
+
+      context 'when external' do
+        let(:_caller) {
+          [
+            "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+            "/Users/pablo/bundle/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block (2 levels) in let'",
+            "/Users/pablo/workspace/project/file.rb:7:in `new'",
+            "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `fetch'",
+            "/Users/pablo/.gem/ruby/2.0.0/gems/rspec-core-2.14.4/lib/rspec/core/memoized_helpers.rb:199:in `block in let'"
+          ]
+        }
+
+        its(:mongo_profiler_caller?) { should be_false }
+      end
+    end
+  end
+end

data/spec/mongo_profiler/extensions/mongo/cursor_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Mongo::Cursor' do
+  let(:collection) { COLL }
+
+  describe '#send_initial_query' do
+    context 'when enabled' do
+      let(:stats_client) { double('StatsD client').as_null_object }
+
+      before do
+        MongoProfiler.enable!
+
+        MongoProfiler.stats_client = stats_client
+      end
+
+      it 'populate stats' do
+        expect(stats_client).to receive(:increment).with(any_args)
+        expect(stats_client).to receive(:timing).with(any_args)
+
+        collection.find_one
+      end
+
+      it 'creates a profiler entry' do
+        expect {
+          collection.insert(test: 'test')
+          expect(collection.find_one['test']).to eq 'test'
+        }.to change { MongoProfiler.collection.count }.by(1)
+      end
+    end
+
+    context 'when disabled' do
+      before { MongoProfiler.disable! }
+
+      it 'skips profiler entry' do
+        expect {
+          collection.insert(test: 'test')
+          expect(collection.find_one['test']).to eq 'test'
+        }.to_not change { MongoProfiler.collection.count }
+      end
+    end
+  end
+end

data/spec/mongo_profiler/payload_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+module MongoProfiler
+  describe Payload do
+    subject { described_class.new(payload) }
+
+    describe '#system_database?' do
+      context 'when admin' do
+        let(:payload) { { database: 'admin' } }
+
+        its(:system_database?) { should be_true }
+      end
+
+      context 'when system' do
+        let(:payload) { { database: 'system' } }
+
+        its(:system_database?) { should be_true }
+      end
+
+      context 'when other' do
+        let(:payload) { { database: 'other' } }
+
+        its(:system_database?) { should be_false }
+      end
+    end
+
+    describe '#system_collection?' do
+      context 'when admin' do
+        let(:payload) { { collection: 'mongo_profiler' } }
+
+        its(:system_collection?) { should be_true }
+      end
+
+      context 'when system' do
+        let(:payload) { { collection: 'system' } }
+
+        its(:system_collection?) { should be_true }
+      end
+
+      context 'when other' do
+        let(:payload) { { collection: 'other' } }
+
+        its(:system_collection?) { should be_false }
+      end
+    end
+
+    describe '#system_count?' do
+      context 'when admin' do
+        let(:payload) { { selector: { count: 'mongo_profiler' } } }
+
+        its(:system_count?) { should be_true }
+      end
+
+      context 'when system' do
+        let(:payload) { { selector: { count: 'system' } } }
+
+        its(:system_count?) { should be_true }
+      end
+
+      context 'when other' do
+        let(:payload) { { selector: { count: 'other' } } }
+
+        its(:system_count?) { should be_false }
+      end
+    end
+
+    describe '#system_distinct?' do
+      context 'when admin' do
+        let(:payload) { { selector: { distinct: 'mongo_profiler' } } }
+
+        its(:system_distinct?) { should be_true }
+      end
+
+      context 'when system' do
+        let(:payload) { { selector: { distinct: 'system' } } }
+
+        its(:system_distinct?) { should be_true }
+      end
+
+      context 'when other' do
+        let(:payload) { { selector: { distinct: 'other' } } }
+
+        its(:system_distinct?) { should be_false }
+      end
+    end
+
+    describe '#system_command?' do
+      context 'when count' do
+        let(:payload) { { collection:  '$cmd', selector: { count: 'something' } } }
+
+        its(:system_command?) { should be_false }
+      end
+
+      context 'when distinct' do
+        let(:payload) { { collection:  '$cmd', selector: { distinct: 'something' } } }
+
+        its(:system_command?) { should be_false }
+      end
+
+      context 'when other' do
+        let(:payload) { { collection:  '$cmd', selector: { getnonce: -1 } } }
+
+        its(:system_command?) { should be_true }
+      end
+    end
+
+    describe '#system_any?' do
+      pending
+    end
+  end
+end