nunes 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bddc1e5791272becd4a0272db00372b590bb27a6
-  data.tar.gz: 795aac98c9ba8a5194ad8128a0df8401637a0f6f
+  metadata.gz: 519721bdfa50f41504919cb7a153d5be9bf0ccd2
+  data.tar.gz: 6b912ad6b4fbafdc54fe19e5bc0de7c986f3ab77
 SHA512:
-  metadata.gz: 778bf582c222528abf705cf0710bf36809b13c9fadf52ca2d9c93c9968b7b25df8f88a32df4785279431e4bdb8c5901ef4da88ef8c42e345cb5e2c60596999b7
-  data.tar.gz: 2938ce75643befd9904221fe48be7a6dc77d88906c7e980d32eb2b2b6466fd385cfca7b41092a20b4f82b68f2e136280dbe0c69f628c7bc4b0ddabd4043a34d4
+  metadata.gz: 76cc5998cd987b32faa08bfc2607c56c3e913294ebd26a57a853ce2a31699e3b98901920b95f96b130cf6d148c3b8f879bb0f5b375cb00a659e503113d7cf59a
+  data.tar.gz: 48c54dd8a5bdf5a8c1d26e3f9cdb6533bd07e6fb5b0cda62bef195c8d96c5f2a8284aa77ef730e03f1234db78db6932f803837db4d46b41d4e9012640285f8c6

data/.travis.yml

@@ -1,9 +1,17 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.1.0
-  - 2.2.0
-notifications:
-  email: false
-bundler_args: --without guard
-script: script/test
+  - 2.0.0
+  - 2.1.10
+  - 2.2.5
+bundler_args: --without guard watch bench
+script: bundle exec rake
+env:
+  - RAILS_VERSION=4.2.5
+  - RAILS_VERSION=5.0.0
+matrix:
+  # don't run rails 5 on ruby versions that can't install rack 2
+  exclude:
+    - rvm: 2.0.0
+      env: RAILS_VERSION=5.0.0
+    - rvm: 2.1.10
+      env: RAILS_VERSION=5.0.0

data/Changelog.md

@@ -1,3 +1,11 @@
+# 0.5.0
+
+* no longer doing underscore on active job class name when instrumenting it (ie: active_job.spam_detector_job.perform changed to active_job.SpamDetectorJob.perform)
+* drop ruby 1.9 support
+* ruby namespaces are now converted to dash instead of dot in metric namespace (https://github.com/jnunemaker/nunes/pull/27)
+* allow disabling view/db runtime, format and exception instrumentation
+* official support for rails 5
+
 # 0.4.0
 
 ## Backwards Compatibility Break

data/Gemfile

@@ -1,7 +1,7 @@
 source "https://rubygems.org"
 gemspec
 
-gem "rails", "~> 4.2.0"
+gem "rails", "~> #{ENV["RAILS_VERSION"] || '4.2.5'}"
 gem "sqlite3", "~> 1.3.7"
 gem "minitest", "~> 5.1"
 gem "rake", "~> 10.0.4"

data/README.md

@@ -18,8 +18,8 @@ Or install it yourself as:
 
 ## Compatibility
 
-* >= Ruby 1.9
-* Rails 4.2.x
+* >= Ruby 2.0
+* Rails 4.2.x, 5.0.x
 
 Note: you can use v0.3.1 is for rails 3.2.x support.
 
@@ -74,7 +74,6 @@ Based on those events, you'll get metrics like this in instrumental and statsd:
 * `action_controller.format.html`
 * `action_controller.controller.Admin.PostsController.new.status.403`
 * `action_controller.controller.Admin.PostsController.index.format.json`
-* `action_controller.exception.RuntimeError` - where RuntimeError is the class of any exceptions that occur while processing a controller's action.
 * `active_support.cache.hit`
 * `active_support.cache.miss`
 

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs = ["lib", "test"]
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/lib/nunes.rb

@@ -37,4 +37,16 @@ module Nunes
 
     subscribers
   end
+
+  # Private: What ruby uses to separate namespaces.
+  NAMESPACE_SEPARATOR = "::".freeze
+
+  # Private: What nunes uses to separate namespaces in the metric.
+  METRIC_NAMESPACE_SEPARATOR = "-".freeze
+
+  # Private: Converts a class to a metric safe name.
+  def self.class_to_metric(class_or_class_name)
+    return if class_or_class_name.nil?
+    class_or_class_name.to_s.gsub(NAMESPACE_SEPARATOR, METRIC_NAMESPACE_SEPARATOR)
+  end
 end

data/lib/nunes/adapter.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/class/subclasses'
+
 module Nunes
   class Adapter
     # Private: Wraps a given object with the correct adapter/decorator.
@@ -55,10 +57,10 @@ module Nunes
     ReplaceRegex = /[^a-z0-9\-_]+/i
 
     # Private: The default metric namespace separator.
-    Separator = "."
+    Separator = ".".freeze
 
     # Private
-    Nothing = ""
+    Nothing = "".freeze
 
     # Private: Prepare a metric name before it is sent to the adapter's client.
     def prepare(metric, replacement = Separator)

data/lib/nunes/instrumentable.rb

@@ -24,7 +24,7 @@ module Nunes
         if name.nil?
           raise ArgumentError, "For class methods you must provide the full name of the metric."
         else
-          "#{name}.#{method_name}"
+          "#{::Nunes.class_to_metric(name)}.#{method_name}"
         end
       }
 

data/lib/nunes/subscriber.rb

@@ -3,7 +3,10 @@ require "active_support/notifications"
 module Nunes
   class Subscriber
     # Private: The bang character that is the first char of some events.
-    BANG = '!'
+    BANG = "!".freeze
+
+    # Private: The dot charactor used to determine the method name.
+    DOT = ".".freeze
 
     # Public: Setup a subscription for the subscriber using the
     # provided adapter.
@@ -34,7 +37,7 @@ module Nunes
       # when in production
       return if name.start_with?(BANG)
 
-      method_name = name.split('.').first
+      method_name = name.split(DOT).first
 
       if respond_to?(method_name)
         send(method_name, start, ending, transaction_id, payload)

data/lib/nunes/subscribers/action_controller.rb

@@ -11,46 +11,73 @@ module Nunes
         Pattern
       end
 
-      def process_action(start, ending, transaction_id, payload)
-        controller = payload[:controller]
-        action = payload[:action]
-        status = payload[:status]
-        exception_info = payload[:exception]
+      class << self
+        attr_accessor :instrument_format
+        attr_accessor :instrument_view_runtime
+        attr_accessor :instrument_db_runtime
+      end
 
-        format = payload[:format] || "all"
-        format = "all" if format == "*/*"
+      # Public: Should we instrument the number of requests per format overall and per controller/action.
+      self.instrument_format = true
 
-        db_runtime = payload[:db_runtime]
-        db_runtime = db_runtime.round if db_runtime
+      # Public: Should we instrument the view runtime overall and per controller/action.
+      self.instrument_view_runtime = true
 
-        view_runtime = payload[:view_runtime]
-        view_runtime = view_runtime.round if view_runtime
+      # Public: Should we instrument the db runtime overall and per controller/action.
+      self.instrument_db_runtime = true
 
+      def process_action(start, ending, transaction_id, payload)
         runtime = ((ending - start) * 1_000).round
-
         timing "action_controller.runtime.total", runtime
-        timing "action_controller.runtime.view", view_runtime if view_runtime
-        timing "action_controller.runtime.db",   db_runtime   if db_runtime
 
-        increment "action_controller.format.#{format}" if format
+        status = payload[:status]
         increment "action_controller.status.#{status}" if status
 
+        controller = ::Nunes.class_to_metric(payload[:controller])
+        action = payload[:action]
+
         if controller && action
-          namespace = "action_controller.controller.#{controller}.#{action}"
+          timing "action_controller.controller.#{controller}.#{action}.runtime.total", runtime
+          increment "action_controller.controller.#{controller}.#{action}.status.#{status}" if status
+        end
 
-          timing "#{namespace}.runtime.total",      runtime
-          timing "#{namespace}.runtime.view", view_runtime if view_runtime
-          timing "#{namespace}.runtime.db",   db_runtime   if db_runtime
+        if self.class.instrument_view_runtime
+          view_runtime = payload[:view_runtime]
+          view_runtime = view_runtime.round if view_runtime
 
-          increment "#{namespace}.format.#{format}" if format
-          increment "#{namespace}.status.#{status}" if status
+          if view_runtime
+            timing "action_controller.runtime.view", view_runtime
 
+            if controller && action
+              timing "action_controller.controller.#{controller}.#{action}.runtime.view", view_runtime
+            end
+          end
         end
 
-        if exception_info
-          exception_class, exception_message = exception_info
+        if self.class.instrument_db_runtime
+          db_runtime = payload[:db_runtime]
+          db_runtime = db_runtime.round if db_runtime
+
+          if db_runtime
+            timing "action_controller.runtime.db", db_runtime
+
+            if controller && action
+              timing "action_controller.controller.#{controller}.#{action}.runtime.db", db_runtime
+            end
+          end
+        end
+
+        if self.class.instrument_format
+          format = payload[:format] || "all"
+          format = "all" if format == "*/*"
+
+          if format
+            increment "action_controller.format.#{format}"
 
-          increment "action_controller.exception.#{exception_class}"
+            if controller && action
+              increment "action_controller.controller.#{controller}.#{action}.format.#{format}"
+            end
+          end
         end
       end
 

data/lib/nunes/subscribers/action_mailer.rb

@@ -13,7 +13,7 @@ module Nunes
 
       def deliver(start, ending, transaction_id, payload)
         runtime = ((ending - start) * 1_000).round
-        mailer = payload[:mailer]
+        mailer = ::Nunes.class_to_metric(payload[:mailer])
 
         if mailer
           timing "action_mailer.deliver.#{mailer}", runtime
@@ -22,7 +22,7 @@ module Nunes
 
       def receive(start, ending, transaction_id, payload)
         runtime = ((ending - start) * 1_000).round
-        mailer = payload[:mailer]
+        mailer = ::Nunes.class_to_metric(payload[:mailer])
 
         if mailer
           timing "action_mailer.receive.#{mailer}", runtime

data/lib/nunes/subscribers/action_view.rb

@@ -30,14 +30,17 @@ module Nunes
       end
 
       # Private: What to replace file separators with.
-      FileSeparatorReplacement = "_"
+      FileSeparatorReplacement = "_".freeze
+
+      # Private: An empty string.
+      Nothing = "".freeze
 
       # Private: Converts an identifier to a metric name. Strips out the rails
       # root from the full path.
       #
       # identifier - The String full path to the template or partial.
       def identifier_to_metric(kind, identifier)
-        view_path = identifier.to_s.gsub(::Rails.root.to_s, "")
+        view_path = identifier.to_s.gsub(::Rails.root.to_s, Nothing)
         metric = adapter.prepare(view_path, FileSeparatorReplacement)
         "action_view.#{kind}.#{metric}"
       end

data/lib/nunes/subscribers/active_job.rb

@@ -13,16 +13,15 @@ module Nunes
 
       def perform(start, ending, transaction_id, payload)
         runtime = ((ending - start) * 1_000).round
-        job = payload[:job].class.to_s.underscore
+        job = ::Nunes.class_to_metric(payload[:job].class)
 
         timing "active_job.#{job}.perform", runtime
       end
 
       def enqueue(start, ending, transaction_id, payload)
-        job = payload[:job].class.to_s.underscore
+        job = ::Nunes.class_to_metric(payload[:job].class)
         increment "active_job.#{job}.enqueue"
       end
     end
   end
 end
-

data/lib/nunes/subscribers/active_record.rb

@@ -11,11 +11,14 @@ module Nunes
         Pattern
       end
 
+      # Private: Used to detect the operation from the sql.
+      Space = " ".freeze
+
       def sql(start, ending, transaction_id, payload)
         runtime = ((ending - start) * 1_000).round
         name = payload[:name]
         sql = payload[:sql].to_s.strip
-        operation = sql.split(' ', 2).first.to_s.downcase
+        operation = sql.split(Space, 2).first.to_s.downcase
 
         timing "active_record.sql", runtime
 

data/lib/nunes/version.rb

@@ -1,3 +1,3 @@
 module Nunes
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/script/test

@@ -1,15 +1,7 @@
 #!/bin/sh
-#/ Usage: test [individual test file]
+#/ Usage: test
 #/
-#/ Bootstrap and run all tests or an individual test.
-#/
-#/ Examples:
-#/
-#/   # run all tests
-#/   test
-#/
-#/   # run individual test
-#/   test test/controller_instrumentation_test.rb
+#/ Bootstrap and run all tests.
 #/
 
 set -e
@@ -20,6 +12,11 @@ cd $(dirname "$0")/..
     exit 0
 }
 
-script/bootstrap && ruby -I lib -I test -r rubygems \
-  -e 'require "bundler/setup"' \
-  -e '(ARGV.empty? ? Dir["test/**/*_test.rb"] : ARGV).each { |f| load f }' -- "$@"
+export RAILS_VERSION=5.0.0
+script/bootstrap || bundle update
+bundle exec rake
+
+
+export RAILS_VERSION=4.2.5
+script/bootstrap || bundle update
+bundle exec rake

data/test/controller_instrumentation_test.rb

@@ -23,10 +23,12 @@ class ControllerInstrumentationTest < ActionController::TestCase
     assert_counter "action_controller.format.html"
 
     assert_timer "action_controller.runtime.total"
+    assert_timer "action_controller.runtime.db"
     assert_timer "action_controller.runtime.view"
 
     assert_timer "action_controller.controller.PostsController.index.runtime.total"
     assert_timer "action_controller.controller.PostsController.index.runtime.view"
+    assert_timer "action_controller.controller.PostsController.index.runtime.db"
   end
 
   test "send_data" do
@@ -67,8 +69,8 @@ class ControllerInstrumentationTest < ActionController::TestCase
     assert_timer "action_controller.runtime.total"
     assert_timer "action_controller.controller.PostsController.some_redirect.runtime.total"
 
-    assert_no_timer "action_controller.runtime.view"
-    assert_no_timer "action_controller.controller.PostsController.some_redirect.runtime.view"
+    refute_timer "action_controller.runtime.view"
+    refute_timer "action_controller.controller.PostsController.some_redirect.runtime.view"
   end
 
   test "action with exception" do
@@ -76,13 +78,53 @@ class ControllerInstrumentationTest < ActionController::TestCase
 
     assert_response :success
 
-    assert_counter "action_controller.exception.RuntimeError"
     assert_counter "action_controller.format.html"
 
     assert_timer "action_controller.runtime.total"
     assert_timer "action_controller.controller.PostsController.some_boom.runtime.total"
 
-    assert_no_timer "action_controller.runtime.view"
-    assert_no_timer "action_controller.controller.PostsController.some_boom.runtime.view"
+    refute_timer "action_controller.runtime.view"
+    refute_timer "action_controller.controller.PostsController.some_boom.runtime.view"
+  end
+
+  test "with instrument format disabled" do
+    begin
+      original_format_enabled = Nunes::Subscribers::ActionController.instrument_format
+      Nunes::Subscribers::ActionController.instrument_format = false
+
+      get :index
+
+      refute_counter "action_controller.format.html"
+    ensure
+      Nunes::Subscribers::ActionController.instrument_format = original_format_enabled
+    end
+  end
+
+  test "with instrument db runtime disabled" do
+    begin
+      original_format_enabled = Nunes::Subscribers::ActionController.instrument_db_runtime
+      Nunes::Subscribers::ActionController.instrument_db_runtime = false
+
+      get :index
+
+      refute_timer "action_controller.runtime.db"
+      refute_timer "action_controller.controller.PostsController.index.runtime.db"
+    ensure
+      Nunes::Subscribers::ActionController.instrument_db_runtime = original_format_enabled
+    end
+  end
+
+  test "with instrument view runtime disabled" do
+    begin
+      original_format_enabled = Nunes::Subscribers::ActionController.instrument_view_runtime
+      Nunes::Subscribers::ActionController.instrument_view_runtime = false
+
+      get :index
+
+      refute_timer "action_controller.runtime.view"
+      refute_timer "action_controller.controller.PostsController.index.runtime.view"
+    ensure
+      Nunes::Subscribers::ActionController.instrument_view_runtime = original_format_enabled
+    end
   end
 end