wd_newrelic_rpm 3.3.4.1

data/lib/new_relic/agent/instrumentation/sunspot.rb

@@ -0,0 +1,29 @@
+DependencyDetection.defer do
+  @name = :sunspot
+
+  depends_on do
+    defined?(::Sunspot)
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing Rails Sunspot instrumentation'
+  end
+  
+  executes do
+    ::Sunspot.module_eval do
+      class << self
+        %w(index index!).each do |method|
+          add_method_tracer method, 'SolrClient/Sunspot/index'
+        end
+        add_method_tracer :commit, 'SolrClient/Sunspot/commit'
+
+        %w[search more_like_this].each do |method|
+          add_method_tracer method, 'SolrClient/Sunspot/query'
+        end
+        %w[remove remove! remove_by_id remove_by_id! remove_all remove_all!].each do |method|
+          add_method_tracer method, 'SolrClient/Sunspot/delete'
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/agent/instrumentation/unicorn_instrumentation.rb

@@ -0,0 +1,21 @@
+DependencyDetection.defer do
+  @name = :unicorn
+
+  depends_on do
+    defined?(::Unicorn) && defined?(::Unicorn::HttpServer)
+  end
+  
+  executes do
+    NewRelic::Agent.logger.debug 'Installing Unicorn instrumentation'
+  end
+  
+  executes do
+    Unicorn::HttpServer.class_eval do
+      old_worker_loop = instance_method(:worker_loop)
+      define_method(:worker_loop) do | worker |
+        NewRelic::Agent.after_fork(:force_reconnect => true)
+        old_worker_loop.bind(self).call(worker)
+      end
+    end
+  end
+end

data/lib/new_relic/agent/method_tracer.rb

@@ -0,0 +1,528 @@
+require 'new_relic/control'
+module NewRelic
+  module Agent
+    # This module contains class methods added to support installing custom
+    # metric tracers and executing for individual metrics.
+    #
+    # == Examples
+    #
+    # When the agent initializes, it extends Module with these methods.
+    # However if you want to use the API in code that might get loaded
+    # before the agent is initialized you will need to require
+    # this file:
+    #
+    #     require 'new_relic/agent/method_tracer'
+    #     class A
+    #       include NewRelic::Agent::MethodTracer
+    #       def process
+    #         ...
+    #       end
+    #       add_method_tracer :process
+    #     end
+    #
+    # To instrument a class method:
+    #
+    #     require 'new_relic/agent/method_tracer'
+    #     class An
+    #       def self.process
+    #         ...
+    #       end
+    #       class << self
+    #         include NewRelic::Agent::MethodTracer
+    #         add_method_tracer :process
+    #       end
+    #     end
+
+    module MethodTracer
+
+      def self.included clazz #:nodoc:
+        clazz.extend ClassMethods
+        clazz.send :include, InstanceMethods
+      end
+
+      def self.extended clazz #:nodoc:
+        clazz.extend ClassMethods
+        clazz.extend InstanceMethods
+      end
+      
+      # Defines modules used at instrumentation runtime, to do the
+      # actual tracing of time spent
+      module InstanceMethods
+        # Deprecated: original method preserved for API backward compatibility.
+        # Use either #trace_execution_scoped or #trace_execution_unscoped
+        def trace_method_execution(metric_names, push_scope, produce_metric, deduct_call_time_from_parent, &block) #:nodoc:
+          if push_scope
+            trace_execution_scoped(metric_names, :metric => produce_metric,
+                                   :deduct_call_time_from_parent => deduct_call_time_from_parent, &block)
+          else
+            trace_execution_unscoped(metric_names, &block)
+          end
+        end
+
+        # Trace a given block with stats assigned to the given metric_name.  It does not
+        # provide scoped measurements, meaning whatever is being traced will not 'blame the
+        # Controller'--that is to say appear in the breakdown chart.
+        # This is code is inlined in #add_method_tracer.
+        # * <tt>metric_names</tt> is a single name or an array of names of metrics
+        # * <tt>:force => true</tt> will force the metric to be captured even when
+        #   tracing is disabled with NewRelic::Agent#disable_all_tracing
+        #
+        def trace_execution_unscoped(metric_names, options={})
+          return yield unless NewRelic::Agent.is_execution_traced?
+          t0 = Time.now
+          stats = Array(metric_names).map do | metric_name |
+            NewRelic::Agent.instance.stats_engine.get_stats_no_scope metric_name
+          end
+          begin
+            NewRelic::Agent.instance.push_trace_execution_flag(true) if options[:force]
+            yield
+          ensure
+            NewRelic::Agent.instance.pop_trace_execution_flag if options[:force]
+            duration = (Time.now - t0).to_f              # for some reason this is 3 usec faster than Time - Time
+            stats.each { |stat| stat.trace_call(duration) }
+          end
+        end
+
+        # Deprecated. Use #trace_execution_scoped, a version with an options hash.
+        def trace_method_execution_with_scope(metric_names, produce_metric, deduct_call_time_from_parent, scoped_metric_only=false, &block) #:nodoc:
+          trace_execution_scoped(metric_names,
+                                 :metric => produce_metric,
+                                 :deduct_call_time_from_parent => deduct_call_time_from_parent,
+                                 :scoped_metric_only => scoped_metric_only, &block)
+        end
+
+        alias trace_method_execution_no_scope trace_execution_unscoped #:nodoc:
+        
+        # Refactored out of the previous trace_execution_scoped
+        # method, most methods in this module relate to code used in
+        # the #trace_execution_scoped method in this module
+        module TraceExecutionScoped
+          # Shorthand to return the NewRelic::Agent.instance
+          def agent_instance
+            NewRelic::Agent.instance
+          end
+          
+          # Shorthand to return the status of tracing
+          def traced?
+            NewRelic::Agent.is_execution_traced?
+          end
+          
+          # Tracing is disabled if we are not in a traced context and
+          # no force option is supplied
+          def trace_disabled?(options)
+            !(traced? || options[:force])
+          end
+          
+          # Shorthand to return the current statistics engine
+          def stat_engine
+            agent_instance.stats_engine
+          end
+          
+          # returns a scoped metric stat for the specified name
+          def get_stats_scoped(first_name, scoped_metric_only)
+            stat_engine.get_stats(first_name, true, scoped_metric_only)
+          end
+          # Shorthand method to get stats from the stat engine
+          def get_stats_unscoped(name)
+            stat_engine.get_stats_no_scope(name)
+          end
+          
+          # the main statistic we should record in
+          # #trace_execution_scoped - a scoped metric provided by the
+          # first item in the metric array
+          def main_stat(metric, options)
+            get_stats_scoped(metric, options[:scoped_metric_only])
+          end
+          
+          # returns an array containing the first metric, and an array
+          # of other unscoped statistics we should also record along
+          # side it
+          def get_metric_stats(metrics, options)
+            metrics = Array(metrics)
+            first_name = metrics.shift
+            stats = metrics.map do | name |
+              get_stats_unscoped(name)
+            end
+            stats.unshift(main_stat(first_name, options)) if options[:metric]
+            [first_name, stats]
+          end
+          
+          # Helper for setting a hash key if the hash key is nil,
+          # instead of the default ||= behavior which sets if it is
+          # false as well
+          def set_if_nil(hash, key)
+            hash[key] = true if hash[key].nil?
+          end
+          
+          # delegates to #agent_instance to push a trace execution
+          # flag, only if execution of this metric is forced.
+          #
+          # This causes everything scoped inside this metric to be
+          # recorded, even if the parent transaction is generally not.
+          def push_flag!(forced)
+            agent_instance.push_trace_execution_flag(true) if forced
+          end
+          
+          # delegates to #agent_instance to pop the trace execution
+          # flag, only if execution of this metric is
+          # forced. otherwise this is taken care of for us
+          # automatically.
+          #
+          # This ends the forced recording of metrics within the
+          # #trace_execution_scoped block
+          def pop_flag!(forced)
+            agent_instance.pop_trace_execution_flag if forced
+          end
+          
+          # helper for logging errors to the newrelic_agent.log
+          # properly. Logs the error at error level, and includes a
+          # backtrace if we're running at debug level
+          def log_errors(code_area, metric)
+            yield
+          rescue => e
+            NewRelic::Control.instance.log.error("Caught exception in #{code_area}. Metric name = #{metric}, exception = #{e}")
+            NewRelic::Control.instance.log.error(e.backtrace.join("\n"))
+          end
+          
+          # provides the header for our traced execution scoped
+          # method - gets the initial time, sets the tracing flag if
+          # needed, and pushes the scope onto the metric stack
+          # logs any errors that occur and returns the start time and
+          # the scope so that we can check for it later, to maintain
+          # sanity. If the scope stack becomes unbalanced, this
+          # transaction loses meaning.
+          def trace_execution_scoped_header(metric, options, t0=Time.now.to_f)
+            scope = log_errors("trace_execution_scoped header", metric) do
+              push_flag!(options[:force])
+              scope = stat_engine.push_scope(metric, t0, options[:deduct_call_time_from_parent])
+            end
+            # needed in case we have an error, above, to always return
+            # the start time.
+            [t0, scope]
+          end
+          
+          # Handles the end of the #trace_execution_scoped method -
+          # calculating the time taken, popping the tracing flag if
+          # needed, deducting time taken by children, and tracing the
+          # subsidiary unscoped metrics if any
+          #
+          # this method fails safely if the header does not manage to
+          # push the scope onto the stack - it simply does not trace
+          # any metrics.
+          def trace_execution_scoped_footer(t0, first_name, metric_stats, expected_scope, forced, t1=Time.now.to_f)
+            log_errors("trace_method_execution footer", first_name) do
+              duration = t1 - t0
+
+              pop_flag!(forced)
+              if expected_scope
+                scope = stat_engine.pop_scope(expected_scope, duration, t1)
+                exclusive = duration - scope.children_time
+                metric_stats.each { |stats| stats.trace_call(duration, exclusive) }
+              end
+            end
+          end
+
+          # Trace a given block with stats and keep track of the caller.
+          # See NewRelic::Agent::MethodTracer::ClassMethods#add_method_tracer for a description of the arguments.
+          # +metric_names+ is either a single name or an array of metric names.
+          # If more than one metric is passed, the +produce_metric+ option only applies to the first.  The
+          # others are always recorded.  Only the first metric is pushed onto the scope stack.
+          #
+          # Generally you pass an array of metric names if you want to record the metric under additional
+          # categories, but generally this *should never ever be done*.  Most of the time you can aggregate
+          # on the server.
+
+          def trace_execution_scoped(metric_names, options={})
+            return yield if trace_disabled?(options)
+            set_if_nil(options, :metric)
+            set_if_nil(options, :deduct_call_time_from_parent)
+            first_name, metric_stats = get_metric_stats(metric_names, options)
+            start_time, expected_scope = trace_execution_scoped_header(first_name, options)
+            begin
+              yield
+            ensure
+              trace_execution_scoped_footer(start_time, first_name, metric_stats, expected_scope, options[:force])
+            end
+          end
+
+        end
+        include TraceExecutionScoped
+
+      end
+      
+      # Defines methods used at the class level, for adding instrumentation
+      module ClassMethods
+        # contains methods refactored out of the #add_method_tracer method
+        module AddMethodTracer
+          ALLOWED_KEYS = [:force, :metric, :push_scope, :deduct_call_time_from_parent, :code_header, :code_footer, :scoped_metric_only].freeze
+          
+          # used to verify that the keys passed to
+          # NewRelic::Agent::MethodTracer::ClassMethods#add_method_tracer
+          # are valid. Returns a list of keys that were unexpected
+          def unrecognized_keys(expected, given)
+            given.keys - expected
+          end
+          
+          # used to verify that the keys passed to
+          # NewRelic::Agent::MethodTracer::ClassMethods#add_method_tracer
+          # are valid. checks the expected list against the list
+          # actually provided
+          def any_unrecognized_keys?(expected, given)
+            unrecognized_keys(expected, given).any?
+          end
+          
+          # raises an error when the
+          # NewRelic::Agent::MethodTracer::ClassMethods#add_method_tracer
+          # method is called with improper keys. This aids in
+          # debugging new instrumentation by failing fast
+          def check_for_illegal_keys!(options)
+            if any_unrecognized_keys?(ALLOWED_KEYS, options)
+              raise "Unrecognized options in add_method_tracer_call: #{unrecognized_keys(ALLOWED_KEYS, options).join(', ')}"
+            end
+          end
+          
+          # Sets the options for deducting call time from
+          # parents. This defaults to true if we are recording a metric, but
+          # can be overridden by the user if desired.
+          #
+          # has the effect of not allowing overlapping times, and
+          # should generally be true
+          def set_deduct_call_time_based_on_metric(options)
+            {:deduct_call_time_from_parent => !!options[:metric]}.merge(options)
+          end
+          
+          # validity checking - add_method_tracer must receive either
+          # push scope or metric, or else it would record no
+          # data. Raises an error if this is the case
+          def check_for_push_scope_and_metric(options)
+            unless options[:push_scope] || options[:metric]
+              raise "Can't add a tracer where push_scope is false and metric is false"
+            end
+          end
+
+          DEFAULT_SETTINGS = {:push_scope => true, :metric => true, :force => false, :code_header => "", :code_footer => "", :scoped_metric_only => false}.freeze
+          
+          # Checks the provided options to make sure that they make
+          # sense. Raises an error if the options are incorrect to
+          # assist with debugging, so that errors occur at class
+          # construction time rather than instrumentation run time
+          def validate_options(options)
+            raise TypeError.new("provided options must be a Hash") unless options.is_a?(Hash)
+            check_for_illegal_keys!(options)
+            options = set_deduct_call_time_based_on_metric(DEFAULT_SETTINGS.merge(options))
+            check_for_push_scope_and_metric(options)
+            options
+          end
+
+          # Default to the class where the method is defined.
+          #
+          # Example:
+          #  Foo.default_metric_name_code('bar') #=> "Custom/#{Foo.name}/bar"
+          def default_metric_name_code(method_name)
+            "Custom/#{self.name}/#{method_name.to_s}"
+          end
+          
+          # Checks to see if the method we are attempting to trace
+          # actually exists or not. #add_method_tracer can't do
+          # anything if the method doesn't exist.
+          def newrelic_method_exists?(method_name)
+            exists = method_defined?(method_name) || private_method_defined?(method_name)
+            NewRelic::Control.instance.log.warn("Did not trace #{self.name}##{method_name} because that method does not exist") unless exists
+            exists
+          end
+          
+          # Checks to see if we have already traced a method with a
+          # given metric by checking to see if the traced method
+          # exists. Warns the user if methods are being double-traced
+          # to help with debugging custom instrumentation.
+          def traced_method_exists?(method_name, metric_name_code)
+            exists = method_defined?(_traced_method_name(method_name, metric_name_code))
+            NewRelic::Control.instance.log.warn("Attempt to trace a method twice with the same metric: Method = #{method_name}, Metric Name = #{metric_name_code}") if exists
+            exists
+          end
+          
+          # Returns a code snippet to be eval'd that skips tracing
+          # when the agent is not tracing execution. turns
+          # instrumentation into effectively one method call overhead
+          # when the agent is disabled
+          def assemble_code_header(method_name, metric_name_code, options)
+            unless options[:force]
+              "return #{_untraced_method_name(method_name, metric_name_code)}(*args, &block) unless NewRelic::Agent.is_execution_traced?\n"
+            end.to_s + options[:code_header].to_s
+          end
+          
+          # returns an eval-able string that contains the traced
+          # method code used if the agent is not creating a scope for
+          # use in scoped metrics.
+          def method_without_push_scope(method_name, metric_name_code, options)
+            "def #{_traced_method_name(method_name, metric_name_code)}(*args, &block)
+              #{assemble_code_header(method_name, metric_name_code, options)}
+              t0 = Time.now
+              stats = NewRelic::Agent.instance.stats_engine.get_stats_no_scope \"#{metric_name_code}\"
+              begin
+                #{"NewRelic::Agent.instance.push_trace_execution_flag(true)\n" if options[:force]}
+                #{_untraced_method_name(method_name, metric_name_code)}(*args, &block)\n
+              ensure
+                #{"NewRelic::Agent.instance.pop_trace_execution_flag\n" if options[:force] }
+                duration = (Time.now - t0).to_f
+                stats.trace_call(duration)
+                #{options[:code_footer]}
+              end
+            end"
+          end
+
+          # returns an eval-able string that contains the tracing code
+          # for a fully traced metric including scoping
+          def method_with_push_scope(method_name, metric_name_code, options)
+            klass = (self === Module) ? "self" : "self.class"
+
+            "def #{_traced_method_name(method_name, metric_name_code)}(*args, &block)
+              #{options[:code_header]}
+              result = #{klass}.trace_execution_scoped(\"#{metric_name_code}\",
+                        :metric => #{options[:metric]},
+                        :forced => #{options[:force]},
+                        :deduct_call_time_from_parent => #{options[:deduct_call_time_from_parent]},
+                        :scoped_metric_only => #{options[:scoped_metric_only]}) do
+                #{_untraced_method_name(method_name, metric_name_code)}(*args, &block)
+              end
+              #{options[:code_footer]}
+              result
+            end"
+          end
+          
+          # Decides which code snippet we should be eval'ing in this
+          # context, based on the options.
+          def code_to_eval(method_name, metric_name_code, options)
+            options = validate_options(options)
+            if options[:push_scope]
+              method_with_push_scope(method_name, metric_name_code, options)
+            else
+              method_without_push_scope(method_name, metric_name_code, options)
+            end
+          end
+        end
+        include AddMethodTracer
+
+
+        
+        # Add a method tracer to the specified method.
+        #
+        # === Common Options
+        #
+        # * <tt>:push_scope => false</tt> specifies this method tracer should not
+        #   keep track of the caller; it will not show up in controller breakdown
+        #   pie charts.
+        # * <tt>:metric => false</tt> specifies that no metric will be recorded.
+        #   Instead the call will show up in transaction traces as well as traces
+        #   shown in Developer Mode.
+        #
+        # === Uncommon Options
+        #
+        # * <tt>:scoped_metric_only => true</tt> indicates that the unscoped metric
+        #   should not be recorded.  Normally two metrics are potentially created
+        #   on every invocation: the aggregate method where statistics for all calls
+        #   of that metric are stored, and the "scoped metric" which records the
+        #   statistics for invocations in a particular scope--generally a controller
+        #   action.  This option indicates that only the second type should be recorded.
+        #   The effect is similar to <tt>:metric => false</tt> but in addition you
+        #   will also see the invocation in breakdown pie charts.
+        # * <tt>:deduct_call_time_from_parent => false</tt> indicates that the method invocation
+        #   time should never be deducted from the time reported as 'exclusive' in the
+        #   caller.  You would want to use this if you are tracing a recursive method
+        #   or a method that might be called inside another traced method.
+        # * <tt>:code_header</tt> and <tt>:code_footer</tt> specify ruby code that
+        #   is inserted into the tracer before and after the call.
+        # * <tt>:force = true</tt> will ensure the metric is captured even if called inside
+        #   an untraced execution call.  (See NewRelic::Agent#disable_all_tracing)
+        #
+        # === Overriding the metric name
+        #
+        # +metric_name_code+ is a string that is eval'd to get the
+        # name of the metric associated with the call, so if you want to
+        # use interpolaion evaluated at call time, then single quote
+        # the value like this:
+        #
+        #     add_method_tracer :foo, 'Custom/#{self.class.name}/foo'
+        #
+        # This would name the metric according to the class of the runtime
+        # intance, as opposed to the class where +foo+ is defined.
+        #
+        # If not provided, the metric name will be <tt>Custom/ClassName/method_name</tt>.
+        #
+        # === Examples
+        #
+        # Instrument +foo+ only for custom views--will not show up in transaction traces or caller breakdown graphs:
+        #
+        #     add_method_tracer :foo, :push_scope => false
+        #
+        # Instrument +foo+ just for transaction traces only:
+        #
+        #     add_method_tracer :foo, :metric => false
+        #
+        # Instrument +foo+ so it shows up in transaction traces and caller breakdown graphs
+        # for actions:
+        #
+        #     add_method_tracer :foo
+        #
+        # which is equivalent to:
+        #
+        #     add_method_tracer :foo, 'Custom/#{self.class.name}/foo', :push_scope => true, :metric => true
+        #
+        # Instrument the class method +foo+ with the metric name 'Custom/People/fetch':
+        #
+        #     class << self
+        #       add_method_tracer :foo, 'Custom/People/fetch'
+        #     end
+        #
+        def add_method_tracer(method_name, metric_name_code=nil, options = {})
+          return unless newrelic_method_exists?(method_name)
+          metric_name_code ||= default_metric_name_code(method_name)
+          return if traced_method_exists?(method_name, metric_name_code)
+
+          traced_method = code_to_eval(method_name, metric_name_code, options)
+
+          class_eval traced_method, __FILE__, __LINE__
+          alias_method _untraced_method_name(method_name, metric_name_code), method_name
+          alias_method method_name, _traced_method_name(method_name, metric_name_code)
+          NewRelic::Control.instance.log.debug("Traced method: class = #{self.name},"+
+                    "method = #{method_name}, "+
+                    "metric = '#{metric_name_code}'")
+        end
+
+        # For tests only because tracers must be removed in reverse-order
+        # from when they were added, or else other tracers that were added to the same method
+        # may get removed as well.
+        def remove_method_tracer(method_name, metric_name_code) # :nodoc:
+          return unless NewRelic::Control.instance.agent_enabled?
+          if method_defined? "#{_traced_method_name(method_name, metric_name_code)}"
+            alias_method method_name, "#{_untraced_method_name(method_name, metric_name_code)}"
+            undef_method "#{_traced_method_name(method_name, metric_name_code)}"
+            NewRelic::Control.instance.log.debug("removed method tracer #{method_name} #{metric_name_code}\n")
+          else
+            raise "No tracer for '#{metric_name_code}' on method '#{method_name}'"
+          end
+        end
+        private
+        
+        # given a method and a metric, this method returns the
+        # untraced alias of the method name
+        def _untraced_method_name(method_name, metric_name)
+          "#{_sanitize_name(method_name)}_without_trace_#{_sanitize_name(metric_name)}"
+        end
+        
+        # given a method and a metric, this method returns the traced
+        # alias of the method name
+        def _traced_method_name(method_name, metric_name)
+          "#{_sanitize_name(method_name)}_with_trace_#{_sanitize_name(metric_name)}"
+        end
+        
+        # makes sure that method names do not contain characters that
+        # might break the interpreter, for example ! or ? characters
+        # that are not allowed in the middle of method names 
+        def _sanitize_name(name)
+          name.to_s.tr_s('^a-zA-Z0-9', '_')
+        end
+      end
+    end
+  end
+end