rackamole 0.1.0 → 0.1.1

data/HISTORY

@@ -0,0 +1,8 @@
+0.0.1 - 0.1.0 
+* Initial drop and bug fixes. Not that interesting...
+
+0.1.1
+* Updated mongo store strategy
+  * Tossed out mongo mapper. Trying to stay closer to the metal
+  * Shortened col names for saving space. Unfortunately lame but necessary
+  * Moved user info into separate collection.

data/README.rdoc

@@ -1,5 +1,5 @@
 == RackAMole
-  Your web application observer...
+  Observe your web applications in the wild!
   
 == DESCRIPTION:
 
@@ -27,7 +27,7 @@ interactions and leverage these findings for the next iteration of your applicat
 
 == FEATURES:
 
-* Monitors Rails or Sinatra applications
+* Monitors any rack based framework such as Rails and Sinatra
 * Captures the essence of the request as well as user information
 * Tracks performance issues based on your latency threshold
 * Tracks exceptions that might occurred during a request
@@ -36,14 +36,13 @@ interactions and leverage these findings for the next iteration of your applicat
 
 * Logging
 * Hitimes
-* MongoDb
+* MongoDb + mongo ruby adapter
 
 == INSTALL:
 
 * sudo gem install rackamole
 
-  NOTE: The gem is hosted on gemcutter.com - please update your gem sources if not 
-  already specified
+  NOTE: The gem is hosted on gemcutter.org
   
 == USAGE:
 
@@ -78,6 +77,22 @@ interactions and leverage these findings for the next iteration of your applicat
   This assumes that you have session enabled to identify a user if not the mole will log the user
   as 'Unknown'
   
+=== Storing moled information
+ 
+  Rackamole currently comes with a single storage strategy. More will come in the near future, but
+  currently we are using MongoDb as our default storage. The idea here is to create a database for
+  a given moled app per environment. For instance, for application 'Fred', you will need to use a 
+  separate store for Fred running in alpha mode and Fred running in production mode.
+  
+  In order to use a store, you will need to pass in the :store option. There currently 2 store 
+  types a logger and a mongo adapter. By default the store is set to log moled information to the console. 
+  To change to a mongo store simply add the following options:
+  
+  use Rack::Mole, { :app_name => "Fred", :store => Rackamole::Store::MongoDb.new( :database => 'mole_fred_alpha_mdb' ) }
+  
+  This expect a local mongo instance to be running on the default port. You can change the 
+  location by adding :host and :port options.
+  
 == LICENSE:
 
 (The MIT License)

data/lib/rackamole.rb

@@ -1,7 +1,7 @@
 module Rackamole
 
   # :stopdoc:
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/rackamole/mole.rb

@@ -22,7 +22,7 @@ module Rack
     # :perf_threshold :: Any request taking longer than this value will get moled. Default: 10secs
     # :moleable       :: Enable/Disable the MOle (Default:true)
     # :store          :: The storage instance ie log file or mongodb [Default:stdout]
-    # :expiration     :: Number of seconds to expiration. The mole will not keep sending alert if a particular
+    # :expiration     :: Number of seconds to alert expiration. The mole will not keep sending alert if a particular
     #                    mole type has been reported in the past. This threshold specifies the limit at which
     #                    the previously sent alerts will expire and thus will be sent again. 
     #                    For instance, it might be the case that the app is consistently slow for a particular action.

data/lib/rackamole/store/mongo_db.rb

@@ -7,7 +7,7 @@ module Rackamole
     # Mongo adapter. Stores mole info to a mongo database.
     class MongoDb
       
-      attr_reader :database, :logs, :features #:nodoc:
+      attr_reader :database, :logs, :features, :users #:nodoc:
             
       # Initializes the mongo db store. MongoDb can be used as a persitent store for
       # mole information. This is a preferred store for the mole as it will allow you
@@ -41,7 +41,7 @@ module Rackamole
         args = arguments.clone
 
         # dump request info to mongo
-        save_log( save_feature( args ), args )
+        save_log( save_user( args ), save_feature( args ), args )
       rescue => mole_boom
         $stderr.puts "MOLE STORE CRAPPED OUT -- #{mole_boom}"
         $stderr.puts mole_boom.backtrace.join( "\n   " )        
@@ -54,6 +54,7 @@ module Rackamole
         def reset!
           logs.remove
           features.remove
+          users.remove
         end
 
         def init_mongo( opts )
@@ -61,6 +62,7 @@ module Rackamole
           @database   = @connection.db( opts[:database] )
           @features   = database.collection( 'features' )
           @logs       = database.collection( 'logs' )
+          @users      = database.collection( 'users' )
         end
 
         # Validates option hash.
@@ -77,12 +79,34 @@ module Rackamole
         def default_options
           {
              :host     => 'localhost',
-             :port     => 27017,
+             :port     => Mongo::Connection::DEFAULT_PORT,
              :database => 'mole_mdb'
           }
         end
         
-        # Find or create a mole feature
+        # Find or create a moled user...
+        # BOZO !! What to do if user name changed ?
+        def save_user( args )
+          user_id   = args.delete( :user_id ) if args.has_key?( :user_id )
+          user_name = args.delete( :user_name ) if args.has_key?( :user_name )
+        
+          row = {}
+          if user_id and user_name
+            row = { min_field( :user_id ) => user_id, min_field( :user_name ) => user_name }
+          else
+            row = { min_field( :user_name ) => user_name }
+          end
+                    
+          user = users.find_one( row, :fields => ['_id'] )
+          return user['_id'] if user
+
+          now = args[:created_at]
+          row[min_field(:date_id)] = "%4d%02d%02d" % [now.year, now.month, now.day]
+                    
+          users.save( row )
+        end
+        
+        # Find or create a mole feature...
         def save_feature( args )
           app_name    = args.delete( :app_name )
           route_info  = args.delete( :route_info )
@@ -99,7 +123,8 @@ module Rackamole
           feature = features.find_one( row, :fields => ['_id'] )
           return feature['_id'] if feature
 
-          row[min_field(:created_at)] = args[:created_at]
+          now = args[:created_at]
+          row[min_field(:date_id)] = "%4d%02d%02d" %[now.year, now.month, now.day]
                     
           features.save( row )
         end
@@ -107,13 +132,16 @@ module Rackamole
         # Insert a new feature in the db
         # NOTE : Using min key to reduce storage needs. I know not that great for higher level api's :-(
         # also saving date and time as ints. same deal...
-        def save_log( feature_id, args )
+        def save_log( user_id, feature_id, args )
+puts "Saving LOG for #{feature_id} -- #{user_id}"
+puts caller.inspect    
           now = args.delete( :created_at )
           row = {
             min_field( :type )       => args[:type],
-            min_field( :feature_id ) => feature_id.to_s,
-            min_field( :date_id )    => ("%4d%02d%02d" %[now.year, now.month, now.day]).to_i,
-            min_field( :time_id )    => ("%02d%02d%02d" %[now.hour, now.min, now.sec] ).to_i
+            min_field( :feature_id ) => feature_id,
+            min_field( :user_id )    => user_id,
+            min_field( :date_id )    => "%4d%02d%02d" %[now.year, now.month, now.day],
+            min_field( :time_id )    => "%02d%02d%02d" %[now.hour, now.min, now.sec]
           }
           
           args.each do |k,v|

data/samples/sinatra/moled.rb

@@ -2,20 +2,25 @@ require 'rubygems'
 require 'sinatra'
 require 'rackamole'
 
-set :environment, :production
 
-configure :production do
-  set :sessions,    true
+configure do
+  set :sessions, true
+  
+puts "mole_sinatra_#{Sinatra::Application.environment}_mdb"
+
   use Rack::Lint
   use Rack::Session::Cookie
   use Rack::Mole, { 
-    :app_name       => "Moled Franky", 
+    :app_name       => "Moled Franky",
+    :environment    => Sinatra::Application.environment,
     :log_level      => :debug,
     :user_key       => :user_name,
+    # :store          => Rackamole::Store::MongoDb.new( :database => "mole_sinatra_dev_mdb" ),
+    :store          => Rackamole::Store::MongoDb.new( :database => "mole_sinatra_#{Sinatra::Application.environment}_mdb" ),
     :expiration     => 10,
     :perf_threshold => 0.2,
     :twitter        => { :username => 'moled', :password => 'fernand~1', :alert_on => [Rackamole.perf, Rackamole.fault] },
-    :excluded_paths => [ /.+?\.css/, /.+?\.png/ ]
+    :excluded_paths => [ /.+?\.css/, /.+?\.js/, /.+?\.png/ ]
   }
 end
 
@@ -24,25 +29,24 @@ before do
 end
 
 get '/' do
-  puts "Yo"
   erb :index
 end
 
 get '/normal' do  
   @blee          = "Hello World!"
-  session[:fred] = "oh dear"
-  
+  session[:normal] = "something normal"
   erb :normal
 end
 
 post '/post' do
   @post = params[:blee]
+  session[:post] = "something posted"  
   erb :post
 end
 
 get '/params/:id' do  
   @blee          = params[:id]
-  session[:blee] = "something interesting"
+  session[:param] = "something param"
   
   erb :params
 end

data/spec/rackamole/alert/emole_spec.rb

@@ -23,8 +23,8 @@ describe Rackamole::Alert::Emole do
     
     it "should send a feature email correctly" do
       @expected.subject = "[M()le] (Feature) -Test@Fred- for user Fernand"
-      @expected.body    = feature_body
-      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).encoded.should == @expected.encoded
+      @expected.body    = feature_body      
+      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).body_port.to_s.should == @expected.body_port.to_s
     end
 
     it "should send a perf email correctly" do
@@ -32,7 +32,7 @@ describe Rackamole::Alert::Emole do
       @args[:request_time] = 10.0
       @expected.subject = "[M()le] (Performance:10.0) -Test@Fred- for user Fernand"
       @expected.body    = perf_body
-      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).encoded.should == @expected.encoded
+      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).body_port.to_s.should == @expected.body_port.to_s
     end
 
     it "should send a fault email correctly" do
@@ -42,7 +42,7 @@ describe Rackamole::Alert::Emole do
       @args[:params] = { :id => 10 }
       @expected.subject = "[M()le] (Fault) -Test@Fred- for user Fernand"
       @expected.body    = fault_body
-      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).encoded.should == @expected.encoded
+      Rackamole::Alert::Emole.create_alert( @from, @to, @args ).body_port.to_s.should == @expected.body_port.to_s
     end
 
   end

data/spec/rackamole/store/mongo_db_spec.rb

@@ -1,9 +1,11 @@
 require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+require 'chronic'
 
 describe Rackamole::Store::MongoDb do
   
   describe "#mole" do
     before( :all ) do
+      @now   = Chronic.parse( "11/27/2009" )
       @store = Rackamole::Store::MongoDb.new( 
         :host     => 'localhost', 
         :port     => 27017, 
@@ -30,7 +32,7 @@ describe Rackamole::Store::MongoDb do
       @args[:method]       = 'GET'
       @args[:params]       = { :blee => "duh".to_json }
       @args[:session]      = { :fred => 10.to_json }
-      @args[:created_at]   = Time.now.utc
+      @args[:created_at]   = @now.utc
     end
     
     it "should mole a context based feature correctly" do
@@ -46,7 +48,7 @@ describe Rackamole::Store::MongoDb do
      
       log = @store.logs.find_one()
       log.should_not        be_nil
-      log['typ'].should == Rackamole.feature  
+      log['typ'].should     == Rackamole.feature  
       log['fid'].should_not be_nil
       log['par'].should     == { 'blee' => 'duh'.to_json }
       log['ip'].should      == '1.1.1.1'
@@ -54,13 +56,23 @@ describe Rackamole::Store::MongoDb do
       log['url'].should     == 'http://test_me/'
       log['met'].should     == 'GET'
       log['ses'].should     == { 'fred' => '10' }
-      log['una'].should     == 'Fernand'
-      log['uid'].should     == 100
+      log['uid'].should_not be_nil
       log['rti'].should     == 1.0
-      log['did'].should_not be_nil
-      log['tid'].should_not be_nil    
+      log['did'].should     == '20091127'
+      log['tid'].should     == '190000'
 
-      @store.features.find_one( Mongo::ObjectID.from_string( log['fid'] ) )['app'].should  == 'Test app'                     
+      feature = @store.features.find_one( log['fid'] )
+      feature.should_not     be_nil
+      feature['app'].should  == 'Test app'
+      feature['env'].should  == 'test'
+      feature['ctx'].should  == '/fred'
+      feature['did'].should  == '20091127'
+            
+      user = @store.users.find_one( log['uid'] )
+      user.should_not be_nil
+      user['una'].should == "Fernand"
+      user['uid'].should == 100
+      user['did'].should == '20091127'
     end
     
     it "should mole a rails feature correctly" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-28 00:00:00 -07:00
+date: 2009-12-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,6 +105,7 @@ extra_rdoc_files:
 - samples/rails/moled/public/robots.txt
 files: 
 - ...
+- HISTORY
 - README.rdoc
 - Rakefile
 - aaa.txt