fozzie 0.0.20 → 0.0.21

data/Guardfile

@@ -5,8 +5,4 @@ guard 'rspec', :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
-end
-
-guard 'rocco' do
-  watch(%r{^lib/.*\.rb$})
 end

data/README.md

@@ -144,11 +144,7 @@ To time and register the controller actions within your Rails application, Fozzi
 
 Based on the Rack middleware above, but is more involved in it's construction of the bucket value.
 
-Add the following to your `config/environment.rb`
-
-    Rails::Initializer.run do |config|
-      config.middleware.use 'Fozzie::Rails::Middleware'
-    end
+Fozzie::Rails::Middleware will automatically be invoked on Rails initialization.
 
 ## Bucket name prefixes
 
@@ -176,6 +172,10 @@ Fozzie will try to log these errors, but only if a logger has been applied (whic
 
 This may change, depending on feedback and more production experience.
 
+## Rails User Interface Performance Measuring
+
+If you also require UI metrics, you can also include the Mill script in the bottom of any page you would like to measure (see `resources/mill.js` and `resources/mill.min.js`) and you start receiving measurements on page performance.
+
 ## Credits
 
 Currently supported and maintained by [Marc Watts](marc.watts@lonelyplanet.co.uk) @Lonely Planet Online.
@@ -186,7 +186,7 @@ Big thanks to:
 
 * [Etsy](http://codeascraft.etsy.com/) who's [Statsd](https://github.com/etsy/statsd) product has enabled us to come such a long way in a very short period of time. We love Etsy.
 
-* [https://github.com/reinh](https://github.com/reinh/statsd) for his [statsd](https://github.com/reinh/statsd) Gem.
+* [reinh](https://github.com/reinh/statsd) for his [statsd](https://github.com/reinh/statsd) Gem.
 
 ## Comments and Feedback
 

data/fozzie.gemspec

@@ -21,19 +21,22 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'sys-uname'
+  s.add_dependency 'facets'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'mocha'
   s.add_development_dependency 'syntax'
-
-  s.add_development_dependency 'rack-test'
   s.add_development_dependency 'simplecov'
+
   s.add_development_dependency 'sinatra'
-  s.add_development_dependency 'actionpack'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'actionpack', '2.3.14'
 
   s.add_development_dependency 'guard'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-rocco'
   s.add_development_dependency 'fl-rocco'
+
+  s.add_development_dependency 'ruby_gntp'
 end

data/lib/core_ext/module/monitor.rb

@@ -0,0 +1,11 @@
+require 'fozzie/sniff'
+
+class Module
+
+  def _monitor
+    return unless Fozzie.c.sniff?
+    self.class_eval { include Fozzie::Sniff }
+    @_monitor_flag = true
+  end
+
+end

data/lib/fozzie.rb

@@ -9,6 +9,8 @@
 #
 module Fozzie
 
+  require 'core_ext/module/monitor'
+
   require 'fozzie/configuration'
   require "fozzie/interface"
   require "fozzie/version"
@@ -16,6 +18,8 @@ module Fozzie
   require "fozzie/rack/middleware"
   require "fozzie/rails/middleware"
 
+  require 'fozzie/railtie' if defined?(::Rails)
+
   class << self
 
     # Shortcut for `Fozzie.config`
@@ -57,4 +61,4 @@ module Fozzie
     Kernel.const_set(klas, Interface.instance) unless const_defined?(klas)
   end
 
-end
+end

data/lib/fozzie/configuration.rb

@@ -10,7 +10,7 @@ module Fozzie
   class Configuration
     include Sys
 
-    attr_accessor :env, :config_path, :host, :port, :appname, :namespaces, :timeout
+    attr_accessor :env, :config_path, :host, :port, :appname, :namespaces, :timeout, :monitor_classes, :sniff_envs
 
     def initialize(args = {})
       merge_and_assign_config(args)
@@ -30,6 +30,10 @@ module Fozzie
       @origin_name ||= Uname.uname.nodename
     end
 
+    def sniff?
+      self.sniff_envs.collect(&:to_sym).include?(self.env.to_sym)
+    end
+
     private
 
     # Handle the merging of the given configuaration, and the default config.
@@ -44,13 +48,15 @@ module Fozzie
     # Default configuration settings
     def self.default_configuration
       {
-        :host        => '127.0.0.1',
-        :port        => 8125,
-        :config_path => '',
-        :env         => (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'),
-        :appname     => '',
-        :namespaces  => %w{Stats S Statistics Warehouse},
-        :timeout     => 0.5
+        :host            => '127.0.0.1',
+        :port            => 8125,
+        :config_path     => '',
+        :env             => (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'),
+        :appname         => '',
+        :namespaces      => %w{Stats S Statistics Warehouse},
+        :timeout         => 0.5,
+        :monitor_classes => [],
+        :sniff_envs      => [:development, :staging, :production]
       }.dup
     end
 

data/lib/fozzie/mill.rb

@@ -0,0 +1,50 @@
+require 'uri'
+
+module Fozzie
+  class Mill
+
+    DELIMETER = ';'
+    METRICS   = %w{ttfb load}
+
+    attr_reader :str, :args
+
+    def initialize(str = "")
+      @str          = str
+      escaped_split = str.split(DELIMETER).map!{|x| URI.unescape(x) }
+      @args         = Hash[*escaped_split]
+    end
+
+    def self.register(str = "")
+      new(str).register
+    end
+
+    def register
+      return self unless self.has_href?
+      METRICS.each do |k|
+        next unless self.respond_to?(k.to_sym)
+        S.timing((namespace << ['page', k]).flatten, self.send(k.to_sym))
+      end
+
+      self
+    end
+
+    def load
+      @load ||= @args['domComplete'].to_i - @args['fetchStart'].to_i
+    end
+
+    def ttfb
+      @ttfb ||= @args['responseStart'].to_i - @args['fetchStart'].to_i
+    end
+
+    def has_href?
+      !@args['href'].nil?
+    end
+
+    def namespace
+      @uri  ||= URI(@args['href'])
+      @path ||= @uri.path.strip.split('/').reject(&:empty?)
+      @path.dup
+    end
+
+  end
+end

data/lib/fozzie/rails/engine.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'fozzie/mill'
+
+module Fozzie
+  module Rails
+    class Engine < ::Rails::Engine
+
+      endpoint Proc.new { |env|
+        Fozzie::Mill.register(env['QUERY_STRING'].gsub('d=', ''))
+        [201, {"Content-Type" => "text/html"}, [""]]
+      }
+
+    end
+  end
+end

data/lib/fozzie/rails/middleware.rb

@@ -13,22 +13,25 @@ module Fozzie
         return nil unless path_str
 
         begin
-          routing = (rails_version == 3 ? ::Rails.application.routes : ::ActionController::Routing::Routes)
+          routing = routing_lookup
           path    = routing.recognize_path(path_str)
           stat    = [path[:controller], path[:action], "render"].join('.')
           stat
-        rescue ActionController::RoutingError => exc
-          S.increment "routing.error"
-          nil
         rescue => exc
+          S.increment "routing.error"
           nil
         end
       end
 
+      def routing_lookup
+        (rails_version == 3 ? ::Rails.application.routes : ::ActionController::Routing::Routes)
+      end
+
       def rails_version
         ::Rails.version.to_i
       end
 
     end
+
   end
 end

data/lib/fozzie/railtie.rb

@@ -0,0 +1,15 @@
+require 'fozzie/rails/engine'
+
+class FozzieRailtie < Rails::Railtie
+  initializer "fozzie_railtie.configure_rails_initialization" do |app|
+
+    # Load up the middleware
+    app.middleware.use Fozzie::Rails::Middleware
+
+    # Add the Mill route
+    app.routes.prepend do
+      mount Fozzie::Rails::Engine => '/mill'
+    end
+
+  end
+end

data/lib/fozzie/sniff.rb

@@ -0,0 +1,53 @@
+require 'core_ext/module/monitor'
+require 'facets/module/alias_method_chain' unless Module.methods.include?(:alias_method_chain)
+require 'facets/string/snakecase'
+
+module Fozzie
+  module Sniff
+
+    def self.included(klass)
+      return if klass.include?(ClassMethods)
+
+      klass.class_eval { extend ClassMethods }
+    end
+
+    module ClassMethods
+
+      def _monitor
+        @_monitor_flag = true
+      end
+
+      def _monitor_meth(target, &blk)
+        return if @_monitor_flag.nil? || !@_monitor_flag
+
+        @_monitor_flag, feature, bin = false, :monitor, [self.name.snakecase, target.to_s.snakecase]
+        aliased_target, punctuation  = target.to_s.sub(/([?!=])$/, ''), $1
+
+        with    = "#{aliased_target}_with_#{feature}#{punctuation}"
+        without = "#{aliased_target}_without_#{feature}#{punctuation}"
+
+        blk.call(with, without, feature, bin)
+      end
+
+      def method_added(target)
+        _monitor_meth(target) do |with, without, feature, bin|
+          define_method(with) do |*args|
+            S.time_for(bin) { args.empty? ? self.send(without) : self.send(without, *args) }
+          end
+          self.alias_method_chain(target, feature)
+        end
+      end
+
+      def singleton_method_added(target)
+        _monitor_meth(target) do |with, without, feature, bin|
+          define_singleton_method(with) do |*args|
+            S.time_for(bin) { args.empty? ? send(without) : send(without, *args) }
+          end
+          self.singleton_class.class_eval { alias_method_chain target, feature }
+        end
+      end
+
+    end
+
+  end
+end

data/lib/fozzie/socket.rb

@@ -33,8 +33,9 @@ module Fozzie
       begin
         Fozzie.logger.debug {"Statsd: #{message}"} if Fozzie.logger
         Timeout.timeout(Fozzie.c.timeout) {
-          socket.send(message, 0, Fozzie.c.host, Fozzie.c.port)
-          true
+          res = socket.send(message, 0, Fozzie.c.host, Fozzie.c.port)
+          Fozzie.logger.debug {"Statsd sent: #{res}"} if Fozzie.logger
+          (res.to_i == message.length)
         }
       rescue => exc
         Fozzie.logger.debug {"Statsd Failure: #{exc.message}\n#{exc.backtrace}"} if Fozzie.logger

data/lib/fozzie/version.rb

@@ -1,3 +1,3 @@
 module Fozzie
-  VERSION = "0.0.20"
+  VERSION = "0.0.21"
 end

data/resources/mill.js.example

@@ -0,0 +1,27 @@
+// Mill-Snippet_0.0.1
+(function($){
+  var __mill__ = function() {
+    var c=[window.navigator,window.performance.timing], d=[], t, a, script, s;
+    for(n in c){
+      if(c[n]){
+        t=c[n];
+        for(a in c[n]){
+          if(a && (typeof(t[a])!=='function'&& typeof(t[a])!=='object')){
+            d.push(a);
+            d.push(escape(t[a]));
+          }
+        }
+      }
+    }
+    d.push('href');
+    d.push(window.location.href);
+    script = document.createElement('script');
+    script.src = "/mill?d=" + d.join(';');
+    script.async = true;
+    s = document.getElementsByTagName('script')[0];
+    s.parentNode.insertBefore(script, s);
+  };
+  if(window.addEventListener){
+    window.addEventListener('load', function(){__mill__();}, false);
+  }
+}).call($);

data/resources/mill.min.js.example

@@ -0,0 +1 @@
+(function(b){var a=function(){var j=[window.navigator,window.performance.timing],i=[],g,e,f,h;for(n in j){if(j[n]){g=j[n];for(e in j[n]){if(e&&(typeof(g[e])!=="function"&&typeof(g[e])!=="object")){i.push(e);i.push(escape(g[e]))}}}}i.push("href");i.push(window.location.href);f=document.createElement("script");f.src="/mill?d="+i.join(";");f.async=true;h=document.getElementsByTagName("script")[0];h.parentNode.insertBefore(f,h)};if(window.addEventListener){window.addEventListener("load",function(){a()},false)}}).call($);

data/spec/lib/fozzie/configuration_spec.rb

@@ -51,4 +51,38 @@ describe Fozzie::Configuration do
     subject.namespaces.should include("S")
   end
 
+  describe "#sniff?" do
+
+    it "defaults to false for testing" do
+      subject.stubs(:env).returns('test')
+      subject.sniff?.should be_false
+    end
+
+    it "defaults true when in development" do
+      subject.stubs(:env).returns('development')
+      subject.sniff?.should be_true
+    end
+
+    it "defaults true when in production" do
+      subject.stubs(:env).returns('production')
+      subject.sniff?.should be_true
+    end
+
+  end
+
+  describe "#sniff_envs allows configuration for #sniff?" do
+    let!(:sniff_envs) { subject.stubs(:sniff_envs).returns(['test']) }
+
+    it "scopes to return false" do
+      subject.stubs(:env).returns('development')
+      subject.sniff?.should be_false
+    end
+
+    it "scopes to return true" do
+      subject.stubs(:env).returns('test')
+      subject.sniff?.should be_true
+    end
+
+  end
+
 end

data/spec/lib/fozzie/interface_spec.rb

@@ -37,9 +37,9 @@ describe Fozzie::Interface do
   end
 
   it "times a given block" do
-    subject.expects(:timing).with() {|b, val, timing| b == 'data.bin' && (1000..1200).include?(val) }.twice
-    subject.time_for('data.bin')    { sleep 1 }
-    subject.time_to_do('data.bin')  { sleep 1 }
+    subject.expects(:timing).with() {|b, val, timing| b == 'data.bin' && (1..11).include?(val) }.twice
+    subject.time_for('data.bin')    { sleep 0.01 }
+    subject.time_to_do('data.bin')  { sleep 0.01 }
   end
 
   it "registers a commit" do
@@ -62,8 +62,8 @@ describe Fozzie::Interface do
 
   it "ensures block is called on socket error" do
     UDPSocket.any_instance.stubs(:send).raises(SocketError)
-    proc { subject.time_for('data.bin') { sleep 1 } }.should_not raise_error
-    proc { subject.time_to_do('data.bin') { sleep 1 } }.should_not raise_error
+    proc { subject.time_for('data.bin')   { sleep 0.01 } }.should_not raise_error
+    proc { subject.time_to_do('data.bin') { sleep 0.01 } }.should_not raise_error
   end
 
   it "raises exception if natural exception from block" do
@@ -79,7 +79,8 @@ describe Fozzie::Interface do
   end
 
   it "raises Timeout on slow lookup" do
-    UDPSocket.any_instance.stubs(:send).with(any_parameters) { sleep 0.6 }
+    Fozzie.c.timeout = 0.01
+    UDPSocket.any_instance.stubs(:send).with(any_parameters) { sleep 0.4 }
     subject.increment('data.bin').should eq false
   end