harness 0.1.2 → 0.2.14

data/README.md

@@ -8,6 +8,39 @@ Currently Supported Services:
 
 * Librato
 
+Current Features:
+
+* Track counters over time (# of registered users)
+* Read time specific values (# time to cache something)
+* Build meters on top of counters (# requests per second)
+* Sidekiq integration
+* Resque integration
+* Rails integration
+* Capture and log all measurements coming out of Rails
+
+**Crash Course**
+
+```ruby
+class ComplicatedClass
+  def hard_work
+    # Automatically track how long each of these calls takes so they can
+    # tracked and compared over time.
+    ActiveSupport::Notifications.instrument "hard_work", :gauge => true do
+      # do hard_work
+    end
+  end
+
+  def register_user
+    # Automatically track the total # of registered users you have.
+    # As well, as be able to take measurements of users created in a
+    # specific interval
+    ActiveSupport::Notifications.instrument "register_user", :counter => true do
+      # register_user
+    end
+  end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,7 +61,8 @@ In the metrics world there are two types of things: Gauges and Counters.
 Gauges are time senstive and represent something at a specific point in
 time. Counters keep track of things and should be increasing. Counters
 can be reset back to zero. You can combine counters and/or gauges to
-correlate data about your application.
+correlate data about your application. Meters monitor counters. They
+allow you look at rates of counters (read: counters per second).
 
 Harness makes this process easily. Harness' primary goal it make it dead
 simple to start measuring different parts of your application.
@@ -78,7 +112,30 @@ for that gauge or counter.
 Harness will do all the extra work in sending these metrics to whatever
 service you're using.
 
-## Customzing
+Once you the counters are you are instrumented, then you can meter them.
+Meters allow you take arbitary readings of counter rates. The results
+return a gauge so they can be logged as well.
+
+```ruby
+# Define a counter
+class MyClass
+  def important_method(stuff)
+    ActiveSupport::Notifications.instrument "important_method.my_class", :counter => true do
+      do_important_stuff
+    end
+  end
+end
+
+# Now you can meter it
+meter = Harnes::Meter.new('important_method.my_class')
+meter.per_second # returns a gauge
+meter.per_second.value # if you just want the number
+meter.per(1.hour).value # You can use your own interval
+meter.per_minute
+meter.per_hour
+```
+
+## Customizing
 
 You can pash a hash to `:counter` or `:gauge` to initialize the
 measurement your own way.
@@ -157,7 +214,7 @@ default values are used. You can customize this in an initializer:
 require 'erb'
 
 file = Rails.root.join 'config', 'resque.yml'
-config = YAML.load(ERB.new(File.read(Rails.root.join('config', 'resque.yml'))).result)
+config = YAML.load(ERB.new(File.read(Rails.root.join('config', 'redis.yml'))).result)
 
 Harness.redis = Redis.new(:url => config[Rails.env])
 ```
@@ -170,6 +227,18 @@ Measurements are completely ignored in the test env. They are processed
 in development mode, but not sent to the external service. Everything is
 logged in production.
 
+### Background Processing
+
+Harness integrates automatically with Resque or Sidekiq. This is because
+reporting measurements can take time and add unncessary overhead to the
+response time. If neither of these libraries are present, measurements
+**will be posted in realtime.** You can set your own queue by
+specifiying a class like so:
+
+```ruby
+Harness.config.queue = MyCustomQueue
+```
+
 ## Contributing
 
 1. Fork it

data/harness.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency "webmock"
+  gem.add_development_dependency "resque"
+  gem.add_development_dependency "sidekiq"
 end

data/lib/harness/adapters/librato_adapter.rb

@@ -55,14 +55,27 @@ module Harness
 
         response = http.request request
 
-        raise Harness::LoggingError, response.body unless response.code.to_i == 200
+        unless response.code.to_i == 200
+          text = %Q{
+          Server Said: #{response.body}
+          Sent: #{params.inspect}
+          }
+
+          raise Harness::LoggingError, text
+        end
       end
 
       true
     end
 
     def self.sanitize(name)
-      name.gsub(/\./, '-')
+      if Harness.config.namespace
+        key = "#{name}.#{Harness.config.namespace}"
+      else
+        key = name
+      end
+
+      key.gsub('/', '.')
     end
   end
 end

data/lib/harness/consumer.rb

@@ -4,18 +4,6 @@ module Harness
       Thread.new do
         while measurement = queue.pop
           begin
-            logger.debug "[Harness] Processing Measurement: #{measurement.inspect}"
-
-            case measurement.class.to_s.demodulize.underscore.to_sym
-            when :gauge
-              adapter.log_gauge measurement
-            when :counter
-              adapter.log_counter measurement
-            end
-          rescue LoggingError => ex
-            logger.debug "[Harness] Logging measurement failed! Server Said: #{ex}"
-            logger.debug ex.backtrace.join("\n")
-            logger.warn "[Harness] Could not post measurement! Enable debug logging to see full errors"
           ensure
             mutex.synchronize { @finished = queue.empty? }
           end

data/lib/harness/counter.rb

@@ -1,9 +1,11 @@
+require 'securerandom'
+
 module Harness
   class Counter < Measurement
     def self.from_event(event)
       if event.payload[:counter].is_a? Hash
         counter = new event.payload[:counter]
-      elsif event.payload[:counter].is_a? Symbol
+      elsif event.payload[:counter].is_a?(Symbol) || event.payload[:counter].is_a?(String)
         counter = new :id => event.payload[:counter].to_s
       else
         counter = new
@@ -23,6 +25,8 @@ module Harness
         counter.value = Harness.redis.incr(counter.id).to_i
       end
 
+      Harness.redis.zadd "meters/#{counter.id}", counter.time.to_f, counter.value
+
       counter
     end
   end

data/lib/harness/gauge.rb

@@ -8,7 +8,7 @@ module Harness
     def self.from_event(event)
       if event.payload[:gauge].is_a? Hash
         gauge = new event.payload[:gauge]
-      elsif event.payload[:gauge].is_a? Symbol
+      elsif event.payload[:gauge].is_a?(Symbol) || event.payload[:gauge].is_a?(String)
         gauge = new :id => event.payload[:gauge].to_s
       else
         gauge = new

data/lib/harness/instrumentation.rb

@@ -1,6 +1,8 @@
 ActiveSupport::Notifications.subscribe %r{.+} do |*args|
   event = ActiveSupport::Notifications::Event.new(*args)
 
-  Harness::Gauge.from_event(event).log if event.payload[:gauge]
-  Harness::Counter.from_event(event).log if event.payload[:counter]
+  unless event.payload[:exception]
+    Harness::Gauge.from_event(event).log if event.payload[:gauge]
+    Harness::Counter.from_event(event).log if event.payload[:counter]
+  end
 end

data/lib/harness/integration/action_controller.rb

@@ -1,9 +1,9 @@
 events = %w(write_fragment read_fragment expire_fragment write_page expire_page process_action send_file)
 
-regex = %r{#{events.join("|")}.action_controller}
-
-ActiveSupport::Notifications.subscribe regex do |*args|
-  event = ActiveSupport::Notifications::Event.new(*args)
-  gauge = Harness::Gauge.from_event event
-  gauge.log
+events.each do |name|
+  ActiveSupport::Notifications.subscribe "#{name}.action_controller" do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    gauge = Harness::Gauge.from_event event
+    gauge.log
+  end
 end

data/lib/harness/integration/action_mailer.rb

@@ -1,10 +1,9 @@
 events = %w(receive deliver)
 
-regex = %r{#{events.join("|")}.action_mailer}
-
-ActiveSupport::Notifications.subscribe regex do |*args|
-  event = ActiveSupport::Notifications::Event.new(*args)
-  gauge = Harness::Gauge.from_event event
-  gauge.log
+events.each do |name|
+  ActiveSupport::Notifications.subscribe "#{name}.action_mailer" do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    gauge = Harness::Gauge.from_event event
+    gauge.log
+  end
 end
-

data/lib/harness/integration/action_view.rb

@@ -1,10 +1,9 @@
 events = %w(render_template render_partial)
 
-regex = %r{#{events.join("|")}.action_view}
-
-ActiveSupport::Notifications.subscribe regex do |*args|
-  event = ActiveSupport::Notifications::Event.new(*args)
-  gauge = Harness::Gauge.from_event event
-  gauge.log
+events.each do |name|
+  ActiveSupport::Notifications.subscribe "#{name}.action_view" do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    gauge = Harness::Gauge.from_event event
+    gauge.log
+  end
 end
-

data/lib/harness/integration/active_support.rb

@@ -1,9 +1,9 @@
 events = %w(cache_read cache_generate cache_fetch_hit cache_write cache_delete)
 
-regex = %r{#{events.join("|")}.active_support}
-
-ActiveSupport::Notifications.subscribe regex do |*args|
-  event = ActiveSupport::Notifications::Event.new(*args)
-  gauge = Harness::Gauge.from_event event
-  gauge.log
+events.each do |name|
+  ActiveSupport::Notifications.subscribe "#{name}.active_support" do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    gauge = Harness::Gauge.from_event event
+    gauge.log
+  end
 end

data/lib/harness/integration/sidekiq.rb

@@ -0,0 +1,47 @@
+module Sidekiq
+  module Middleware
+    module Server
+      class HarnessInstrumentation
+        def call(worker_class, item, queue)
+          if instrument? worker_class
+            logger.debug "Instrumenting: #{worker_class.inspect}"
+
+            options = {}
+            options[:gauge] = "#{worker_class.class.to_s.underscore}.sidekiq"
+            options[:counter] = "#{worker_class.class.to_s.pluralize.underscore}.sidekiq"
+
+            ActiveSupport::Notifications.instrument "#{worker_class.class.to_s.underscore}.sidekiq", options do
+              yield
+            end
+
+            ActiveSupport::Notifications.instrument "job.sidekiq", :counter => true
+          else
+            logger.debug "Skipped Instrumenting: #{worker_class.inspect}"
+            yield
+          end
+        end
+
+        private
+        def instrument?(worker_class)
+          if worker_class.is_a? Harness::SidekiqQueue::SendCounter
+            false
+          elsif worker_class.is_a? Harness::SidekiqQueue::SendGauge
+            false
+          else
+            worker_class.to_s !~ /^harness/i
+          end
+        end
+
+        def logger
+          Sidekiq.logger
+        end
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::Server::HarnessInstrumentation
+  end
+end

data/lib/harness/job.rb

@@ -0,0 +1,23 @@
+module Harness
+  class Job
+    def log(measurement)
+      logger.debug "[Harness] Processing Measurement: #{measurement.inspect}"
+
+      case measurement.class.to_s.demodulize.underscore.to_sym
+      when :gauge
+        adapter.log_gauge measurement
+      when :counter
+        adapter.log_counter measurement
+      end
+    end
+
+    private
+    def logger
+      Harness.logger
+    end
+
+    def adapter
+      Harness.config.adapter
+    end
+  end
+end

data/lib/harness/measurement.rb

@@ -10,8 +10,29 @@ module Harness
       self.time ||= Time.now
     end
 
+    def time=(value)
+      if value.is_a? String
+        @time = DateTime.parse value
+      elsif value.is_a? Fixnum
+        @time = Time.at value
+      else
+        @time = value
+      end
+    end
+
     def log
       Harness.log self
     end
+
+    def attributes
+      { 
+        :id => id,
+        :name => name,
+        :source => source,
+        :time => time,
+        :units => units,
+        :value => value
+      }
+    end
   end
 end

data/lib/harness/meter.rb

@@ -0,0 +1,55 @@
+module Harness
+  class Meter
+    def initialize(name)
+      @name = name
+
+      raise Harness::NoCounter, "#{@name} is not being metered" unless redis.exists key
+    end
+
+    def per_second
+      per 1.second
+    end
+
+    def per_minute
+      per 1.minute
+    end
+
+    def per_hour
+      per 1.hour
+    end
+
+    def per(rate, base = Time.now)
+      gauge = Gauge.new :value => redis.zcount(key, base.to_f - rate, base.to_f)
+
+      if words = rate_in_words(rate)
+        gauge.name = "#{@name} per #{words}"
+        gauge.id = "#{@name}-per-#{words}"
+      else
+        gauge.id = "#{@name} gauge"
+      end
+
+      gauge.time = Time.now
+
+      gauge
+    end
+
+    private
+    def key
+      "meters/#{@name}"
+    end
+
+    def redis
+      Harness.redis
+    end
+
+    def rate_in_words(rate)
+      if rate < 1.minute
+        "second"
+      elsif rate >= 1.minute && rate < 1.hour
+        "minute"
+      elsif rate >= 1.hour && rate < 1.day
+        "hour"
+      end
+    end
+  end
+end

data/lib/harness/queues/resque_queue.rb

@@ -0,0 +1,29 @@
+module Harness
+  class ResqueQueue
+    class SendGauge < Job
+      @queue = :high
+
+      def self.perform(attributes)
+        gauge = Gauge.new attributes
+        new.log gauge
+      end
+    end
+
+    class SendCounter < Job
+      @queue = :high
+
+      def self.perform(attributes)
+        counter = Counter.new attributes
+        new.log counter
+      end
+    end
+
+    def self.push(measurement)
+      if measurement.is_a? Gauge
+        Resque.enqueue SendGauge, measurement.attributes
+      elsif measurement.is_a? Counter
+        Resque.enqueue SendCounter, measurement.attributes
+      end
+    end
+  end
+end

data/lib/harness/queues/sidekiq_queue.rb

@@ -0,0 +1,29 @@
+module Harness
+  class SidekiqQueue
+    class SendGauge < Job
+      include Sidekiq::Worker
+
+      def perform(attributes)
+        gauge = Gauge.new attributes
+        log gauge
+      end
+    end
+
+    class SendCounter < Job
+      include Sidekiq::Worker
+
+      def perform(attributes)
+        counter = Counter.new attributes
+        log counter
+      end
+    end
+
+    def self.push(measurement)
+      if measurement.is_a? Gauge
+        SendGauge.perform_async measurement.attributes
+      elsif measurement.is_a? Counter
+        SendCounter.perform_async measurement.attributes
+      end
+    end
+  end
+end

data/lib/harness/queues/syncronous_queue.rb

@@ -0,0 +1,13 @@
+module Harness
+  class SyncronousQueue
+    def self.push(measurement)
+      begin
+        Harness::Job.new.log(measurement)
+      rescue LoggingError => ex
+        logger.debug "[Harness] Logging measurement failed! Server Said: #{ex}"
+        logger.debug ex.backtrace.join("\n")
+        logger.warn "[Harness] Could not post measurement! Enable debug logging to see full errors"
+      end
+    end
+  end
+end

data/lib/harness/railtie.rb

@@ -6,10 +6,6 @@ module Harness
       load "harness/tasks.rake"
     end
 
-    initializer "harness.thread" do
-      Thread.abort_on_exception = Rails.env.development? || Rails.env.test?
-    end
-
     initializer "harness.adapter" do |app|
       case Rails.env
       when 'development'
@@ -32,5 +28,27 @@ module Harness
         Harness.redis ||= Redis::Namespace.new('harness', :redis => Redis.connect(:host => 'localhost', :port => '6379'))
       end
     end
+
+    initializer "harness.queue" do
+      Harness.config.queue = Harness::SyncronousQueue
+    end
+
+    initializer "harness.queue.production" do |app|
+      use_real_queue = Rails.env != 'development' && Rails.env != 'test'
+
+      if defined?(Resque::Job) && use_real_queue
+        require 'harness/queues/resque_queue'
+        Harness.config.queue = :resque
+      elsif defined?(Sidekiq::Worker) && use_real_queue
+        require 'harness/queues/sidekiq_queue'
+        Harness.config.queue = :sidekiq
+      end
+    end
+
+    initializer "harness.sidekiq" do |app|
+      if defined? Sidekiq::Worker
+        require 'harness/integration/sidekiq'
+      end
+    end
   end
 end

data/lib/harness/version.rb

@@ -1,3 +1,3 @@
 module Harness
-  VERSION = "0.1.2"
+  VERSION = "0.2.14"
 end

data/lib/harness.rb

@@ -2,32 +2,42 @@ require "harness/version"
 
 require 'thread'
 
-require 'securerandom'
-
 require 'redis'
 require 'redis/namespace'
 
 require 'active_support/notifications'
 require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/numeric'
+require 'active_support/core_ext/integer'
 
 module Harness
   class LoggingError < RuntimeError ; end
+  class NoCounter < RuntimeError ; end
 
   class Config
-    attr_reader :adapter
-    attr_accessor :syncronous
+    attr_reader :adapter, :queue
+    attr_accessor :namespace
 
     def adapter=(val)
       if val.is_a? Symbol
-        @adapter = "Harness::#{val.to_s.classify}Adapter".constantize
+        @adapter = "Harness::#{val.to_s.camelize}Adapter".constantize
       else
         @adapter = val
       end
     end
 
+    def queue=(val)
+      if val.is_a? Symbol
+        @queue= "Harness::#{val.to_s.camelize}Queue".constantize
+      else
+        @queue= val
+      end
+    end
+
     def method_missing(name, *args, &block)
       begin
-        "Harness::#{name.to_s.classify}Adapter".constantize.config
+        "Harness::#{name.to_s.camelize}Adapter".constantize.config
       rescue NameError
         super
       end
@@ -38,25 +48,8 @@ module Harness
     @config ||= Config.new
   end
 
-  def self.queue
-    @queue ||= Queue.new
-  end
-
-  def self.consumer
-    Thread.current["#{object_id}_harness_consumer_"] ||= Consumer.new
-  end
-
   def self.log(measurement)
-    queue << measurement
-    wait if config.syncronous
-  end
-
-  def self.mutex
-    @mutex ||= Mutex.new
-  end
-
-  def self.wait
-    sleep 0.01 until consumer.finished? && queue.empty?
+    config.queue.push measurement
   end
 
   def self.logger
@@ -77,7 +70,8 @@ module Harness
 
   def self.reset_counters!
     redis.smembers('counters').each do |counter|
-      redis.set counter, -1
+      redis.set counter, 0
+      redis.del "meters/#{counter}"
     end
   end
 end
@@ -85,10 +79,13 @@ end
 require 'harness/measurement'
 require 'harness/counter'
 require 'harness/gauge'
+require 'harness/meter'
 
 require 'harness/instrumentation'
 
-require 'harness/consumer'
+require 'harness/job'
+
+require 'harness/queues/syncronous_queue'
 
 require 'harness/adapters/librato_adapter'
 require 'harness/adapters/memory_adapter'
@@ -101,8 +98,6 @@ require 'harness/integration/active_support'
 
 require 'harness/railtie' if defined?(Rails)
 
-Harness.consumer.consume
-
 require 'logger'
 
 Harness.logger = Logger.new $stdout

data/test/integration/counters_with_redis_test.rb

@@ -57,13 +57,32 @@ class CountersWithRedis < IntegrationTest
 
     Harness.reset_counters!
 
-    assert_equal -1, redis.get("event-counter").to_i
-    assert_equal -1, redis.get("event-counter2").to_i
+    assert_equal 0, redis.get("event-counter").to_i
+    assert_equal 0, redis.get("event-counter2").to_i
 
     counters.clear
     instrument "event-counter", :counter => true
     assert_counter_logged 'event-counter'
 
-    assert_equal 0, counters.first.value
+    assert_equal 1, counters.first.value
+    assert_equal 1, redis.get("event-counter").to_i
+  end
+
+  def test_resets_counters_resets_meters
+    instrument "event-counter", :counter => true
+
+    assert_equal 1, redis.get("event-counter").to_i
+    assert_equal 1, redis.zcard("meters/event-counter").to_i
+
+    Harness.reset_counters!
+
+    assert_equal 0, redis.get("event-counter").to_i
+    assert_equal 0, redis.zcard("meters/event-counter").to_i
+  end
+
+  def test_counting_updates_sorted_set_in_redis
+    instrument "event-counter", :counter => true
+
+    assert_equal 1, redis.zcard("meters/event-counter")
   end
 end

data/test/integration/instrumentation_test.rb

@@ -25,4 +25,26 @@ class ActiveSupportTestCase < IntegrationTest
     assert_counter_logged "test-counter"
     assert_gauge_logged "test-gauge"
   end
+
+  def test_does_not_log_counter_on_exception
+    begin
+      ActiveSupport::Notifications.instrument "counter_test.harness", :counter => true do |args|
+        raise
+      end
+    rescue
+    end
+
+    refute_counter_logged "counter_test.harness"
+  end
+
+  def test_does_not_log_gauge_on_exception
+    begin
+      ActiveSupport::Notifications.instrument "gauge_test.harness", :gauge => true do |args|
+        raise
+      end
+    rescue
+    end
+
+    refute_gauge_logged "gauge_test.harness"
+  end
 end

data/test/integration/integrations/action_view_test.rb

@@ -13,10 +13,20 @@ class ActionViewIntegration < IntegrationTest
     assert_gauge_logged "render_partial.action_view"
   end
 
+  def test_skips_internal_partial_events
+    instrument "!render_partial"
+
+    refute_gauge_logged "!render_partial.action_view"
+  end
+
+  def test_skips_internal_template_events
+    instrument "!render_template"
+
+    refute_gauge_logged "!render_template.action_view"
+  end
+
   private
   def instrument(event)
-    ActiveSupport::Notifications.instrument "#{event}.action_view" do |*args|
-      # nada
-    end
+    ActiveSupport::Notifications.instrument "#{event}.action_view"
   end
 end

data/test/integration/integrations/sidekiq_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+require 'sidekiq'
+require 'harness/integration/sidekiq'
+
+class SidekiqIntegrationTest < IntegrationTest
+  def middleware
+    Sidekiq::Middleware::Server::HarnessInstrumentation.new
+  end
+
+  def tests_logs_job_performance_stats
+    middleware.call("report", nil, nil) { }
+
+    assert_gauge_logged "report.sidekiq"
+    assert_counter_logged "reports.sidekiq"
+  end
+
+  def tests_logs_a_counter_of_all_jobs
+    middleware.call("reports", nil, nil) { }
+
+    assert_counter_logged "job.sidekiq"
+  end
+
+  def test_ignores_harness_jobs
+    middleware.call("Harness::SidekiqQueue::SendCounter", nil, nil) { }
+
+    assert_empty counters
+    assert_empty gauges
+
+    middleware.call("Harness::SidekiqQueue::SendGauge", nil, nil) { }
+
+    assert_empty counters
+    assert_empty gauges
+
+    middleware.call(Harness::SidekiqQueue::SendCounter, nil, nil) { }
+
+    assert_empty counters
+    assert_empty gauges
+
+    middleware.call(Harness::SidekiqQueue::SendGauge, nil, nil) { }
+
+    assert_empty counters
+    assert_empty gauges
+
+    middleware.call(Harness::SidekiqQueue::SendCounter.new, nil, nil) { }
+
+    assert_empty counters
+    assert_empty gauges
+
+    middleware.call(Harness::SidekiqQueue::SendGauge.new, nil, nil) { }
+
+    assert_empty counters
+    assert_empty gauges
+  end
+end

data/test/integration/meter_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class CountersWithRedis < IntegrationTest
+  def test_counters_can_act_like_gauges
+    50.times { instrument "event-counter", :counter => true }
+
+    meter = Harness::Meter.new 'event-counter'
+    assert_equal 50, meter.per_second.value
+    assert_equal 50, meter.per_minute.value
+    assert_equal 50, meter.per_hour.value
+  end
+
+  def tests_raises_an_error_when_no_such_counter
+    assert_raises Harness::NoCounter do
+      Harness::Meter.new 'unknown-counter'
+    end
+  end
+
+  def test_rates_return_gauges
+    50.times { instrument "event-counter", :counter => true }
+
+    meter = Harness::Meter.new 'event-counter'
+
+    gauge = meter.per_second
+
+    assert_kind_of Harness::Gauge, gauge
+
+    assert_equal "event-counter-per-second", gauge.id
+    assert_equal "event-counter per second", gauge.name
+    assert_kind_of Time, gauge.time
+  end
+end

data/test/integration/queues/resque_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+require 'harness/queues/resque_queue'
+
+class ResqueTest < IntegrationTest
+  def setup
+    super
+    Resque.inline = true
+    Harness.config.queue = :resque
+  end
+
+  def test_a_gauge_is_logged
+    instrument "test-gauge", :gauge => true
+
+    assert_gauge_logged "test-gauge"
+  end
+
+  def test_a_counter_is_logged
+    instrument "test-counter", :counter => true
+
+    assert_counter_logged "test-counter"
+
+    assert_equal 1, counters.first.value
+  end
+end

data/test/integration/queues/sidekiq_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'harness/queues/sidekiq_queue'
+require 'sidekiq/testing'
+
+class SidekiqTest < IntegrationTest
+  def setup
+    super
+    Harness.config.queue = :sidekiq
+  end
+
+  def test_a_gauge_is_logged
+    instrument "test-gauge", :gauge => true
+
+    refute_empty Harness::SidekiqQueue::SendGauge.jobs
+
+    args = Harness::SidekiqQueue::SendGauge.jobs.first['args'].first
+    Harness::SidekiqQueue::SendGauge.new.perform args
+
+    assert_gauge_logged "test-gauge"
+  end
+
+  def test_a_counter_is_logged
+    instrument "test-counter", :counter => true
+
+    refute_empty Harness::SidekiqQueue::SendCounter.jobs
+
+    args = Harness::SidekiqQueue::SendCounter.jobs.first['args'].first
+    Harness::SidekiqQueue::SendCounter.new.perform args
+
+    assert_counter_logged "test-counter"
+
+    assert_equal 1, counters.first.value
+  end
+end

data/test/test_helper.rb

@@ -1,6 +1,9 @@
 require 'simplecov'
 SimpleCov.start
 
+require 'resque'
+require 'sidekiq'
+
 require 'harness'
 
 require 'minitest/unit'
@@ -11,10 +14,6 @@ require 'webmock/minitest'
 
 WebMock.disable_net_connect!
 
-Thread.abort_on_exception = true
-
-Harness.config.syncronous = true
-
 Harness.logger = Logger.new '/dev/null'
 
 Harness.redis = Redis::Namespace.new 'harness-test', :redis => Redis.connect(:host => 'localhost', :port => '6379')
@@ -22,6 +21,8 @@ Harness.redis = Redis::Namespace.new 'harness-test', :redis => Redis.connect(:ho
 class IntegrationTest < MiniTest::Unit::TestCase
   def setup
     Harness.config.adapter = :memory
+    Harness.config.queue = :syncronous
+
     gauges.clear ; counters.clear
     redis.flushall
   end
@@ -34,6 +35,14 @@ class IntegrationTest < MiniTest::Unit::TestCase
     refute_empty counters.select {|c| c.name = name }, "Expected #{counters.inspect} to contain a #{name} result"
   end
 
+  def refute_gauge_logged(name)
+    assert_empty gauges.select {|g| g.name = name }, "No gauge expected to be logged"
+  end
+
+  def refute_counter_logged(name)
+    assert_empty counters.select {|c| c.name = name }, "No counter expected to be logged"
+  end
+
   def gauges
     Harness::MemoryAdapter.gauges
   end

data/test/unit/adapters/librato_adapter_test.rb

@@ -21,13 +21,7 @@ class LibratoAdapterTest < MiniTest::Unit::TestCase
 
     Harness::LibratoAdapter.config.email = email
     Harness::LibratoAdapter.config.token = token
-  end
-
-  def teardown
-    WebMock.reset!
-
-    Harness::LibratoAdapter.config.email = nil
-    Harness::LibratoAdapter.config.token = nil
+    Harness.config.namespace = nil
   end
 
   def test_gauge_is_logged
@@ -50,12 +44,12 @@ class LibratoAdapterTest < MiniTest::Unit::TestCase
     assert_requested expected_request
   end
 
-  def test_gauge_id_is_sanitized
-    @gauge.id = "process_action.action_controller"
+  def test_gauge_is_logged_with_namespace
+    Harness.config.namespace = :foo
 
     json = {
       :gauges => [{
-        :name => "process_action-action_controller",
+        :name => "#{@gauge.id}.foo",
         :display_name => @gauge.name,
         :value => @gauge.value,
         :measure_time => @gauge.time.to_i,
@@ -72,7 +66,6 @@ class LibratoAdapterTest < MiniTest::Unit::TestCase
     assert_requested expected_request
   end
 
-
   def test_logging_gague_raises_an_exception
     stub_request(:post, %r{metrics}).to_return(:status => 500, :body => "message")
 
@@ -118,12 +111,12 @@ class LibratoAdapterTest < MiniTest::Unit::TestCase
     assert_requested expected_request
   end
 
-  def test_counter_id_is_sanitized
-    @counter.id = "total_requests.action_controller"
+  def test_counter_is_logged_with_namespace
+    Harness.config.namespace = :foo
 
     json = {
       :counters => [{
-        :name => "total_requests-action_controller",
+        :name => "#{@counter.id}.foo",
         :display_name => @counter.name,
         :value => @counter.value,
         :measure_time => @counter.time.to_i,

data/test/unit/counter_test.rb

@@ -59,6 +59,16 @@ class CounterTest < MiniTest::Unit::TestCase
 
     counter = Harness::Counter.from_event event
 
+    assert_equal 'foo', counter.id
+  end
+
+   def test_sets_id_from_payload_if_string
+    base = Time.now
+
+    event = ActiveSupport::Notifications::Event.new "name", base - 1, Time.now, nil, :counter => 'foo'
+
+    counter = Harness::Counter.from_event event
+
     assert_equal 'foo', counter.id
   end
 end

data/test/unit/gauge_test.rb

@@ -55,6 +55,16 @@ class GaugeTest < MiniTest::Unit::TestCase
     assert_equal 'foo', gauge.id
   end
 
+  def test_sets_id_from_payload_if_string
+    base = Time.now
+
+    event = ActiveSupport::Notifications::Event.new "name", base - 1, Time.now, nil, :gauge => 'foo'
+
+    gauge = Harness::Gauge.from_event event
+
+    assert_equal 'foo', gauge.id
+  end
+
   def test_initializes_time_if_not_set
     gauge = Harness::Gauge.new
 

data/test/unit/harness_test.rb

@@ -13,6 +13,18 @@ class HarnessModuleTest < MiniTest::Unit::TestCase
     assert_equal Harness::MemoryAdapter, Harness.config.adapter
   end
 
+  def test_can_set_the_queue_with_a_symbol
+    Harness.config.queue = :syncronous
+
+    assert_equal Harness::SyncronousQueue, Harness.config.queue
+  end
+
+  def test_can_set_the_queue_with_a_class
+    Harness.config.adapter = Harness::SyncronousQueue
+
+    assert_equal Harness::SyncronousQueue, Harness.config.queue
+  end
+
   def test_uses_method_missing_to_configure_adapters
     Harness.config.librato.email = 'foo'
 

data/test/unit/measurement_test.rb

@@ -33,4 +33,37 @@ class MeasurementTest < MiniTest::Unit::TestCase
   def test_initializes_time
     assert @measurement.time
   end
+
+  def test_can_take_a_string_time
+    @measurement.time = "2010-10-1T15:15:15Z"
+
+    assert_equal DateTime.parse("2010-10-1T15:15:15Z"), @measurement.time
+  end
+
+  def test_can_take_an_integer_time
+    time = Time.now
+
+    @measurement.time = time.to_i
+
+    assert_equal time.to_i, @measurement.time.to_i
+  end
+
+  def test_can_take_a_time
+    time = Time.now
+
+    @measurement.time = time
+
+    assert_equal time, @measurement.time
+  end
+
+  def test_attributes
+    hash = @measurement.attributes
+
+    assert hash.has_key?(:id)
+    assert hash.has_key?(:name)
+    assert hash.has_key?(:source)
+    assert hash.has_key?(:time)
+    assert hash.has_key?(:units)
+    assert hash.has_key?(:value)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harness
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70328784097540 !ruby/object:Gem::Requirement
+  requirement: &70133381445980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70328784097540
+  version_requirements: *70133381445980
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70328784097120 !ruby/object:Gem::Requirement
+  requirement: &70133381445320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70328784097120
+  version_requirements: *70133381445320
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70328784096660 !ruby/object:Gem::Requirement
+  requirement: &70133381444680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70328784096660
+  version_requirements: *70133381444680
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70328784096240 !ruby/object:Gem::Requirement
+  requirement: &70133381443920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328784096240
+  version_requirements: *70133381443920
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70328784095820 !ruby/object:Gem::Requirement
+  requirement: &70133381443020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328784095820
+  version_requirements: *70133381443020
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70133381441920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133381441920
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: &70133381441440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133381441440
 description: ''
 email:
 - me@broadcastingadam.com
@@ -91,7 +113,13 @@ files:
 - lib/harness/integration/action_mailer.rb
 - lib/harness/integration/action_view.rb
 - lib/harness/integration/active_support.rb
+- lib/harness/integration/sidekiq.rb
+- lib/harness/job.rb
 - lib/harness/measurement.rb
+- lib/harness/meter.rb
+- lib/harness/queues/resque_queue.rb
+- lib/harness/queues/sidekiq_queue.rb
+- lib/harness/queues/syncronous_queue.rb
 - lib/harness/railtie.rb
 - lib/harness/tasks.rake
 - lib/harness/version.rb
@@ -101,7 +129,11 @@ files:
 - test/integration/integrations/action_mailer_test.rb
 - test/integration/integrations/action_view_test.rb
 - test/integration/integrations/active_support_test.rb
+- test/integration/integrations/sidekiq_test.rb
 - test/integration/logging_test.rb
+- test/integration/meter_test.rb
+- test/integration/queues/resque_test.rb
+- test/integration/queues/sidekiq_test.rb
 - test/test_helper.rb
 - test/unit/adapters/librato_adapter_test.rb
 - test/unit/adapters/memory_adapter_test.rb
@@ -109,6 +141,7 @@ files:
 - test/unit/gauge_test.rb
 - test/unit/harness_test.rb
 - test/unit/measurement_test.rb
+- test/unit/meter_test.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -140,7 +173,11 @@ test_files:
 - test/integration/integrations/action_mailer_test.rb
 - test/integration/integrations/action_view_test.rb
 - test/integration/integrations/active_support_test.rb
+- test/integration/integrations/sidekiq_test.rb
 - test/integration/logging_test.rb
+- test/integration/meter_test.rb
+- test/integration/queues/resque_test.rb
+- test/integration/queues/sidekiq_test.rb
 - test/test_helper.rb
 - test/unit/adapters/librato_adapter_test.rb
 - test/unit/adapters/memory_adapter_test.rb
@@ -148,3 +185,4 @@ test_files:
 - test/unit/gauge_test.rb
 - test/unit/harness_test.rb
 - test/unit/measurement_test.rb
+- test/unit/meter_test.rb