librato-rack 0.2.1 → 0.3.0

data.tar.gz.sig

@@ -0,0 +1,2 @@
+*�2V�bGD��C����e:�?�TS���PQo�DžѬy�1Ww���G^(m�8Ĝ�̶��ar|Em%Z�~��m�`5�H�X�ŘKhC�-|,Ӑ_���<
+QU�1(��h̜{�ּb=?gְ����v5"��͊"ҳv����!�l6�B���h�Yް��Ț,�s���j~]|���_*N�$Z�� P\��n=j�

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+### Version 0.3.0
+* Add experimental support for EventMachine and EMSynchrony (Balwant K)
+* Start testing suite against jruby/rbx
+* Gem is now signed
+
+### Version 0.2.1
+* Fix exception if logging metrics before middleware init (Eric Holmes)
+
+### Version 0.2.0
+* Add disable_rack_metrics config option
+* Remove metrics based on deprecated heroku HTTP headers
+* Ensure compatibility with ruby 2.0
+
+### Version 0.1.0
+* Initial version

data/README.md

@@ -1,9 +1,7 @@
 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*
+[![Gem Version](https://badge.fury.io/rb/librato-rack.png)](http://badge.fury.io/rb/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)
 
 `librato-rack` provides rack middleware which will report key statistics for your rack applications to [Librato Metrics](https://metrics.librato.com/). It will also allow you to easily track your own custom metrics. Metrics are delivered asynchronously behind the scenes so they won't affect performance of your requests.
 
@@ -50,8 +48,9 @@ If you don't have a Metrics account already, [sign up](https://metrics.librato.c
 By default you can use `LIBRATO_USER` and `LIBRATO_TOKEN` to pass your account data to the middleware. While these are the only required variables, there are a few more optional environment variables you may find useful.
 
 * `LIBRATO_SOURCE` - the default source to use for submitted metrics. If this is not set, hostname of the executing machine will be the default source
-* `LIBRATO_PREFIX` - a prefix which will be appended to all metric names
+* `LIBRATO_PREFIX` - a prefix which will be prepended to all metric names
 * `LIBRATO_LOG_LEVEL` - see logging section for more
+* `LIBRATO_EVENT_MODE` - use with evented apps, see "Use with EventMachine" below
 
 ##### Use a configuration object
 
@@ -68,7 +67,7 @@ See the configuration class for all available options.
 
 ##### Running on Heroku
 
-If you are using the Librato Metrics Heroku addon, your `LIBRATO_USER` and `LIBRATO_TOKEN` environment variables will already be set in your Heroku environment. If you are running without the addon you will need to provide them yourself.
+If you are using the [Librato Metrics Heroku addon](https://addons.heroku.com/librato), your `LIBRATO_USER` and `LIBRATO_TOKEN` environment variables will already be set in your Heroku environment. If you are running without the addon you will need to provide them yourself.
 
 You must also specify a custom source for your app to track properly. If an explicit source is not set, `librato-rack` will not start. You can set the source in your environment:
 
@@ -76,6 +75,12 @@ You must also specify a custom source for your app to track properly. If an expl
 
 NOTE: if Heroku idles your application no measurements will be sent until it receives another request and is restarted. If you see intermittent gaps in your measurements during periods of low traffic this is the most likely cause.
 
+##### Use with EventMachine and EM Synchrony
+
+`librato-rack` has experimental support for EventMachine and EM Synchrony apps.
+
+When using in an evented context set LIBRATO_EVENT_MODE to `'eventmachine'` if using [EventMachine](https://github.com/eventmachine/eventmachine) or `'synchrony'` if using [EM Synchrony](https://github.com/igrigorik/em-synchrony) and/or [Rack::FiberPool](https://github.com/alebsack/rack-fiber_pool). We're interested in maturing this support, so please let us know if you have any issues.
+
 ## Custom Measurements
 
 Tracking anything that interests you is easy with Metrics. There are four primary helpers available:
@@ -141,7 +146,7 @@ Can also be written as:
       g.measure 'hits', 18
     end
 
-Symbols can be used interchangably with strings for metric names.
+Symbols can be used interchangeably with strings for metric names.
 
 ## Cross-Process Aggregation
 

data/Rakefile

@@ -8,7 +8,7 @@ end
 # console
 desc "Open an console session preloaded with this library"
 task :console do
-  sh "pry -rubygems -r ./lib/librato-rack.rb"
+  sh "pry -r ./lib/librato-rack.rb"
 end
 
 Bundler::GemHelper.install_tasks

data/lib/librato/rack/configuration.rb

@@ -10,6 +10,8 @@ module Librato
     #   config.token = 'mytoken'
     #
     class Configuration
+      EVENT_MODES = [:eventmachine, :synchrony]
+
       attr_accessor :user, :token, :api_endpoint, :tracker, :source_pids,
                     :log_level, :flush_interval, :log_target,
                     :disable_rack_metrics
@@ -29,6 +31,23 @@ module Librato
         self.prefix = ENV['LIBRATO_PREFIX'] || ENV['LIBRATO_METRICS_PREFIX']
         self.source = ENV['LIBRATO_SOURCE'] || ENV['LIBRATO_METRICS_SOURCE']
         self.log_level = ENV['LIBRATO_LOG_LEVEL'] || :info
+        self.event_mode = ENV['LIBRATO_EVENT_MODE']
+      end
+
+      def event_mode
+        @event_mode
+      end
+
+      # set event_mode, valid options are EVENT_MODES or
+      # nil (the default) if not running in an evented context
+      def event_mode=(mode)
+        mode = mode.to_sym if mode
+        # reject unless acceptable mode, allow for turning event_mode off
+        if [*EVENT_MODES, nil].include?(mode)
+          @event_mode = mode
+        else
+          # TODO log warning
+        end
       end
 
       def explicit_source?

data/lib/librato/rack/tracker.rb

@@ -29,11 +29,10 @@ module Librato
         log(:debug) { "config: #{config.dump}" }
         @pid = $$
         log(:debug) { ">> starting up worker for pid #{@pid}..." }
-        @worker = Thread.new do
-          worker = Worker.new
-          worker.run_periodically(config.flush_interval) do
-            flush
-          end
+
+        @worker = Worker.new(:timer => config.event_mode)
+        @worker.run_periodically(config.flush_interval) do
+          flush
         end
       end
 
@@ -66,6 +65,18 @@ module Librato
         @client ||= prepare_client
       end
 
+      # use custom faraday adapter if running in evented context
+      def custom_adapter
+        case config.event_mode
+        when :eventmachine
+          :em_http
+        when :synchrony
+          :em_synchrony
+        else
+          nil
+        end
+      end
+
       def build_flush_queue(collector)
         queue = ValidatingQueue.new( :client => client, :source => qualified_source,
           :prefix => config.prefix, :skip_measurement_times => true )
@@ -95,6 +106,9 @@ module Librato
         client.authenticate config.user, config.token
         client.api_endpoint = config.api_endpoint
         client.custom_user_agent = user_agent
+        if custom_adapter
+          client.faraday_adapter = custom_adapter
+        end
         client
       end
 
@@ -131,7 +145,6 @@ module Librato
         ua_chunks << "(#{ruby_engine}; #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}; #{RUBY_PLATFORM})"
         ua_chunks.join(' ')
       end
-
     end
   end
 end

data/lib/librato/rack/version.rb

@@ -1,5 +1,5 @@
 module Librato
   class Rack
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/librato/rack/worker.rb

@@ -5,31 +5,32 @@ module Librato
     # of how long execution takes.
     #
     class Worker
+      attr_reader :timer
 
-      def initialize
+      # available options:
+      #  * timer - type of timer to use, valid options are
+      #            :sleep (default), :eventmachine, or :synchrony
+      def initialize(options={})
         @interrupt = false
+        @timer = (options[:timer] || :sleep).to_sym
       end
 
       # run the given block every <period> seconds, looping
       # infinitely unless @interrupt becomes true.
       #
       def run_periodically(period, &block)
-        next_run = start_time(period)
-        until @interrupt do
-          now = Time.now
-          if now >= next_run
-            block.call
-            while next_run <= now
-              next_run += period
-            end
-          else
-            sleep(next_run - now)
-          end
+        @proc = block # store
+
+        if [:eventmachine, :synchrony].include?(timer)
+          compensated_repeat(period) # threading is already handled
+        else
+          @thread = Thread.new { compensated_repeat(period) }
         end
       end
 
       # Give some structure to worker start times so when possible
       # they will be in sync.
+      #
       def start_time(period)
         earliest = Time.now + period
         # already on a whole minute
@@ -43,7 +44,36 @@ module Librato
         end
       end
 
-    end
+      private
 
+      # run continuous loop executing every <period>, will start
+      # at <first_run> if set otherwise will auto-determine
+      # appropriate time for first run
+      def compensated_repeat(period, first_run = nil)
+        next_run = first_run || start_time(period)
+        until @interrupt do
+          now = Time.now
+          if now >= next_run
+            @proc.call
+
+            while next_run <= now
+              next_run += period # schedule future run
+            end
+          end
+
+          interval = next_run - now
+          case timer
+          when :eventmachine
+            EM.add_timer(interval) { compensated_repeat(period, next_run) }
+            break
+          when :synchrony
+            EM::Synchrony.sleep(interval)
+          else
+            sleep(next_run - now)
+          end
+        end
+      end
+
+    end
   end
 end

data/test/integration/custom_test.rb

@@ -3,7 +3,7 @@ require 'rack/test'
 
 # Tests for universal tracking for all request paths
 #
-class CustomTest < MiniTest::Unit::TestCase
+class CustomTest < Minitest::Test
   include Rack::Test::Methods
 
   def app

data/test/integration/deprecated_test.rb

@@ -3,7 +3,7 @@ require 'rack/test'
 
 # Tests for deprecated functionality
 #
-class DeprecatedTest < MiniTest::Unit::TestCase
+class DeprecatedTest < Minitest::Test
   include Rack::Test::Methods
 
   def app

data/test/integration/no_stats_test.rb

@@ -3,7 +3,7 @@ require 'rack/test'
 
 # Tests for universal tracking for all request paths
 #
-class NoStatsTest < MiniTest::Unit::TestCase
+class NoStatsTest < Minitest::Test
   include Rack::Test::Methods
 
   def app

data/test/integration/request_test.rb

@@ -3,7 +3,7 @@ require 'rack/test'
 
 # Tests for universal tracking for all request paths
 #
-class RequestTest < MiniTest::Unit::TestCase
+class RequestTest < Minitest::Test
   include Rack::Test::Methods
 
   def app

data/test/remote/tracker_test.rb

@@ -4,7 +4,7 @@ require 'rack/test'
 
 # Tests for universal tracking for all request paths
 #
-class TrackerRemoteTest < MiniTest::Unit::TestCase
+class TrackerRemoteTest < Minitest::Test
 
   # These tests connect to the Metrics server with an account and verify remote
   # functions. They will only run if the below environment variables are set.

data/test/test_helper.rb

@@ -3,20 +3,6 @@ Bundler.setup
 
 require 'pry'
 require 'minitest/autorun'
-# require 'mocha/setup'
-
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
 
 require 'librato/rack'
 
-# require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-# require "rails/test_help"
-
-# Configure capybara
-# require 'capybara/rails'
-# Capybara.default_driver = :rack_test
-# Capybara.default_selector = :css
-
-# Load support files
-#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/test/unit/collector/aggregator_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module Librato
   class Collector
-    class AggregatorTest < MiniTest::Unit::TestCase
+    class AggregatorTest < Minitest::Test
 
       def setup
         @agg = Aggregator.new

data/test/unit/collector/counter_cache_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module Librato
   class Collector
-    class CounterCacheTest < MiniTest::Unit::TestCase
+    class CounterCacheTest < Minitest::Test
 
       def test_basic_operations
         cc = CounterCache.new

data/test/unit/collector/group_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module Librato
   class Collector
-    class GroupTest < MiniTest::Unit::TestCase
+    class GroupTest < Minitest::Test
 
       def test_increment
         collector = Collector.new

data/test/unit/collector_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 module Librato
-  class CollectorTest < MiniTest::Unit::TestCase
+  class CollectorTest < Minitest::Test
 
     def test_proxy_object_access
       collector = Collector.new

data/test/unit/rack/configuration_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module Librato
   class Rack
-    class ConfigurationTest < MiniTest::Unit::TestCase
+    class ConfigurationTest < Minitest::Test
 
       def setup
         clear_env_vars
@@ -57,13 +57,37 @@ module Librato
         assert_equal 'newfoo', listener.prefix
       end
 
+      def test_event_mode
+        config = Configuration.new
+        assert_equal nil, config.event_mode
+
+        config.event_mode = :synchrony
+        assert_equal :synchrony, config.event_mode
+
+        # handle string config
+        config.event_mode = 'eventmachine'
+        assert_equal :eventmachine, config.event_mode
+
+        # handle invalid
+        config2 = Configuration.new
+        config2.event_mode = 'fooballoo'
+        assert_equal nil, config2.event_mode
+
+        # env detection
+        ENV['LIBRATO_EVENT_MODE'] = 'eventmachine'
+        config3 = Configuration.new
+        assert_equal :eventmachine, config3.event_mode
+      end
+
       private
 
       def clear_env_vars
         ENV.delete('LIBRATO_USER')
         ENV.delete('LIBRATO_TOKEN')
         ENV.delete('LIBRATO_SOURCE')
+        ENV.delete('LIBRATO_PREFIX')
         ENV.delete('LIBRATO_LOG_LEVEL')
+        ENV.delete('LIBRATO_EVENT_MODE')
         # legacy
         ENV.delete('LIBRATO_METRICS_USER')
         ENV.delete('LIBRATO_METRICS_TOKEN')

data/test/unit/rack/logger_test.rb

@@ -3,7 +3,7 @@ require 'stringio'
 
 module Librato
   class Rack
-    class LoggerTest < MiniTest::Unit::TestCase
+    class LoggerTest < Minitest::Test
 
       def setup
         @buffer = StringIO.new

data/test/unit/rack/tracker_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 module Librato
   class Rack
-    class TrackerTest < MiniTest::Unit::TestCase
+    class TrackerTest < Minitest::Test
 
       def test_sets_prefix
         config = Configuration.new

data/test/unit/rack/worker_test.rb

@@ -3,7 +3,7 @@ require 'stringio'
 
 module Librato
   class Rack
-    class WorkerTest < MiniTest::Unit::TestCase
+    class WorkerTest < Minitest::Test
 
       def test_basic_use
         worker = Worker.new
@@ -31,6 +31,18 @@ module Librato
         assert_equal 0, start.sec%10, 'should be evenly divisible with whole minutes'
       end
 
+      def test_timer_type
+        worker = Worker.new
+        assert_equal :sleep, worker.timer
+
+        em_worker = Worker.new(:timer => 'eventmachine')
+        assert_equal :eventmachine, em_worker.timer
+
+        # tolerate explicit nils
+        worker = Worker.new(:timer => nil)
+        assert_equal :sleep, worker.timer
+      end
+
     end
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: librato-rack
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
 - Matt Sanders
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2013-04-04 00:00:00.000000000 Z
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUROakNDQWg2Z0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREJCTVJFd0R3WURWUVFEREFoeWRX
+  SjUKWjJWdGN6RVhNQlVHQ2dtU0pvbVQ4aXhrQVJrV0IyeHBZbkpoZEc4eEV6
+  QVJCZ29Ka2lhSmsvSXNaQUVaRmdOagpiMjB3SGhjTk1UTXdPREE0TWpJeE9U
+  UTJXaGNOTVRRd09EQTRNakl4T1RRMldqQkJNUkV3RHdZRFZRUUREQWh5CmRX
+  SjVaMlZ0Y3pFWE1CVUdDZ21TSm9tVDhpeGtBUmtXQjJ4cFluSmhkRzh4RXpB
+  UkJnb0praWFKay9Jc1pBRVoKRmdOamIyMHdnZ0VpTUEwR0NTcUdTSWIzRFFF
+  QkFRVUFBNElCRHdBd2dnRUtBb0lCQVFDL1g3a2RLd1ovb2kvQQpCanMvY2F4
+  a3lESVpnTFMva2dtdWxvVGhmUEJCUjZNdU40R1hlL2hzZHpTSDhYaHRCWW9Z
+  cEsvRjJyUkJzclMrCmpMclpiS0pBR1VJcnFIaVNmZEx6eDJrMnNHVVlsS3pm
+  NmE0eFdpNTg3bmRDOEJ2aDVsZGM4NVcxbGxIRGVBU1MKUjVXanBlcjRLVTFO
+  V0cxRkFWdlFDWGhTS2Rta2krd1g3Sm5kN0NRK296N2trS1lQTThHL1pUZGIr
+  cW43d1JMVgpLYVIrenpHRG13VFEyV3pNaXRTWG1mL2t1NE1VbVJ6c3llcERY
+  WEVSTHluU3A4SVRrNjdnMkhNQ3l2T1BzZjhLCmNZdmwvd2JiOEJ5L3I2SE9q
+  eTdTTTdZbzM1NHVJZmhuaXU4QUt5bUlLeHNiNElnNzFTMGNVN0htMytXQlRp
+  MjgKQUlnOFRVYVhBZ01CQUFHak9UQTNNQWtHQTFVZEV3UUNNQUF3SFFZRFZS
+  ME9CQllFRkRieVFRcU80eEptYUtCRQpuZVE0eStSV0N2T1hNQXNHQTFVZER3
+  UUVBd0lFc0RBTkJna3Foa2lHOXcwQkFRVUZBQU9DQVFFQUtBelhiQTQ3CjlV
+  NTlTc0VmcVIrRExkdjFWQWNkbXhhd3FDK1ptRzRGcHhaaHVIaGFvVXVpMzVB
+  b1FqelNpSEVVTkRUSXUzdTcKVGNzWXdYTVB6dXl6WkpKS1h2QkttU2I5bVdK
+  OTlET0g4MW9VbU96WDdqQ2xRWFpIcm5GdEhkQVJjTFFzUG1nYQo0RGgrZldY
+  V3hQSjZma3ZnODI2dko0cERtbDdPbzlzQ1hUcEMya2kvNVZla1RYa3BGclVz
+  UVJYamxYUGttVDMvCnhhODU4QkdSanZVNTlXUEUxM1FHaWJhN1lJZUh0UkV2
+  Tng0MkpJZm9KTVY3NG9mcktJdVR3OUNNdG8yZ3o5WHgKS3gxbmNuMDdBK2JK
+  bktaNmhlblFBRjFDSDk2WmNxY0pIMTc5UzJ0SWlLRE04a2VlUklVT1BDM1dU
+  MGZhb2svMgpnQTJvemRyODUxYy9uQT09Ci0tLS0tRU5EIENFUlRJRklDQVRF
+  LS0tLS0K
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librato-metrics
@@ -18,7 +46,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +54,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +95,7 @@ files:
 - LICENSE
 - Rakefile
 - README.md
+- CHANGELOG.md
 - test/apps/basic.ru
 - test/apps/custom.ru
 - test/apps/deprecated.ru
@@ -99,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1088974981839516179
+      hash: 3140236237791435311
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,10 +137,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1088974981839516179
+      hash: 3140236237791435311
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Use Librato Metrics with your rack application