mongo_profiler 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a47fc67c8b76da256d794a635b3e719f783664aa
-  data.tar.gz: 19b951a31adeebadf0e38de08b2768bac0111e58
+  metadata.gz: 04925894971f5f727c372d5dd4ec179e79dcc246
+  data.tar.gz: 10b9bee77caae6de62421c7bb8c79750f22a1f41
 SHA512:
-  metadata.gz: 8835e0823b0f5b7b008dc714178a3e4412bcc36f6d00eb2eb4b49f1b71fa70f143bc2f261e88bb8b8a9e66cfc5db0514d7c752f6d5407daa5064d1f5080a99f3
-  data.tar.gz: 4889bf3ffe0465f163b0a13d977747956d2df0c61f3ece6ff38cabdcedef770195768350f7140147209e7c4eed2c262b9a672f3ec27a3e112c8a1e7fbc51a260
+  metadata.gz: 12eeac08756764921bda0217f9133908dea3eaf9517adb6fee25007a44d3e26fee101491ea754f8555ed10632eafed30b49c766b2538042137a5543d70959ff0
+  data.tar.gz: 996ca8d034bc9469b62b0eac7d6c407d6820b0afed3a36b8bb0dab5114cd17dcfe58bd5a8a0a6ef1c0ab73b653e231f7011f345c71720849373b08f28112c577

data/.gitignore

@@ -1 +1,22 @@
-web/assets/bower_components
+*#*
+*.bundle
+*.class
+*.gem
+*.log
+*.o
+*.pid
+*.so
+*.swp
+*~
+.DS_Store
+.idea/*
+.yardoc
+coverage
+data
+doc
+Gemfile.lock
+.ruby-gemset
+.ruby-version
+gem-private_key.pem
+nbproject
+tmp

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.0.0
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+
+script: bundle exec rspec spec
+
+services:
+  - mongodb

data/Gemfile.lock

@@ -1,35 +1,47 @@
 PATH
   remote: .
   specs:
-    mongo_profiler (0.0.1)
+    mongo_profiler (0.0.2)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.0.2)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
+      builder (~> 3.1)
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    atomic (1.1.14)
-    bson (1.9.2)
-    bson_ext (1.9.2)
-      bson (~> 1.9.2)
+      tzinfo (~> 1.1)
+    bson (2.3.0)
+    builder (3.2.2)
     byebug (2.5.0)
       columnize (~> 0.3.6)
       debugger-linecache (~> 1.2.0)
     coderay (1.1.0)
     columnize (0.3.6)
+    connection_pool (2.0.0)
+    database_cleaner (1.3.0)
     debugger-linecache (1.2.0)
     diff-lcs (1.2.5)
-    i18n (0.6.9)
+    i18n (0.6.11)
+    json (1.8.1)
     method_source (0.8.2)
-    minitest (4.7.5)
-    mongo (1.9.2)
-      bson (~> 1.9.2)
-    multi_json (1.8.4)
+    minitest (5.4.1)
+    mongoid (4.0.0)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    moped (2.0.0)
+      bson (~> 2.2)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    optionable (0.2.0)
+    origin (2.1.1)
     pry (0.9.12.4)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -58,18 +70,18 @@ GEM
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     slop (3.4.7)
-    thread_safe (0.1.3)
-      atomic
+    thread_safe (0.3.4)
     tilt (1.4.1)
-    tzinfo (0.3.38)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bson_ext
-  mongo (= 1.9.2)
+  database_cleaner
   mongo_profiler!
+  mongoid
   pry-byebug
   rack-test
   rake

data/README.md

@@ -1,112 +1,101 @@
 # Mongo Profiler
 
-Database profiling tools are awesome and always useful. I love [Mongo Profiling](http://docs.mongodb.org/manual/tutorial/manage-the-database-profiler/). But unfortunately these tools don't match queries and code they are profiling, so sometimes isn't easy to match where the slow queries are performed.
+[![Build Status](https://travis-ci.org/phstc/mongo_profiler.svg)](https://travis-ci.org/phstc/mongo_profiler)
 
-The Mongo Profiler is a <del>refinement</del> patch in the [mongo-ruby-driver](https://github.com/mongodb/mongo-ruby-driver) to log all execute queries and their respective callers in a [capped collections](http://docs.mongodb.org/manual/core/capped-collections/).
+**Mongo profiling tool which matches queries with code**
 
-It isn't competitor for the Mongo's built-in profiling, it is just a complementary tool to help us to profile our queries.
+Database profiling tools are awesome and always useful. I love [Mongo profiling](http://docs.mongodb.org/manual/tutorial/manage-the-database-profiler/). But unfortunately these tools don't match the queries with the source code they are profiling, making hard to find where the slow queries are executed.
 
-An interesting feature in the Mongo Profiler is that we can group queries by "life cycles". For example, in a web application it can be the `request_id`, so you will be able to see how many queries, how long did they take, the explain plans etc for a specific request.
+The Mongo Profiler is a <del>refinement</del> patch in the [moped driver](https://github.com/mongoid/moped) to log all executed queries and their respective callers ([Ruby backtrace](http://www.ruby-doc.org/core-2.1.1/Kernel.html#method-i-caller)).
 
-First time I used it, I was shocked to see some pages doing lot of duplicated queries, even though some were really fast, they were unnecessary, I could get rid of some of them just by "memorising" some documents.
+It isn't replacement for the Mongo's built-in profiling, it is just a complementary tool to profile the queries with their respective source code.
+
+An interesting feature in the Mongo Profiler is that we can group queries by "life cycles". For example, in a web application it can be the `request.uuid` or the `request.url`, so you will be able to see how many queries, how long did they take, the explain plans etc for each request or url.
+
+## Sample App
+
+You can see how it works through the [Sample Dashboard](https://mongo-profiler-sample-app.herokuapp.com/mongo_profiler) and [Sample App](https://mongo-profiler-sample-app.herokuapp.com) ([source code](https://github.com/phstc/mongo_profiler_sample_app)).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'mongo_profiler'
+```ruby
+gem 'mongo_profiler'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install mongo_profiler
-
-## Usage
+```bash
+$ gem install mongo_profiler
+```
 
-### Rails application
+To run the Dashboard you will need also to install [sinatra](https://github.com/sinatra/sinatra).
 
 ```ruby
-# config/initializers/mongo_profiler_setup.rb
-
-require 'mongo_profiler'
-require 'mongo_profiler/extensions/mongo/cursor'
+gem 'sinatra', require: nil
+```
 
-MongoProfiler.connect('localhost', 27017, 'my_database')
+## Usage
 
-MongoProfiler.application_name = 'my_application'
+### Rails application
 
-# To enable Statsd
-# MongoProfiler.stats_client = MyStatsdClientInstance
+### Gemfile
 
-# To show graphite graphs
-# MongoProfiler.graphite_url = 'http://my_graphite'
 ```
+gem 'mongo_profiler', github: 'phstc/mongo_profiler', require: nil
+gem 'sinatra', require: nil
+```
+
+#### application_controller.rb
 
 ```ruby
 # app/controllers/application_controller.rb
 
 class ApplicationController < ActionController::Base
-  before_filter :mongo_profiler_setup
+  before_filter :set_mongo_profile_group_name
 
-  private
-
-  def mongo_profiler_setup
-    # aggregate queries by request
-    MongoProfiler.group_id = "request-#{request.uuid}"
-
-    # to show the request url
-    MongoProfiler.extra_attrs[:request_url]  = request.url
-  rescue => e
-    p "MongoProfiler: #{e.message}"
+  def set_mongo_profile_group_name
+    unless Rails.env.production?
+      require 'mongo_profiler'
+      MongoProfiler.current_group_name = request.url
+    end
   end
 end
 ```
 
+#### routes.rb
+
 ```ruby
 # config/routes.rb
 
-require 'mongo_profiler/web'
-
 MyApplication::Application.routes.draw do
-  mount MongoProfiler::Web => '/mongo_profiler'
-
-  # Security with Devise
-  # authenticate :user do
-  #  mount MongoProfiler::Web => '/mongo_profiler'
-  # end
-  #
-  # authenticate :user, lambda { |u| u.admin? } do
-  #  mount MongoProfiler::Web => '/mongo_profiler'
-  # end
+  unless Rails.env.production?
+    require 'mongo_profiler'
+    require 'mongo_profiler/web'
+    mount MongoProfiler::Web => '/mongo_profiler'
+    # Security with Devise
+    # authenticate :user do
+    #  mount MongoProfiler::Web => '/mongo_profiler'
+    # end
+    #
+    # authenticate :user, lambda { |u| u.admin? } do
+    #  mount MongoProfiler::Web => '/mongo_profiler'
+    # end
+  end
 end
 ```
 
-## Screenshots
-
-### Dashboard index
-
-![Dashboard Index](https://raw.github.com/phstc/mongo_profiler/master/assets/mongo_profiler_dashboard_index.png)
-
-### Queries Group Index
-
-![Queries Group Index](https://raw.github.com/phstc/mongo_profiler/master/assets/mongo_profiler_group_details.png)
-
-### Query details
-
-![Query Details](https://raw.github.com/phstc/mongo_profiler/master/assets/mongo_profiler_query_details.png)
-
-### Query details (backtrace)
-
-![Query Details Backtrace](https://raw.github.com/phstc/mongo_profiler/master/assets/mongo_profiler_query_details_backtrace.png)
-
-
 ## Contributing
 
 1. Fork it ( http://github.com/phstc/mongo_profiler/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/lib/mongo_profiler.rb

@@ -1,108 +1,22 @@
-require 'mongo'
 require 'json'
+require 'mongoid'
 require 'active_support/core_ext/hash/indifferent_access'
 
 require 'mongo_profiler/version'
-require 'mongo_profiler/profiler'
 require 'mongo_profiler/caller'
-require 'mongo_profiler/payload'
-require 'mongo_profiler/stats'
+require 'mongo_profiler/util'
+require 'mongo_profiler/extensions/moped'
+require 'mongo_profiler/models/profile'
+require 'mongo_profiler/models/profile_group'
 
 module MongoProfiler
-  COLLECTION_CONFIG_NAME   = 'mongo_profiler_config'
-  COLLECTION_PROFILER_NAME = 'mongo_profiler'
-
   class << self
-    attr_accessor :extra_attrs,
-      :group_id,
-      :application_name,
-      :stats_client,
-      :stats_prefix,
-      :graphite_url
-
-    attr_reader :database
-
-    def log(document)
-      collection.insert(document.merge(application_name:  MongoProfiler.application_name,
-                                       group_id:          MongoProfiler.group_id))
-    end
-
-    def should_skip?(payload, _caller)
-      Payload.new(payload).system_any? || _caller.mongo_profiler_caller?
-    end
-
-    def disable!
-      # maybe we can refactor to check if the collections exist before trying to create them.
-      # we must make sure the collections are in place before enabled/disable otherwise mongo will create a normal collection,
-      # not a capped one, breaking the disable & enable functionality
-      create_collections
-
-      collection_config.insert(enabled: false)
+    def current_group_name=(group_name)
+      Thread.current['mongo_profiler_group_name'] = group_name
     end
 
-    def enable!
-      # check `disable!` comment
-      create_collections
-
-      collection_config.insert(enabled: true)
-    end
-
-    def enabled?
-      !!collection_config.find.first.to_h['enabled']
-    end
-
-    def disabled?
-      !enabled?
-    end
-
-    def extra_attrs
-      @extra_attrs ||= {}
-    end
-
-    def group_id
-      # The group_id is used to determine the life cycle where the queries occurred.
-      # For web applications a life cycle can be a request.
-      # So people can filter all Mongo Queries per request based on request#url and/or request#uuid.
-      @group_id ||= { process_pid:       Process.pid,
-                      thread_object_id:  Thread.current.object_id }.to_a.join('-')
-    end
-
-    def stats_client=(stats_client)
-      @stats_client = MongoProfiler::Stats.new(stats_client)
-    end
-
-    def create_collections
-      # http://docs.mongodb.org/manual/core/capped-collections/
-      # 1_048_576 - 1MB - allows only one document (max: 1)
-      @database.create_collection(COLLECTION_CONFIG_NAME, capped: true, size: 1_048_576, max: 1)
-
-      # 4_001_792 - 3.82MB - same size as db.system.profile.stats()
-      @database.create_collection(COLLECTION_PROFILER_NAME, capped: true, size: 4_001_792, max: 9223372036854775807)
-    end
-
-    def collection
-      @collection ||= @database[COLLECTION_PROFILER_NAME]
-    end
-
-    def collection_config
-      @collection_config ||= @database[COLLECTION_CONFIG_NAME]
-    end
-
-    def connected?
-      !!(@connection && @database)
-    end
-
-    def connect(host = 'localhost', port = 27017, db = nil, user = nil, pass = nil, options = {})
-      @connection, @database = nil
-
-      @connection = Mongo::MongoClient.new(host, port, options)
-      if db
-        @database = @connection.db(db)
-      else
-        # default database
-        @database = @connection.db
-      end
-      @database.authenticate(user, pass) if user && pass
+    def current_group_name
+      Thread.current['mongo_profiler_group_name'] || 'Undefined group name'
     end
   end
 end

data/lib/mongo_profiler/caller.rb

@@ -3,7 +3,7 @@ module MongoProfiler
     attr_reader :file, :line, :method, :_caller
 
     def initialize(_caller)
-      @_caller = _caller.dup
+      @_caller = _caller
 
       caller_head = project_callers[0].split ':'
 
@@ -13,15 +13,13 @@ module MongoProfiler
       @method = project_callers[0][/`.*'/][1..-2]
     end
 
-    def mongo_profiler_caller?
-      _caller.any? { |line| line.include?('mongo_profiler') && !line.include?('_spec') }
-    end
-
     private
 
     def project_callers
       # skip gem/bundle entries
-      @project_callers ||= _caller.select { |line| !line.include?('bundle/ruby') && !line.include?('gem/ruby') && !line.include?('rubies/ruby')  }
+      @project_callers ||= _caller.reject do |entry|
+        entry.include?('bundle/ruby') || entry.include?('gem/ruby') || entry.include?('rubies/ruby') || entry.include?('extensions/moped.rb')
+      end
     end
   end
 end