remnant 0.4.2 → 0.4.3

data/README.md

@@ -4,6 +4,19 @@ Remnant hooks into your Rails and discovers your hidden statistics.
 
 * Rails 2.3.x
 
+#### What Remnant Captures
+* request - time it takes for a request to be served
+* action - time it takes for the controller action to finish
+* view - total time for the totality of render to complete
+* templates - time it takes for each template/partial to render
+* filters - time it takes for each filter to run
+* db - total time it takes for all queries to execute
+* queries - time it takes for each sql query to execute
+* gc - time spent inside the GC (if avaialble ree, 1.9.3, etc)
+
+These stats are sent to statsd:
+request, action, view, gc, db, filters
+
 
 #### Install
 
@@ -36,12 +49,73 @@ Remnant.configure do
   # environment of application, defaults to Rails.env
   # included in payload
   environment "production"
+
+  hook do |results|
+    # custom hook to run after each remnant capture with results
+    # results = {key => ms, key2 => ms2}
+  end
 end
 
 Remnant::Rails.setup! # needed if on Rails 2.3.x
 ```
 
+If you want to capture the times it takes to render templates/partials you
+should enable Template capturing in a before filter (or before rendering
+takes place)
+```ruby
+before_filter {|c| Remnant::Template.enable! }
+```
+
+If you want to capture the sql query times you should enable Database
+capturing in a before filter (or before rendering takes place)
+```ruby
+before_filter {|c| Remnant::Database.enable! }
+```
+
 
+#### Example of using hook
+Below is a way to use all captured information remnant offers
+```ruby
+hook do |results|
+  results.map do |key, ms|
+    # loop through specially captures results
+    # [request, action, view]
+  end
+
+  # total time for db
+  Remnant::Database.total_time.to_i
+
+  # total time for all filters
+  Remnant::Filters.total_time.to_i
+
+  # time for individual filters
+  # [{:type => 'before|after|round',
+  #   :name => filter_name,
+  #   :time => microseconds,
+  #   :ms => ms
+  # }]
+  Remnant::Filters.filters.to_json
+
+  # time for individual templates/partials
+  # [view => {'time' => ms,
+  #           'exclusive' => ms,
+  #           'depth' => depth,
+  #           'children' => []
+  # }]
+  if Remnant::Template.enabled?
+    Remnant::Template.trace.root.children.map(&:results).to_json
+  end
+
+  # time for sql queries
+  if Remnant::Database.enabled?
+    queries = Remnant::Database.queries.map {|q| {:sql => q.sql, :ms => q.time * 1000}}
+  end
+
+  # time spent in GC and number of collection attempts
+  Remnant::GC.time.to_i
+  Remnant::GC.collections.to_i
+end
+```
 ###### Note
 Remnant logs to statsd only if your environment is production, demo or staging.
 For all other environments it logs via Rails.logger.info

data/lib/remnant/base.rb

@@ -43,6 +43,7 @@ class Remnant
 
           Remnant.handler.timing("#{key_prefix}.gc", Remnant::GC.time.to_i)
           Remnant.handler.timing("#{key_prefix}.db", Remnant::Database.total_time.to_i)
+          Remnant.handler.timing("#{key_prefix}.filters", Remnant::Filters.total_time.to_i)
 
           @sample_counter = 0
         else

data/lib/remnant/version.rb

@@ -1,3 +1,3 @@
 class Remnant
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remnant
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-12 00:00:00.000000000 Z
+date: 2013-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby