rackamole 0.2.7 → 0.2.8

data/HISTORY

@@ -37,4 +37,7 @@
   
 0.2.7
 * Bug fixes and cleanup
-* Added user_agent parsing. now extracting os/platform/version as well as browser type and version.
+* Added user_agent parsing. now extracting os/platform/version as well as browser type and version.
+
+0.2.8
+* Formatted email alerts so they are a little more readable

data/lib/rackamole/alert/emole.rb

@@ -17,19 +17,19 @@ module Rackamole::Alert
     # or persisted in the db regardless.
     #
     # === Parameters:
-    # options    :: Hash minimaly containing :from for the from address. Must be a valid domain.
+    # options    :: Mole options. The :email key minimaly contains :from for the from address. Must be a valid domain.
     #            :: And a :to, n array of email addresses for recipients to be notified.
     # args       :: The gathered information from the mole.
     #
     def self.deliver_alert( logger, options, args )
-      params = options.clone
-      params[:to]      = options[:to].join( ", " )
-      params[:subject] = "[M()le] (#{alert_type( args )}#{request_time?( args )}) -#{args[:app_name]}@#{args[:host]}- for user #{args[:user_name]}"
-      
-      content = []
-      dump( content, args, 0 )
-      content = content.join( "\n" )
+      @options = options
+      opts     = options[:email]
+      params   = opts.clone
+      params[:to]      = opts[:to].join( ", " )
+      params[:subject] = "RackAmole <#{alert_type( args )}> #{request_time?( args )} on #{args[:app_name]}.#{args[:host]} for user #{args[:user_name]}"
       
+      @args = args
+            
       tmpl     = File.join( template_root, %w[alert.erb] )
       template = Erubis::Eruby.new( IO.read( tmpl ), :trim => true )
             
@@ -39,15 +39,85 @@ module Rackamole::Alert
       Pony.mail( params )      
       output
     rescue => boom
+      puts boom
+      boom.backtrace.each { |l| puts l }
       logger.error( "Rackamole email alert failed with error `#{boom}" )
     end
             
-    # =========================================================================               
+    def self.section( title )
+      buff = []
+      # buff << "-"*80
+      buff << "-"*40      
+      buff << "o #{title.capitalize}\n"      
+      buff << self.send( title.downcase )
+      buff << "\n"
+      buff.join( "\n" )      
+    end
+    
+    # =========================================================================
     private
-           
+
+      def self.args
+        @args
+      end
+      
+      def self.humanize( key )
+        key
+      end
+      
+      def self.feature_type
+        case args[:type]
+          when Rackamole.feature
+            "Feature"
+          when Rackamole.perf
+            "Performance"
+          when Rackamole.fault
+            "Fault"  
+        end
+      end
+      
+      # Format args and spit out into buffer
+      def self.spew( key, silent=false )
+        buff = []
+        
+        _spew( buff, '--', (silent ? '' : '  '), key, args[key], silent )
+        buff.join( "\n" )
+      end
+      def self._spew( buff, sep, indent, key, value, silent )
+        if value.is_a?( Hash )
+          buff << "#{indent}#{humanize( key )}:" unless silent
+          value.each_pair{ |k,v| _spew( buff, sep, indent+"  ", k, v, false ) }
+        elsif value.is_a?( Array )
+          buff << "#{indent}#{humanize( key )}:" unless silent
+          value.each { |s| _spew( buff, sep, indent+" ", '', s, false ) }
+        else
+          buff << "#{indent}#{humanize( key )}: #{value}"
+        end
+      end
+      
+      # What just happened?
+      def self.what
+        buff = []
+        case args[:type]
+          when Rackamole.fault
+            buff << spew( :fault ) << spew( :stack ) + "\n"
+          when Rackamole.perf
+            buff << "#{spew( :request_time )}/#{@options[:perf_threshold]}"
+        end
+        buff << spew( :url ) << spew( :path ) << spew( :status ) 
+        buff << spew( :method ) << spew( :request_time ) << spew( :ip )
+        buff.join( "\n" )
+      end      
+      def self.server()  [ spew( :host ), spew( :software ), spew( :ruby_version ) ]; end
+      def self.client()  [ spew( :machine, true ) ]; end      
+      def self.params()  [ spew( :params, true ) ];  end      
+      def self.session() [ spew( :session, true ) ]; end
+      def self.browser() [ spew( :browser, true ) ]; end      
+      def self.headers() [ spew( :headers, true ) ]; end
+      
       # Dump request time if any...
       def self.request_time?( args )
-        args[:type] == Rackamole.perf ? ":#{args[:request_time]}" : ''        
+        args[:type] == Rackamole.perf ? ("%5.2f" % args[:request_time] ) : ''        
       end
       
       # Identify the type of alert...        
@@ -62,21 +132,21 @@ module Rackamole::Alert
         end
       end
 
-      # Dump args...
-      def self.dump( buff, env, level=0 )
-        env.each_pair do |k,value|
-          if value.respond_to?(:each_pair) 
-            buff << "%s %-#{40-level}s" % ['  '*level,k]
-            dump( buff, env[k], level+1 )
-          elsif value.instance_of?(Array)
-            buff << "%s %-#{40-level}s" % ['  '*level,k]
-            value.each do |v| 
-              buff << "%s %-#{40-(level+1)}s" % ['  '*(level+1),v]
-            end
-          else
-            buff << "%s %-#{40-level}s %s" % [ '  '*level, k, value.inspect ]
-          end        
-        end
-      end
+      # # Dump args...
+      # def self.dump( buff, env, level=0 )
+      #   env.each_pair do |k,value|
+      #     if value.respond_to?(:each_pair) 
+      #       buff << "%s %-#{40-level}s" % ['  '*level,k]
+      #       dump( buff, env[k], level+1 )
+      #     elsif value.instance_of?(Array)
+      #       buff << "%s %-#{40-level}s" % ['  '*level,k]
+      #       value.each do |v| 
+      #         buff << "%s %-#{40-(level+1)}s" % ['  '*(level+1),v]
+      #       end
+      #     else
+      #       buff << "%s %-#{40-level}s %s" % [ '  '*level, k, value.inspect ]
+      #     end        
+      #   end
+      # end
   end
 end

data/lib/rackamole/alert/templates/alert.erb

@@ -1,9 +1,9 @@
-A watched feature was triggered in application `<%= args[:app_name] %> on host `<%=args[:host]%>
+<%= feature_type %> alert on application <%= args[:app_name] %> on host <%=args[:host] %>
 
-Details...
+<% %w(what server params session browser headers client).each do |heading| %>
+<%= section( heading ) -%>
+<% end -%>
 
-<%= content %>
-
-- Your Rackamole
-
-This message was generated automatically. Please do not respond directly.
+===============================================================
+Powered by Rackamole. This message was generated automatically.
+Please do not respond directly.

data/lib/rackamole/alert/twitt.rb

@@ -6,8 +6,8 @@ module Rackamole::Alert
   class Twitt
 
     # Twitt an alert        
-    def self.deliver_alert( logger, username, password, attrs )
-      @twitt ||= Twitt.new( logger, username, password )
+    def self.deliver_alert( logger, options, attrs )
+      @twitt ||= Twitt.new( logger, options[:twitter][:username], options[:twitter][:password] )
       @twitt.send_alert( attrs )
     end
             

data/lib/rackamole/mole.rb

@@ -163,13 +163,13 @@ module Rack
         # send email alert ?
         if alertable?( :email, attrs[:type] )
           logger.debug ">>> Sending out email on mole type #{attrs[:type]} to #{options[:email][:to].join( ", ")}"
-          Rackamole::Alert::Emole.deliver_alert( logger, options[:email], attrs ) 
+          Rackamole::Alert::Emole.deliver_alert( logger, options, attrs ) 
         end
       
         # send twitter alert ?
         if alertable?( :twitter, attrs[:type] )
           logger.debug ">>> Sending out twitt on mole type #{attrs[:type]} on @#{options[:twitter][:username]}"
-          Rackamole::Alert::Twitt.deliver_alert( logger, options[:twitter][:username], options[:twitter][:password], attrs )
+          Rackamole::Alert::Twitt.deliver_alert( logger, options, attrs )
         end
       end
     rescue => boom

data/lib/rackamole.rb

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

data/spec/rackamole/alert/emole_spec.rb

@@ -10,99 +10,285 @@ describe Rackamole::Alert::Emole do
     @expected.set_content_type 'text', 'plain', { 'charset' => 'utf-8' }
     @expected.mime_version = '1.0'
     @expected.from    = @from
-    @expected.to      = @to    
+    @expected.to      = @to
 
+    @options = { :email => { :from => @from, :to => @to }, :perf_threshold => 10 }
+    
     @args = OrderedHash.new
-    @args[:type]      = Rackamole.feature
-    @args[:app_name]  = 'Test'
-    @args[:host]      = 'Fred'
-    @args[:user_name] = 'Fernand'
+    @args[:type]         = Rackamole.feature
+    @args[:method]       = "POST"
+    @args[:status]       = 200
+    @args[:app_name]     = 'Test'
+    @args[:host]         = 'Fred'
+    @args[:user_name]    = 'Fernand'
+    @args[:url]          = 'http://bumblebeetuna/fred/blee'
+    @args[:path]         = '/fred/blee'
+    @args[:software]     = "nginx/0.7.64"
+    @args[:request_time] = 0.55
+    @args[:ruby_version] = "ruby 1.8.7 (2009-06-12 patchlevel 174) [i686-darwin10.0.0]"
+
+    @args[:params]      = OrderedHash.new
+    @args[:params][:id]   = 10
+    @args[:params][:fred] = [10,20,30]
+    
+    @args[:session] = OrderedHash.new
+    @args[:session][:blee] = "Hello World"
+    @args[:session][:fred] = [10,20,30]
+    
+    @args[:headers] = OrderedHash.new
+    @args[:headers]['Cache-Control']  = "no-cache"
+    @args[:headers]['Content-Type']   = "text/html; charset=utf-8"
+    @args[:headers]['Content-Length'] = "17911"
+    @args[:headers]['Set-Cookie']     = "fred"
+
+    @args[:browser] = OrderedHash.new
+    @args[:browser][:name]    = "Chromey"
+    @args[:browser][:version] = "1.12.23.54"
+    
+    @args[:machine] = OrderedHash.new
+    @args[:machine][:platform] = "Windoze"
+    @args[:machine][:os]       = "Windows NT"
+    @args[:machine][:version]  = "3.5"
+    @args[:machine][:local]    = "en-us"    
+    
   end
   
   describe "#alert" 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.deliver_alert( nil, {:from => @from, :to => @to}, @args ).should == @expected.body_port.to_s
+      @expected.body    = feature_body
+# puts Rackamole::Alert::Emole.deliver_alert( nil, @options, @args )
+      Rackamole::Alert::Emole.deliver_alert( nil, @options, @args ).should == @expected.body_port.to_s
     end
 
     it "should send a perf email correctly" do
       @args[:type] = Rackamole.perf
-      @args[:request_time] = 10.0
+      @args[:request_time] = 15.2
       # @expected.subject = "[M()le] (Performance:10.0) -Test@Fred- for user Fernand"
       @expected.body    = perf_body
-      Rackamole::Alert::Emole.deliver_alert( nil, {:from => @from, :to => @to }, @args ).should == @expected.body_port.to_s
+# puts Rackamole::Alert::Emole.deliver_alert( nil, @options, @args )      
+      Rackamole::Alert::Emole.deliver_alert( nil, @options, @args ).should == @expected.body_port.to_s
     end
 
     it "should send a fault email correctly" do
       @args[:type]   = Rackamole.fault
       @args[:fault]  = 'Oh Snap!'
       @args[:stack]  = ['fred', 'blee']
-      @args[:params] = { :id => 10 }
       # @expected.subject = "[M()le] (Fault) -Test@Fred- for user Fernand"
       @expected.body    = fault_body
-      Rackamole::Alert::Emole.deliver_alert( nil, { :from => @from, :to => @to }, @args ).should == @expected.body_port.to_s
+# puts Rackamole::Alert::Emole.deliver_alert( nil, @options, @args )      
+      Rackamole::Alert::Emole.deliver_alert( nil, @options, @args ).should == @expected.body_port.to_s
     end
-
   end
   
-  
   def feature_body
 msg=<<MSG
-A watched feature was triggered in application `Test on host `Fred
+Feature alert on application Test on host Fred
+
+----------------------------------------
+o What
+
+  url: http://bumblebeetuna/fred/blee
+  path: /fred/blee
+  status: 200
+  method: POST
+  request_time: 0.55
+  ip: 
+
+----------------------------------------
+o Server
 
-Details...
+  host: Fred
+  software: nginx/0.7.64
+  ruby_version: ruby 1.8.7 (2009-06-12 patchlevel 174) [i686-darwin10.0.0]
 
- type                                     0
- app_name                                 \"Test\"
- host                                     \"Fred\"
- user_name                                \"Fernand\"
+----------------------------------------
+o Params
 
-- Your Rackamole
+  id: 10
+  fred:
+   : 10
+   : 20
+   : 30
 
-This message was generated automatically. Please do not respond directly.
+----------------------------------------
+o Session
+
+  blee: Hello World
+  fred:
+   : 10
+   : 20
+   : 30
+
+----------------------------------------
+o Browser
+
+  name: Chromey
+  version: 1.12.23.54
+
+----------------------------------------
+o Headers
+
+  Cache-Control: no-cache
+  Content-Type: text/html; charset=utf-8
+  Content-Length: 17911
+  Set-Cookie: fred
+
+----------------------------------------
+o Client
+
+  platform: Windoze
+  os: Windows NT
+  version: 3.5
+  local: en-us
+
+
+===============================================================
+Powered by Rackamole. This message was generated automatically.
+Please do not respond directly.
 MSG
   end
   
   def perf_body
 msg=<<MSG
-A watched feature was triggered in application `Test on host `Fred
+Performance alert on application Test on host Fred
+
+----------------------------------------
+o What
+
+  request_time: 15.2/10
+  url: http://bumblebeetuna/fred/blee
+  path: /fred/blee
+  status: 200
+  method: POST
+  request_time: 15.2
+  ip: 
 
-Details...
+----------------------------------------
+o Server
 
- type                                     1
- app_name                                 \"Test\"
- host                                     \"Fred\"
- user_name                                \"Fernand\"
- request_time                             10.0
+  host: Fred
+  software: nginx/0.7.64
+  ruby_version: ruby 1.8.7 (2009-06-12 patchlevel 174) [i686-darwin10.0.0]
 
-- Your Rackamole
+----------------------------------------
+o Params
 
-This message was generated automatically. Please do not respond directly.
+  id: 10
+  fred:
+   : 10
+   : 20
+   : 30
+
+----------------------------------------
+o Session
+
+  blee: Hello World
+  fred:
+   : 10
+   : 20
+   : 30
+
+----------------------------------------
+o Browser
+
+  name: Chromey
+  version: 1.12.23.54
+
+----------------------------------------
+o Headers
+
+  Cache-Control: no-cache
+  Content-Type: text/html; charset=utf-8
+  Content-Length: 17911
+  Set-Cookie: fred
+
+----------------------------------------
+o Client
+
+  platform: Windoze
+  os: Windows NT
+  version: 3.5
+  local: en-us
+
+
+===============================================================
+Powered by Rackamole. This message was generated automatically.
+Please do not respond directly.
 MSG
   end
 
   def fault_body
 msg=<<MSG
-A watched feature was triggered in application `Test on host `Fred
+Fault alert on application Test on host Fred
+
+----------------------------------------
+o What
+
+  fault: Oh Snap!
+  stack:
+   : fred
+   : blee
+
+  url: http://bumblebeetuna/fred/blee
+  path: /fred/blee
+  status: 200
+  method: POST
+  request_time: 0.55
+  ip: 
+
+----------------------------------------
+o Server
+
+  host: Fred
+  software: nginx/0.7.64
+  ruby_version: ruby 1.8.7 (2009-06-12 patchlevel 174) [i686-darwin10.0.0]
+
+----------------------------------------
+o Params
+
+  id: 10
+  fred:
+   : 10
+   : 20
+   : 30
+
+----------------------------------------
+o Session
+
+  blee: Hello World
+  fred:
+   : 10
+   : 20
+   : 30
+
+----------------------------------------
+o Browser
+
+  name: Chromey
+  version: 1.12.23.54
+
+----------------------------------------
+o Headers
+
+  Cache-Control: no-cache
+  Content-Type: text/html; charset=utf-8
+  Content-Length: 17911
+  Set-Cookie: fred
 
-Details...
+----------------------------------------
+o Client
 
- type                                     2
- app_name                                 \"Test\"
- host                                     \"Fred\"
- user_name                                \"Fernand\"
- fault                                    \"Oh Snap!\"
- stack                                   
-   fred                                   
-   blee                                   
- params                                  
-   id                                      10
+  platform: Windoze
+  os: Windows NT
+  version: 3.5
+  local: en-us
 
-- Your Rackamole
 
-This message was generated automatically. Please do not respond directly.
+===============================================================
+Powered by Rackamole. This message was generated automatically.
+Please do not respond directly.
 MSG
   end
   

data/spec/rackamole/alert/twitt_spec.rb

@@ -3,7 +3,7 @@ require 'chronic'
 
 describe Rackamole::Alert::Twitt do
   before( :each ) do
-    @alert = Rackamole::Alert::Twitt.new( nil, 'fernand', "blee" )
+    @alert = Rackamole::Alert::Twitt.new( nil, 'fernand', 'blee' )
   end
   
   it "should truncate a message correctly" do
@@ -39,7 +39,7 @@ describe Rackamole::Alert::Twitt do
       # client.should_receive( :new ).once.and_return( client )
       twitt.should_receive( :send_alert ).with( @args ).once.and_return( "yeah" )      
       
-      Rackamole::Alert::Twitt.deliver_alert( nil, "blee", "duh", @args )
+      Rackamole::Alert::Twitt.deliver_alert( nil, { :twitter => { :username => "blee", :password => "duh" } }, @args )
     end
     
     it "should twitt a feature alert correctly" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rackamole
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-28 00:00:00 -07:00
+date: 2010-01-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency