scout_apm 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e35b6c5c23a78e589b4756310047fb0bc7ac4adf
-  data.tar.gz: 5489c84a0cd1a0f3df4ec85a54b9d6a8f34692b3
+  metadata.gz: 3f23c7ac5d4eb5fd3377ec8d9c4aa9f57a5fc356
+  data.tar.gz: 72c4e84ceeae582c401e30343c0f0594c79036cc
 SHA512:
-  metadata.gz: 1786feaa5c35aa342e8d4e805d923754cb37de844f396cba10e66b56c341ea9facf9e8d8fec90c33ce23c3fda4fc062325c2adc7096ee7cf6a9a2bd3f0e31e33
-  data.tar.gz: 85c19b4db97a36905e497db1c2e70bad95ab528d656db5f29378b55b53c5fdc256ce83bfa14f297bbdf47be21dacbbfcc999da7a55e6f78042d8707200c55b6d
+  metadata.gz: 7ae0882e14379a6a1d87923f20500fa9508cc8e63438788db0d9ee98ae773413a2f3a3d1aef9fee9977447cda1f10593f91de92837b8ee168e7a18c058b023ab
+  data.tar.gz: 93197ba1fdf634b6ccf399ba1e73363abc21d0604ae71f75537f5280e50480855c280b4f11690be2c32d8e780a85011d5f8ac3f49fe6e256a138c7b71c9e5ea6

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 1.4.4
+
+* Instrument Mongoid
+* Instrument Redis
+
 # 1.4.3
 
 * Add a to_s call to have HTTPClient work with URI objects.  Thanks to Nicolai for providing the change!

data/Rakefile

@@ -8,3 +8,12 @@ task :test do
   Dir.glob('./test/**/*_test.rb').each { |file| require file }
 end
 
+
+desc "IRB with this gem required" 
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'scout_apm'
+  ARGV.clear
+  IRB.start
+end

data/lib/scout_apm.rb

@@ -62,6 +62,7 @@ require 'scout_apm/instruments/net_http'
 require 'scout_apm/instruments/http_client'
 require 'scout_apm/instruments/moped'
 require 'scout_apm/instruments/mongoid'
+require 'scout_apm/instruments/redis'
 require 'scout_apm/instruments/delayed_job'
 require 'scout_apm/instruments/active_record'
 require 'scout_apm/instruments/action_controller_rails_2'

data/lib/scout_apm/agent.rb

@@ -253,6 +253,7 @@ module ScoutApm
       install_instrument(ScoutApm::Instruments::Mongoid)
       install_instrument(ScoutApm::Instruments::NetHttp)
       install_instrument(ScoutApm::Instruments::HttpClient)
+      install_instrument(ScoutApm::Instruments::Redis)
 
       if StackProf.respond_to?(:fake?) && StackProf.fake?
         logger.info 'StackProf not found - add `gem "stackprof"` to your Gemfile to enable advanced code profiling (only for Ruby 2.1+)'
@@ -266,6 +267,14 @@ module ScoutApm
     def install_instrument(instrument_klass)
       # Don't attempt to install the same instrument twice
       return if @installed_instruments.any? { |already_installed_instrument| instrument_klass === already_installed_instrument }
+
+      # Allow users to skip individual instruments via the config file
+      instrument_short_name = instrument_klass.name.split("::").last
+      if config.value("disabled_instruments").include?(instrument_short_name)
+        logger.info "Skipping Disabled Instrument: #{instrument_short_name} - To re-enable, change `disabled_instruments` key in scout_apm.yml"
+        return
+      end
+
       instance = instrument_klass.new
       @installed_instruments << instance
       instance.install

data/lib/scout_apm/config.rb

@@ -27,6 +27,7 @@ module ScoutApm
         'stackprof_interval' => 20000, # microseconds, 1000 = 1 millisecond, so 20k == 20 milliseconds
         'uri_reporting' => 'full_path',
         'report_format' => 'json',
+        'disabled_instruments' => []
     }.freeze
 
     def initialize(config_path = nil)

data/lib/scout_apm/instruments/mongoid.rb

@@ -22,11 +22,10 @@ module ScoutApm
           ::Mongoid::Collection.class_eval do
             include ScoutApm::Tracer
             (::Mongoid::Collections::Operations::ALL - [:<<, :[]]).each do |method|
-              instrument_method method, :type => "MongoDB", :name => '#{@klass}/#{method}'
+              instrument_method method, :type => "MongoDB", :name => '#{@klass}/' + method.to_s
             end
           end
         end
-
       end
     end
   end

data/lib/scout_apm/instruments/redis.rb

@@ -0,0 +1,39 @@
+module ScoutApm
+  module Instruments
+    class Redis
+      attr_reader :logger
+
+      def initalize(logger=ScoutApm::Agent.instance.logger)
+        @logger = logger
+        @installed = false
+      end
+
+      def installed?
+        @installed
+      end
+
+      def install
+        @installed = true
+
+        if defined?(::Redis) && defined?(::Redis::Client)
+          ScoutApm::Agent.instance.logger.info "Instrumenting Redis"
+
+          ::Redis::Client.class_eval do
+            include ScoutApm::Tracer
+
+            def call_with_scout_instruments(*args, &block)
+              command = args.first.first rescue "Unknown"
+
+              self.class.instrument("Redis", command) do
+                call_without_scout_instruments(*args, &block)
+              end
+            end
+
+            alias_method :call_without_scout_instruments, :call
+            alias_method :call, :call_with_scout_instruments
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/tracer.rb

@@ -44,33 +44,62 @@ module ScoutApm
       # Options:
       # type - "View" or "ActiveRecord" and similar
       # name - "users/show", "App#find"
-      def instrument_method(method, options = {})
-        ScoutApm::Agent.instance.logger.info "Instrumenting #{method}"
+      def instrument_method(method_name, options = {})
+        ScoutApm::Agent.instance.logger.info "Instrumenting #{method_name}"
         type = options[:type] || "Custom"
-        name = options[:name] || "#{self.name}/#{method.to_s}"
+        name = options[:name] || "#{self.name}/#{method_name.to_s}"
 
-        return if !instrumentable?(method) or instrumented?(method, type, name)
+        instrumented_name, uninstrumented_name = _determine_instrumented_name(method_name, type)
+
+        ScoutApm::Agent.instance.logger.info "Instrumenting #{instrumented_name}, #{uninstrumented_name}"
+
+        return if !_instrumentable?(method_name) or _instrumented?(instrumented_name, method_name)
 
         class_eval(
-          instrumented_method_string(method, type, name, {:scope => options[:scope] }),
+          _instrumented_method_string(instrumented_name, uninstrumented_name, type, name, {:scope => options[:scope] }),
           __FILE__, __LINE__
         )
 
-        alias_method _uninstrumented_method_name(method, type, name), method
-        alias_method method, _instrumented_method_name(method, type, name)
+        alias_method uninstrumented_name, method_name
+        alias_method method_name, instrumented_name
       end
 
       private
 
-      def instrumented_method_string(method, type, name, options={})
+      def _determine_instrumented_name(method_name, type)
+        inst = _find_unused_method_name { _instrumented_method_name(method_name, type) }
+        uninst = _find_unused_method_name { _uninstrumented_method_name(method_name, type) }
+
+        return inst, uninst
+      end
+
+      def _find_unused_method_name
+        raw_name = name = yield
+
+        i = 0
+        while method_defined?(name) && i < 100
+          i += 1
+          name = "#{raw_name}_#{i}"
+        end
+        name
+      end
+
+      def _instrumented_method_string(instrumented_name, uninstrumented_name, type, name, options={})
         klass = (self === Module) ? "self" : "self.class"
         method_str = <<-EOF
-        def #{_instrumented_method_name(method, type, name)}(*args, &block)
+        def #{instrumented_name}(*args, &block)
+          name = begin
+                   "#{name}"
+                 rescue => e
+                   ScoutApm::Agent.instance.logger.error("Error raised while interpreting instrumented name: %s, %s" % ['#{name}', e.message])
+                   "Unknown"
+                 end
+
           #{klass}.instrument( "#{type}",
-                               "#{name}",
+                               name,
                                {:scope => #{options[:scope] || false}}
                              ) do
-            #{_uninstrumented_method_name(method, type, name)}(*args, &block)
+            #{uninstrumented_name}(*args, &block)
           end
         end
         EOF
@@ -79,29 +108,29 @@ module ScoutApm
       end
 
       # The method must exist to be instrumented.
-      def instrumentable?(method)
-        exists = method_defined?(method) || private_method_defined?(method)
-        ScoutApm::Agent.instance.logger.warn "The method [#{self.name}##{method}] does not exist and will not be instrumented" unless exists
+      def _instrumentable?(method_name)
+        exists = method_defined?(method_name) || private_method_defined?(method_name)
+        ScoutApm::Agent.instance.logger.warn "The method [#{self.name}##{method_name}] does not exist and will not be instrumented" unless exists
         exists
       end
 
       # +True+ if the method is already instrumented.
-      def instrumented?(method, type, name)
-        instrumented = method_defined?(_instrumented_method_name(method, type, name))
-        ScoutApm::Agent.instance.logger.warn("The method [#{self.name}##{method}] has already been instrumented") if instrumented
+      def _instrumented?(instrumented_name, method_name)
+        instrumented = method_defined?(instrumented_name)
+        ScoutApm::Agent.instance.logger.warn("The method [#{self.name}##{method_name}] has already been instrumented") if instrumented
         instrumented
       end
 
       # given a method and a metric, this method returns the
       # untraced alias of the method name
-      def _uninstrumented_method_name(method, type, name)
-        "#{_sanitize_name(method)}_without_scout_instrument_#{_sanitize_name(name)}"
+      def _uninstrumented_method_name(method_name, type)
+        "#{_sanitize_name(method_name)}_without_scout_instrument"
       end
 
       # given a method and a metric, this method returns the traced
       # alias of the method name
-      def _instrumented_method_name(method, type, name)
-        "#{_sanitize_name(method)}_with_scout_instrument_#{_sanitize_name(name)}"
+      def _instrumented_method_name(method_name, type)
+        "#{_sanitize_name(method_name)}_with_scout_instrument"
       end
 
       # Method names like +any?+ or +replace!+ contain a trailing character that would break when

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.4.3"
+  VERSION = "1.4.4"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -101,6 +101,7 @@ files:
 - lib/scout_apm/instruments/process/process_cpu.rb
 - lib/scout_apm/instruments/process/process_memory.rb
 - lib/scout_apm/instruments/rails_router.rb
+- lib/scout_apm/instruments/redis.rb
 - lib/scout_apm/instruments/sinatra.rb
 - lib/scout_apm/layaway.rb
 - lib/scout_apm/layaway_file.rb