copperegg-apm 1.0.0.pre1 → 1.0.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53c18884499d7d5cb6bcbc25cf3343c60347926d
-  data.tar.gz: db57ee020032965afd5b93c00379a66faf594580
+  metadata.gz: 01666a19555290a47e741f5884e7afe8b5e5c0c7
+  data.tar.gz: a0f33f3a3ed6913846fc8c28dbcd767f5b23a19b
 SHA512:
-  metadata.gz: 334e0e654618769b5bf5c524c092e7585cd9ebf7700ba3e0f87c8f042876a7a614f2b2e2033f2918a9c1bf01e4b7ab857429c1f7380fdd2625e9f0c94000f10c
-  data.tar.gz: ac15445e1ec1e33cc262a58c97d133e8b2c0e854b3d0d10738e234ae12b79cc4e8db5f835c658fd5d3fe37f49560c0781b205845c91952317b95b48d060bd4e2
+  metadata.gz: a571b109adf12783cae3e8c3ae67704eee8590dcf8e6d0a28c29166c17acb1a19711d60c0cd1f0ec938e93ebc8c5291d66f4c6f82455ae16939cea13d3c56ca5
+  data.tar.gz: 48ed4e805a26421b8bd3260e78f4b20833e8a60d855dac893613d7818b1479358069a245f5bd5df2bd4abd7b3bfcf9ce8935e0b732e1c9d5a9a37fa56a32e271

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    copperegg-apm (1.0.0.pre1)
+    copperegg-apm (1.0.0.pre2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -62,17 +62,17 @@ end
 
 ### Automatic Method Benchmarking
 
-For performance reasons, automatic method benchmarking is disabled by default. When enabled, *CopperEgg::APM* intelligently adds benchmarking to public and protected methods defined within your codebase. By default, methods whose names begin with an underscore (_) or end with a question mark (?) are not benchmarked.
+For performance reasons, automatic method benchmarking is disabled by default. When enabled, `CopperEgg::APM` intelligently adds benchmarking to public and protected methods defined within your codebase. By default, methods whose names begin with an underscore (_) or end with a question mark (?) are not benchmarked.
 
 #### Configuring Automatic Method Benchmarking
 
-Automatic method benchmarking is enabled by calling `config.benchmark_methods` within the configuration block. It expects a level which is represented by a symbol whose value is either :disabled, :basic, :moderate, :full, or :custom.
+Automatic method benchmarking is enabled by calling `config.benchmark_methods` within the configuration block. It expects a level which is represented by a symbol whose value is either `:disabled`, `:basic`, `:moderate`, `:full`, or `:custom`.
 
-The levls *basic* and *moderate* are Rails-specific. With the *basic* level only controller methods are automatically benchmarked. The *moderate* level benchmarks all controller methods as well as methods of classes that descend from *ActiveRecord::Base*. Note that for controller actions, benchmarks also include rendering time.
+The levels `:basic` and `:moderate` are Rails-specific. With the `:basic` level only controller methods are automatically benchmarked. The `:moderate` level benchmarks all controller methods as well as methods of classes that descend from *ActiveRecord::Base*. Note that for controller actions, benchmarks also include rendering time.
 
-A level *full* benchmarks all methods within your project. For non-Rails projects, the *basic* and *moderate* levels will behave like the *full* level.
+A level `:full` benchmarks all methods within your project. For non-Rails projects, the `:basic` and `:moderate` levels will behave like the `:full` level.
 
-The *custom* level allows you to explicitly set which methods to benchmark. When setting `benchmark_methods` to :custom a second argument is expected which is an array of strings representing the methods to benchmark. The format of these strings is explained in the following section.
+The `:custom` level allows you to explicitly set which methods to benchmark. When setting `benchmark_methods` to :custom a second argument is expected which is an array of strings representing the methods to benchmark. The format of these strings is explained in the following section.
 
 #### Inclusions and Exclusions
 
@@ -80,15 +80,15 @@ With automatic method benchmarking enabled, you can fine-tune the list of method
 
 The hash must have keys named either :include or :exclude which are set to an array of strings.
 
-Each string in these arrays must follow the pattern *Class.class_method*, *Class#instance_method*, *Class*, or *method_name*.
+Each string in these arrays must follow the pattern *method_name*, *Class*, *ClassNameSpace::*, *Class.class_method*, *Class#instance_method*.
 
 The following is an example configuration that only benchmarks a discreet set of methods:
 
 ```ruby
-config.benchmark_methods :custom, %w(User.authenticate! run)
+config.benchmark_methods :custom, %w(User.authenticate! run MyApp::)
 ```
 
-In the example above, the only methods benchmarked will be the method 'authenticate!' in class 'User' and any method named 'run' in any instance or class defined in your project.
+In the example above, the only methods benchmarked will be the method 'authenticate!' in class 'User', any method named 'run' in any instance or class defined in your project, and any method defined in a class having a namespace 'MyApp::'. So any method defined in a class named MyApp::MiddleWare or Api::MyApp::StatisticsController would be benchmarked.
 
 By contrast, you can benchmark all methods defined in your project except for a discreet set:
 
@@ -160,15 +160,11 @@ When exception benchmarking is enabled, any exception raised in your project wil
 
 ## Disable Gem Functionality
 
-To temporarily disable all functionality of this gem, set all `config.benchmark_` values to false in the configuration file and then restart your application:
+To disable all functionality of this gem, call `config.disable` in the configuration block and then restart your application:
 
 ```ruby
 CopperEgg::APM.configure do |config|
-  config.instrument_key = "IOFiZ4cslRiV5SXl"
-  config.benchmark_sql        = false
-  config.benchmark_http       = false
-  config.benchmark_exceptions = false
-  config.benchmark_methods    = false
+  config.disable
 end
 ```
 

data/lib/copperegg/apm.rb

@@ -7,7 +7,6 @@ end
 
 %w(
   benchmark
-  action_controller/base
   active_record/connection_adapters/abstract_adapter
   configuration
   errors
@@ -25,4 +24,4 @@ end
   version
 ).each { |file| require "copperegg/apm/#{file}" }
 
-require 'copperegg/apm/engine' if defined?(::Rails::Engine)
+require 'copperegg/apm/engine' if defined?(::Rails::Engine)

data/lib/copperegg/apm/configuration.rb

@@ -24,6 +24,7 @@ module CopperEgg
       @@exclude_methods           = []
       @@include_methods           = []
       @@logger                    = nil
+      @@disabled                  = false
 
       def self.udp_port
         @@udp_port
@@ -151,6 +152,10 @@ module CopperEgg
         end
       end
 
+      def self.disable
+        @@disabled = true
+      end
+
       def self.configure(&block)
         yield(self)
 
@@ -162,7 +167,15 @@ module CopperEgg
           end
         end
 
-        CopperEgg::APM.add_method_benchmarking if @@benchmark_methods_level != :disabled
+        if @@disabled
+          @@benchmark_sql = @@benchmark_active_record = @@benchmark_http = @@benchmark_exceptions = false
+          @@benchmark_methods_level   = :disabled
+          @@only_methods              = []
+          @@exclude_methods           = []
+          @@include_methods           = []
+        elsif @@benchmark_methods_level != :disabled
+          CopperEgg::APM.add_method_benchmarking
+        end
       end
 
       class <<self

data/lib/copperegg/apm/unbound_method.rb

@@ -20,6 +20,10 @@ module CopperEgg
         parent_class.instance_methods.include?("#{name}=".to_sym)
       end
 
+      def name_begins_with_underscore_or_ends_with_question_mark?
+        name =~ /\A_/ || name =~ /\A[\w\d]+\?\z/
+      end
+
       def source_filename
         @source_filename ||=  if respond_to?(:source_location)
                                 source_location.to_a.first
@@ -39,7 +43,11 @@ module CopperEgg
       def display_filename
         return @display_filename if @display_filename
         @display_filename = "#{source_filename}:#{source_line}"
-        @display_filename.sub! CopperEgg::APM::Configuration.app_root, "..."
+
+        if defined?(::Rails)
+          @display_filename.sub!(::Rails.configuration.root.to_s, "...")
+        end
+        @display_filename
       end
 
       def display_name
@@ -86,6 +94,9 @@ module CopperEgg
         return false if CopperEgg::APM::Configuration.only_methods.include?(parent_class.to_s)
         return false if CopperEgg::APM::Configuration.only_methods.include?(display_name)
         return false if CopperEgg::APM::Configuration.only_methods.include?(name)
+        CopperEgg::APM::Configuration.only_methods.each do |value|
+          return false if value =~ /::\Z/ && parent_class.to_s.include?(value)
+        end        
 
         if CopperEgg::APM::Configuration.only_methods.length > 0
           return true if !CopperEgg::APM::Configuration.only_methods.include?(parent_class.to_s) && !CopperEgg::APM::Configuration.only_methods.include?(display_name) && !CopperEgg::APM::Configuration.only_methods.include?(name)
@@ -94,13 +105,18 @@ module CopperEgg
         return true if CopperEgg::APM::Configuration.exclude_methods.include?(parent_class.to_s)
         return true if CopperEgg::APM::Configuration.exclude_methods.include?(display_name)
         return true if CopperEgg::APM::Configuration.exclude_methods.include?(display_name)
+        CopperEgg::APM::Configuration.exclude_methods.each do |value|
+          return true if value =~ /::\Z/ && parent_class.to_s.include?(value)
+        end
 
-        return false if CopperEgg::APM::Configuration.include_methods.include?(parent_class.to_s)
+        return false if CopperEgg::APM::Configuration.include_methods.include?(parent_class.to_s) && !name_begins_with_underscore_or_ends_with_question_mark?
         return false if CopperEgg::APM::Configuration.include_methods.include?(display_name)
         return false if CopperEgg::APM::Configuration.include_methods.include?(name)
+        CopperEgg::APM::Configuration.include_methods.each do |value|
+          return false if value =~ /::\Z/ && parent_class.to_s.include?(value) && !name_begins_with_underscore_or_ends_with_question_mark?
+        end        
 
-        return true if name =~ /\A_/
-        return true if name =~ /\A[\w\d]+\?\z/
+        return true if name_begins_with_underscore_or_ends_with_question_mark?
 
         return false if benchmark_levels.include?(CopperEgg::APM::Configuration.benchmark_methods_level)
         

data/lib/copperegg/apm/version.rb

@@ -1,5 +1,5 @@
 module CopperEgg
   module APM
-    GEM_VERSION = '1.0.0.pre1'
+    GEM_VERSION = '1.0.0.pre2'
   end
 end

data/spec/action_controller_spec.rb

@@ -1,7 +1,7 @@
 # Props to @relishapp (http://www.relishapp.com/rspec/rspec-rails/docs/controller-specs/anonymous-controller) and 
 # @AlexandrZaytsev (http://say26.com/rspec-testing-controllers-outside-of-a-rails-application) for their helpful blog posts
-require File.dirname(__FILE__) + '/helpers/rails'
 require 'spec_helper'
+require File.dirname(__FILE__) + '/helpers/rails'
 
 RSpec.configure do |c|
   c.infer_base_class_for_anonymous_controllers = true
@@ -11,16 +11,10 @@ class ApplicationController < ActionController::Base
   include Rails.application.routes.url_helpers
 end
 
-class ExceptionController < ApplicationController; end
-
-class BenchmarkAllActionsController < ApplicationController; end
-
-class BenchmarkOnlyActionsController < ApplicationController; end
+class ApplicationControllerSubclass < ApplicationController; end
 
-class BenchmarkExceptActionsController < ApplicationController; end
-
-describe ExceptionController, :type => :controller do
-  controller(ExceptionController) do
+describe ApplicationControllerSubclass, :type => :controller do
+  controller(ApplicationControllerSubclass) do
     def index
       @count = 1/0
     end
@@ -35,105 +29,8 @@ describe ExceptionController, :type => :controller do
     expect(hash.keys.sort).to eq ["excp", "id"]
     expect(hash["id"]).to match(/\A[0-1a-z]{16}\z/i)
     expect(hash["excp"].keys.sort).to eq ["error", "stacktrace", "ts"]
-    expect(hash["excp"]["error"]).to match(/\AZeroDivisionError\|/)
-    expect(hash["excp"]["error"]).to match(/\{Ruby\}\Z/)
+    expect(hash["excp"]["error"]).to match(/ZeroDivisionError\|/)
     expect(hash["excp"]["stacktrace"]).to match(/\Adivided by 0\n/)
     expect(hash["excp"]["ts"]).to be_an_instance_of(Fixnum)
   end
 end
-
-describe BenchmarkAllActionsController, :type => :controller do
-  controller(BenchmarkAllActionsController) do
-    add_benchmarks
-
-    def index
-      100.times.reduce(:+)
-      render :nothing => true
-    end
-    alias_method :create, :index
-  end
-
-  it "should benchmark all actions" do
-    get :index
-
-    last_payload = CopperEgg::APM.send(:class_variable_get, :@@payload_cache).split("\x00").select {|i| i.size > 2}.map {|i| i.sub(/^[^\{]+/,'')}.last
-    hash = JSON.parse last_payload
-
-    expect(hash.keys.sort).to eq ["id", "inst"]
-    expect(hash["id"]).to match(/\A[0-1a-z]{16}\z/i)
-    expect(hash["inst"].keys.sort).to eq ["method", "time"]
-    expect(hash["inst"]["method"]).to match(/#index \{Ruby\}/)
-    expect(hash["inst"]["time"].to_s).to match(/\A\d+\Z/)
-
-    post :create
-
-    last_payload = CopperEgg::APM.send(:class_variable_get, :@@payload_cache).split("\x00").select {|i| i.size > 2}.map {|i| i.sub(/^[^\{]+/,'')}.last
-    hash = JSON.parse last_payload
-
-    expect(hash["inst"]["method"]).to match(/#create \{Ruby\}/)
-  end
-end
-
-describe BenchmarkOnlyActionsController, :type => :controller do
-  controller(BenchmarkOnlyActionsController) do
-    add_benchmarks :only => [:index]
-
-    def index
-      100.times.reduce(:+)
-      render :nothing => true
-    end
-    alias_method :create, :index
-  end
-
-  it "should benchmark all actions" do
-    get :index
-
-    last_payload = CopperEgg::APM.send(:class_variable_get, :@@payload_cache).split("\x00").select {|i| i.size > 2}.map {|i| i.sub(/^[^\{]+/,'')}.last
-    hash = JSON.parse last_payload
-
-    expect(hash.keys.sort).to eq ["id", "inst"]
-    expect(hash["id"]).to match(/\A[0-1a-z]{16}\z/i)
-    expect(hash["inst"].keys.sort).to eq ["method", "time"]
-    expect(hash["inst"]["method"]).to match(/#index \{Ruby\}/)
-    expect(hash["inst"]["time"].to_s).to match(/\A\d+\Z/)
-
-    post :create
-
-    last_payload = CopperEgg::APM.send(:class_variable_get, :@@payload_cache).split("\x00").select {|i| i.size > 2}.map {|i| i.sub(/^[^\{]+/,'')}.last
-    hash = JSON.parse last_payload
-
-    expect(hash["inst"]["method"]).to match(/#index \{Ruby\}/)
-  end
-end
-
-describe BenchmarkExceptActionsController, :type => :controller do
-  controller(BenchmarkExceptActionsController) do
-    add_benchmarks :except => [:create]
-
-    def index
-      100.times.reduce(:+)
-      render :nothing => true
-    end
-    alias_method :create, :index
-  end
-
-  it "should benchmark all actions" do
-    get :index
-
-    last_payload = CopperEgg::APM.send(:class_variable_get, :@@payload_cache).split("\x00").select {|i| i.size > 2}.map {|i| i.sub(/^[^\{]+/,'')}.last
-    hash = JSON.parse last_payload
-
-    expect(hash.keys.sort).to eq ["id", "inst"]
-    expect(hash["id"]).to match(/\A[0-1a-z]{16}\z/i)
-    expect(hash["inst"].keys.sort).to eq ["method", "time"]
-    expect(hash["inst"]["method"]).to match(/#index \{Ruby\}/)
-    expect(hash["inst"]["time"].to_s).to match(/\A\d+\Z/)
-
-    post :create
-
-    last_payload = CopperEgg::APM.send(:class_variable_get, :@@payload_cache).split("\x00").select {|i| i.size > 2}.map {|i| i.sub(/^[^\{]+/,'')}.last
-    hash = JSON.parse last_payload
-
-    expect(hash["inst"]["method"]).to match(/#index \{Ruby\}/)
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: copperegg-apm
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre1
+  version: 1.0.0.pre2
 platform: ruby
 authors:
 - Mike Bradford
@@ -189,13 +189,11 @@ files:
 - ./bin/copperegg-apm-init
 - ./bin/copperegg-apm-methods
 - ./CHANGELOG.md
-- ./copperegg-apm-1.0.0.pre1.gem
 - ./copperegg-apm.gemspec
 - ./copperegg_apm_test.db
 - ./ext/mkrf_conf.rb
 - ./Gemfile
 - ./Gemfile.lock
-- ./lib/copperegg/apm/action_controller/base.rb
 - ./lib/copperegg/apm/active_record/connection_adapters/abstract_adapter.rb
 - ./lib/copperegg/apm/benchmark.rb
 - ./lib/copperegg/apm/benchmark_methods_table.rb
@@ -204,7 +202,6 @@ files:
 - ./lib/copperegg/apm/errors.rb
 - ./lib/copperegg/apm/ethon/easy/operations.rb
 - ./lib/copperegg/apm/kernel.rb
-- ./lib/copperegg/apm/middleware.rb
 - ./lib/copperegg/apm/mysql.rb
 - ./lib/copperegg/apm/mysql2/client.rb
 - ./lib/copperegg/apm/net/http.rb
@@ -294,7 +291,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: copperegg-apm-1.0.0.pre1
+summary: copperegg-apm-1.0.0.pre2
 test_files:
 - spec/action_controller_spec.rb
 - spec/apm_spec.rb

data/lib/copperegg/apm/action_controller/base.rb

@@ -1,31 +0,0 @@
-module CopperEgg
-  module APM
-    module ActionController
-      module Base
-        def self.included(klass)
-          klass.class_eval do
-            def self.add_benchmarks(options={})
-              raise ArgumentError.new("hash expected") if !options.is_a?(Hash)
-              around_filter :ce_benchmark_controller_actions, options
-            end
-
-            def ce_benchmark_controller_actions
-              starttime = (Time.now.to_f * 1000.0).to_i
-              yield
-              time = (Time.now.to_f * 1000.0).to_i - starttime
-              CopperEgg::APM.send_payload({:method => "#{self.to_s.sub!(/:[a-z0-9]x[^>]+>/, "").sub!("#<","")}##{action_name}", :time => time})
-            end
-          end
-        end
-      end
-    end
-  end
-end
-
-if defined?(::ActionController::Base)
-
-  class ActionController::Base
-    include CopperEgg::APM::ActionController::Base
-  end
-
-end

data/lib/copperegg/apm/middleware.rb

@@ -1,20 +0,0 @@
-module CopperEgg
-  module APM
-    class Middleware
-      def initialize(app)
-        @app = app
-      end
-      
-      def call(env)
-        CopperEgg::APM.benchmark(:url => env['REQUEST_URI'].gsub(/\/\/[^:]+:[^@]@/,"//").gsub(/\?.*/,"")) do
-          @status, @headers, @response = @app.call(env)
-        end
-        [@status, @headers, self]
-      end
-      
-      def each(&block)
-        @response.each(&block)
-      end
-    end
-  end
-end