librato-rack 0.1.0 → 0.2.0

data/README.md

@@ -1,7 +1,7 @@
 librato-rack
 =======
 
-[![Build Status](https://secure.travis-ci.org/librato/librato-rack.png?branch=master)](http://travis-ci.org/librato/librato-rack)
+[![Build Status](https://secure.travis-ci.org/librato/librato-rack.png?branch=master)](http://travis-ci.org/librato/librato-rack) [![Code Climate](https://codeclimate.com/github/librato/librato-rack.png)](https://codeclimate.com/github/librato/librato-rack)
 
 *Note: librato-rack is currently in beta and is currently recommended primarily for early-adopter use*
 
@@ -62,7 +62,7 @@ If you want to do more complex configuration, use your own environment variables
     config.token = 'mytoken'
     # …more configuration
 
-    use Librato::Rack, config
+    use Librato::Rack, :config => config
 
 See the configuration class for all available options.
 

data/lib/librato/rack.rb

@@ -24,13 +24,18 @@ module Librato
   #
   #   app = Rack::Builder.app do
   #     use Librato::Rack
-  #     run lambda { |env| [200, {"Content-Type" => 'text/html'}, ["Hello!"]]}
+  #     run lambda { |env| [200, {"Content-Type" => 'text/html'}, ["Hello!"]] }
   #   end
   #
   class Rack
     attr_reader :config, :tracker
 
-    def initialize(app, config = Configuration.new)
+    def initialize(app, options={})
+      if options.respond_to?(:tracker) # old-style single argument
+        config = options
+      else
+        config = options.fetch(:config, Configuration.new)
+      end
       @app, @config = app, config
       @tracker = Tracker.new(@config)
       Librato.register_tracker(@tracker) # create global reference
@@ -49,7 +54,7 @@ module Librato
 
     def check_log_output(env)
       return if @log_target
-      if env.keys.include?('HTTP_X_HEROKU_QUEUE_DEPTH') # on heroku
+      if in_heroku_env?
         tracker.on_heroku = true
         default = ::Logger.new($stdout)
       else
@@ -59,6 +64,11 @@ module Librato
       @log_target = config.log_target
     end
 
+    def in_heroku_env?
+      # don't have any custom http vars anymore, check if hostname is UUID
+      Socket.gethostname =~ /[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/i
+    end
+
     def process_request(env)
       time = Time.now
       begin
@@ -72,18 +82,11 @@ module Librato
     end
 
     def record_header_metrics(env)
-      return unless env.keys.include?('HTTP_X_HEROKU_QUEUE_DEPTH')
-
-      tracker.group 'rack.heroku' do |group|
-        group.group 'queue' do |q|
-          q.measure 'depth',     env['HTTP_X_HEROKU_QUEUE_DEPTH'].to_f
-          q.timing  'wait_time', env['HTTP_X_HEROKU_QUEUE_WAIT_TIME'].to_f
-        end
-        group.measure 'dynos', env['HTTP_X_HEROKU_DYNOS_IN_USE'].to_f
-      end
+      # TODO: track generalized queue wait
     end
 
     def record_request_metrics(status, duration)
+      return if config.disable_rack_metrics
       tracker.group 'rack.request' do |group|
         group.increment 'total'
         group.timing    'time', duration
@@ -100,6 +103,7 @@ module Librato
     end
 
     def record_exception(exception)
+      return if config.disable_rack_metrics
       tracker.increment 'rack.request.exceptions'
     end
 

data/lib/librato/rack/configuration.rb

@@ -11,7 +11,8 @@ module Librato
     #
     class Configuration
       attr_accessor :user, :token, :api_endpoint, :tracker, :source_pids,
-                    :log_level, :flush_interval, :log_target
+                    :log_level, :flush_interval, :log_target,
+                    :disable_rack_metrics
       attr_reader :prefix, :source
 
       def initialize

data/lib/librato/rack/version.rb

@@ -1,5 +1,5 @@
 module Librato
   class Rack
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/test/apps/deprecated.ru

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'librato-rack'
+
+config = Librato::Rack::Configuration.new
+config.prefix = 'deprecated'
+
+# old-style single-argument assignment
+use Librato::Rack, config
+
+def application(env)
+  [200, {"Content-Type" => 'text/html'}, ["Hello!"]]
+end
+
+run method(:application)

data/test/apps/no_stats.ru

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'librato-rack'
+
+config = Librato::Rack::Configuration.new
+config.disable_rack_metrics = true
+
+use Librato::Rack, :config => config
+
+def application(env)
+  case env['PATH_INFO']
+  when '/exception'
+    raise 'exception raised!'
+  else
+    [200, {"Content-Type" => 'text/html'}, ["Hello!"]]
+  end
+end
+
+run method(:application)

data/test/integration/deprecated_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+require 'rack/test'
+
+# Tests for deprecated functionality
+#
+class DeprecatedTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Rack::Builder.parse_file('test/apps/deprecated.ru').first
+  end
+
+  def teardown
+    # clear metrics before each run
+    aggregate.delete_all
+    counters.delete_all
+  end
+
+  def test_deprecated_config_form
+    get '/'
+    assert_equal 'deprecated', Librato.tracker.config.prefix
+    assert_equal 1, aggregate['deprecated.rack.request.time'][:count]
+  end
+
+  private
+
+  def aggregate
+    Librato.tracker.collector.aggregate
+  end
+
+  def counters
+    Librato.tracker.collector.counters
+  end
+
+end

data/test/integration/no_stats_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+require 'rack/test'
+
+# Tests for universal tracking for all request paths
+#
+class NoStatsTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Rack::Builder.parse_file('test/apps/no_stats.ru').first
+  end
+
+  def teardown
+    # clear metrics before each run
+    aggregate.delete_all
+    counters.delete_all
+  end
+
+  def test_no_standard_counters
+    get '/'
+    assert last_response.ok?
+
+    assert_equal nil, counters["rack.request.total"]
+    assert_equal nil, counters["rack.request.status.200"]
+    assert_equal nil, counters["rack.request.status.2xx"]
+  end
+
+  def test_no_standard_measures
+    get '/'
+    assert last_response.ok?
+
+    assert_equal nil, aggregate["rack.request.time"]
+  end
+
+  def test_dont_track_exceptions
+    begin
+      get '/exception'
+    rescue RuntimeError => e
+      raise unless e.message == 'exception raised!'
+    end
+    assert_equal nil, counters["rack.request.exceptions"]
+  end
+
+  private
+
+  def aggregate
+    Librato.tracker.collector.aggregate
+  end
+
+  def counters
+    Librato.tracker.collector.counters
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: librato-rack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-24 00:00:00.000000000 Z
+date: 2013-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librato-metrics
@@ -69,9 +69,11 @@ files:
 - README.md
 - test/apps/basic.ru
 - test/apps/custom.ru
-- test/apps/heroku.ru
+- test/apps/deprecated.ru
+- test/apps/no_stats.ru
 - test/integration/custom_test.rb
-- test/integration/heroku_test.rb
+- test/integration/deprecated_test.rb
+- test/integration/no_stats_test.rb
 - test/integration/request_test.rb
 - test/remote/tracker_test.rb
 - test/test_helper.rb
@@ -97,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1368002432416974153
+      hash: 2009831152017891350
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1368002432416974153
+      hash: 2009831152017891350
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -116,9 +118,11 @@ summary: Use Librato Metrics with your rack application
 test_files:
 - test/apps/basic.ru
 - test/apps/custom.ru
-- test/apps/heroku.ru
+- test/apps/deprecated.ru
+- test/apps/no_stats.ru
 - test/integration/custom_test.rb
-- test/integration/heroku_test.rb
+- test/integration/deprecated_test.rb
+- test/integration/no_stats_test.rb
 - test/integration/request_test.rb
 - test/remote/tracker_test.rb
 - test/test_helper.rb

data/test/apps/heroku.ru

@@ -1,27 +0,0 @@
-require 'bundler/setup'
-require 'librato-rack'
-
-# Simulate the environment variables Heroku passes along
-# with each request
-#
-class FakeHeroku
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    env['HTTP_X_HEROKU_QUEUE_DEPTH'] = rand(4)
-    env['HTTP_X_HEROKU_QUEUE_WAIT_TIME'] = rand(0.1)
-    env['HTTP_X_HEROKU_DYNOS_IN_USE'] = 2
-    @app.call(env)
-  end
-end
-
-use FakeHeroku
-use Librato::Rack
-
-def application(env)
-  [200, {"Content-Type" => 'text/html'}, ["Hello!"]]
-end
-
-run method(:application)

data/test/integration/heroku_test.rb

@@ -1,36 +0,0 @@
-require 'test_helper'
-require 'rack/test'
-
-# Tests for universal tracking for all request paths
-#
-class HerokuTest < MiniTest::Unit::TestCase
-  include Rack::Test::Methods
-
-  def app
-    Rack::Builder.parse_file('test/apps/heroku.ru').first
-  end
-
-  def teardown
-    # clear metrics before each run
-    aggregate.delete_all
-    counters.delete_all
-  end
-
-  def test_heroku_metrics
-    get '/'
-    assert_equal 1, aggregate['rack.heroku.queue.depth'][:count]
-    assert_equal 1, aggregate['rack.heroku.queue.wait_time'][:count]
-    assert_equal 1, aggregate['rack.heroku.dynos'][:count]
-  end
-
-  private
-
-  def aggregate
-    Librato.tracker.collector.aggregate
-  end
-
-  def counters
-    Librato.tracker.collector.counters
-  end
-
-end