harness 0.2.16 → 0.3.0

data/README.md

@@ -194,7 +194,16 @@ Harness.redis = Redis.new
 ## Rails Integration
 
 Harness will automatically log metrics coming from `ActionPack`,
-`ActiveRecord`, `ActiveSupport` and `ActionMailer`.
+`ActiveRecord`, and `ActionMailer`. `ActiveSupport` instrumentation is
+disabled by default. Also, custom integrations are disabled by default.
+You can turn on instrumentation for specific components like so:
+
+```ruby
+config.harness.instrument.action_controller = false
+config.harness.instrument.active_support = true
+config.harness.instrument.sidekiq = true
+config.harness.instrument.active_model_serializers = true
+```
 
 You can configure Harness from `application.rb`
 

data/harness.gemspec

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

data/lib/harness.rb

@@ -1,7 +1,5 @@
 require "harness/version"
 
-require 'thread'
-
 require 'redis'
 require 'redis/namespace'
 
@@ -11,6 +9,8 @@ require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/numeric'
 require 'active_support/core_ext/integer'
 
+require 'active_support/ordered_options'
+
 module Harness
   class LoggingError < RuntimeError ; end
   class NoCounter < RuntimeError ; end
@@ -18,6 +18,11 @@ module Harness
   class Config
     attr_reader :adapter, :queue
     attr_accessor :namespace
+    attr_reader :instrument
+
+    def initialize
+      @instrument = ActiveSupport::OrderedOptions.new
+    end
 
     def adapter=(val)
       if val.is_a? Symbol

data/lib/harness/integration/active_model_serializers.rb

@@ -0,0 +1,9 @@
+events = %w(serializable_hash associations)
+
+events.each do |name|
+  ActiveSupport::Notifications.subscribe %r{^#{name}.*\.serializer$} do |*args|
+    event = ActiveSupport::Notifications::Event.new(*args)
+    gauge = Harness::Gauge.from_event event
+    gauge.log
+  end
+end

data/lib/harness/railtie.rb

@@ -2,6 +2,19 @@ module Harness
   class Railtie < ::Rails::Railtie
     config.harness = Harness.config
 
+    # Set default instrumentation
+    config.harness.instrument.action_controller = true
+    config.harness.instrument.action_mailer = true
+    config.harness.instrument.action_view = true
+
+    config.harness.instrument.active_support = false
+
+    # Custom instrumentation can be turned on as follows
+    # See files in lib/harness/integration for available integrations
+    #
+    # config.harness.insturment.sidekiq = true
+    # config.harness.insturment.active_model_serializers = true
+
     rake_tasks do
       load "harness/tasks.rake"
     end
@@ -45,11 +58,9 @@ module Harness
       end
     end
 
-    initializer "harness.sidekiq" do |app|
-      use_real_queue = Rails.env != 'development' && Rails.env != 'test'
-
-      if defined?(Sidekiq::Worker) && use_real_queue
-        require 'harness/integration/sidekiq'
+    initializer "harness.instrumentation" do |app|
+      app.config.harness.instrument.each_pair do |integration, value|
+        require "harness/integration/#{integration}" if value
       end
     end
   end

data/lib/harness/version.rb

@@ -1,3 +1,3 @@
 module Harness
-  VERSION = "0.2.16"
+  VERSION = "0.3.0"
 end

data/test/integration/integrations/active_model_serializers_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require 'harness/integration/active_model_serializers'
+
+class ActiveModelSerializerIntegration < IntegrationTest
+  def test_serializable_hash_is_logged
+    instrument "serializable_hash"
+
+    assert_gauge_logged "serializable_hash.serializer"
+  end
+
+  def test_serializing_associations_is_logged
+    instrument "associations"
+
+    assert_gauge_logged "associations.serializer"
+  end
+
+  def instrument(event)
+    ActiveSupport::Notifications.instrument "#{event}.serializer" do |*args|
+      # nada
+    end
+  end
+end

data/test/integration/railtie_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require 'rails'
+require 'action_controller/railtie'
+require 'harness/railtie'
+
+class TestRailsApp < Rails::Application
+  config.active_support.deprecation = proc { |message, stack| }
+  initialize!
+end
+
+class RailtieTest < MiniTest::Unit::TestCase
+  def app
+    TestRailsApp
+  end
+
+  def test_configures_instrumentation
+    assert app.config.harness.instrument.action_controller
+    assert app.config.harness.instrument.action_mailer
+    assert app.config.harness.instrument.action_view
+    refute app.config.harness.instrument.active_support
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: harness
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70318611903480 !ruby/object:Gem::Requirement
+  requirement: &70133152109020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70318611903480
+  version_requirements: *70133152109020
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70318611903060 !ruby/object:Gem::Requirement
+  requirement: &70133152107200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318611903060
+  version_requirements: *70133152107200
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70318611902580 !ruby/object:Gem::Requirement
+  requirement: &70133152104740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70318611902580
+  version_requirements: *70133152104740
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70318611902140 !ruby/object:Gem::Requirement
+  requirement: &70133152152020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70318611902140
+  version_requirements: *70133152152020
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70318611901720 !ruby/object:Gem::Requirement
+  requirement: &70133152149760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70318611901720
+  version_requirements: *70133152149760
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70318611901300 !ruby/object:Gem::Requirement
+  requirement: &70133152148660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70318611901300
+  version_requirements: *70133152148660
 - !ruby/object:Gem::Dependency
   name: sidekiq
-  requirement: &70318611900880 !ruby/object:Gem::Requirement
+  requirement: &70133152148020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70318611900880
+  version_requirements: *70133152148020
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: &70133152146920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133152146920
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70133152145560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70133152145560
 description: ''
 email:
 - me@broadcastingadam.com
@@ -112,6 +134,7 @@ files:
 - lib/harness/integration/action_controller.rb
 - lib/harness/integration/action_mailer.rb
 - lib/harness/integration/action_view.rb
+- lib/harness/integration/active_model_serializers.rb
 - lib/harness/integration/active_support.rb
 - lib/harness/integration/sidekiq.rb
 - lib/harness/job.rb
@@ -128,12 +151,14 @@ files:
 - test/integration/integrations/action_controller_test.rb
 - test/integration/integrations/action_mailer_test.rb
 - test/integration/integrations/action_view_test.rb
+- test/integration/integrations/active_model_serializers_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/integration/railtie_test.rb
 - test/test_helper.rb
 - test/unit/adapters/librato_adapter_test.rb
 - test/unit/adapters/memory_adapter_test.rb
@@ -172,12 +197,14 @@ test_files:
 - test/integration/integrations/action_controller_test.rb
 - test/integration/integrations/action_mailer_test.rb
 - test/integration/integrations/action_view_test.rb
+- test/integration/integrations/active_model_serializers_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/integration/railtie_test.rb
 - test/test_helper.rb
 - test/unit/adapters/librato_adapter_test.rb
 - test/unit/adapters/memory_adapter_test.rb