wd_newrelic_rpm 3.3.4.1

data/lib/new_relic/agent/transaction_info.rb

@@ -0,0 +1,74 @@
+require 'erb'
+
+module NewRelic
+  module Agent
+    class TransactionInfo
+
+      attr_accessor :token, :capture_deep_tt, :transaction_name
+      attr_reader :start_time
+
+      def initialize
+        @guid = ""
+        @transaction_name = "(unknown)"
+        @start_time = Time.now
+      end
+
+      def force_persist_sample?(sample)
+        token && sample.duration > NewRelic::Control.instance.apdex_t
+      end
+
+      def include_guid?
+        token && duration > NewRelic::Control.instance.apdex_t
+      end
+
+      def guid
+        @guid
+      end
+
+      def guid=(value)
+        @guid = value
+      end
+
+      def duration
+        Time.now - start_time
+      end
+
+      def self.get()
+        Thread.current[:newrelic_transaction_info] ||= TransactionInfo.new
+      end
+
+      def self.set(instance)
+        Thread.current[:newrelic_transaction_info] = instance
+      end
+
+      def self.clear
+        Thread.current[:newrelic_transaction_info] = nil
+      end
+
+      # clears any existing transaction info object and initializes a new one.
+      # This starts the timer for the transaction.
+      def self.reset(request=nil)
+        clear
+        instance = get
+        instance.token = get_token(request)
+      end
+
+      def self.get_token(request)
+        return nil unless request
+        
+        agent_flag = request.cookies['NRAGENT']
+        if agent_flag
+          s = agent_flag.split("=")
+          if s.length == 2
+            if s[0] == "tk" && s[1]
+              ERB::Util.h(s[1])
+            end
+          end
+        else
+          nil
+        end
+      end
+    end
+  end
+end
+

data/lib/new_relic/agent/transaction_sample_builder.rb

@@ -0,0 +1,116 @@
+require 'new_relic/collection_helper'
+require 'new_relic/transaction_sample'
+require 'new_relic/control'
+require 'new_relic/agent/instrumentation/metric_frame'
+module NewRelic
+  module Agent
+    # a builder is created with every sampled transaction, to dynamically
+    # generate the sampled data.  It is a thread-local object, and is not
+    # accessed by any other thread so no need for synchronization.
+    class TransactionSampleBuilder
+      attr_reader :current_segment, :sample
+      attr_accessor :segment_limit
+
+      include NewRelic::CollectionHelper
+
+      def initialize(time=Time.now)
+        @sample = NewRelic::TransactionSample.new(time.to_f)
+        @sample_start = time.to_f
+        @current_segment = @sample.root_segment
+        @segment_limit = NewRelic::Control.instance.fetch('transaction_tracer', {}) \
+          .fetch('limit_segments', 4000)
+      end
+
+      def sample_id
+        @sample.sample_id
+      end
+      
+      def ignored?
+        @ignore || @sample.params[:path].nil?
+      end
+      
+      def ignore_transaction
+        @ignore = true
+      end
+      
+      def trace_entry(metric_name, time)
+        if @sample.count_segments < @segment_limit
+          segment = @sample.create_segment(time.to_f - @sample_start, metric_name)
+          @current_segment.add_called_segment(segment)
+          @current_segment = segment
+          if @sample.count_segments == @segment_limit
+            NewRelic::Control.instance.log.debug("Segment limit of #{@segment_limit} reached, ceasing collection.")
+          end
+          @current_segment
+        end
+      end
+
+      def trace_exit(metric_name, time)
+        return unless @sample.count_segments < @segment_limit
+        if metric_name != @current_segment.metric_name
+          fail "unbalanced entry/exit: #{metric_name} != #{@current_segment.metric_name}"
+        end
+        @current_segment.end_trace(time.to_f - @sample_start)
+        @current_segment = @current_segment.parent_segment
+      end
+
+      def finish_trace(time)
+        # This should never get called twice, but in a rare case that we can't reproduce in house it does.
+        # log forensics and return gracefully
+        if @sample.frozen?
+          log = NewRelic::Control.instance.log
+          log.error "Unexpected double-freeze of Transaction Trace Object: \n#{@sample.to_s}"
+          return
+        end
+        @sample.root_segment.end_trace(time.to_f - @sample_start)
+        @sample.params[:custom_params] = normalize_params(NewRelic::Agent::Instrumentation::MetricFrame.custom_parameters)
+        
+        @sample.force_persist = NewRelic::Agent::TransactionInfo.get.force_persist_sample?(sample)
+        @sample.freeze
+        @current_segment = nil
+      end
+
+      def scope_depth
+        depth = -1        # have to account for the root
+        current = @current_segment
+
+        while(current)
+          depth += 1
+          current = current.parent_segment
+        end
+
+        depth
+      end
+
+      def freeze
+        @sample.freeze unless sample.frozen?
+      end
+
+      def set_profile(profile)
+        @sample.profile = profile
+      end
+
+      def set_transaction_info(path, uri, params)
+        @sample.params[:path] = path
+
+        if NewRelic::Control.instance.capture_params
+          params = normalize_params params
+
+          @sample.params[:request_params].merge!(params)
+          @sample.params[:request_params].delete :controller
+          @sample.params[:request_params].delete :action
+        end
+        @sample.params[:uri] ||= uri || params[:uri]
+      end
+
+      def set_transaction_cpu_time(cpu_time)
+        @sample.params[:cpu_time] = cpu_time
+      end
+
+      def sample
+        @sample
+      end
+
+    end
+  end
+end

data/lib/new_relic/agent/transaction_sampler.rb

@@ -0,0 +1,468 @@
+require 'new_relic/agent'
+require 'new_relic/control'
+require 'new_relic/agent/transaction_sample_builder'
+
+module NewRelic
+  module Agent
+
+    # This class contains the logic of sampling a transaction -
+    # creation and modification of transaction samples
+    class TransactionSampler
+
+      # Module defining methods stubbed out when the agent is disabled
+      module Shim #:nodoc:
+        def notice_first_scope_push(*args); end
+        def notice_push_scope(*args); end
+        def notice_pop_scope(*args); end
+        def notice_scope_empty(*args); end
+      end
+
+      BUILDER_KEY = :transaction_sample_builder
+
+      attr_accessor :stack_trace_threshold, :random_sampling, :sampling_rate
+      attr_accessor :explain_threshold, :explain_enabled, :transaction_threshold
+      attr_accessor :slow_capture_threshold
+      attr_reader :samples, :last_sample, :disabled
+
+      def initialize
+
+        # @samples is an array of recent samples up to @max_samples in
+        # size - it's only used by developer mode
+        @samples = []
+        @force_persist = []
+        @max_samples = 100
+
+        # @harvest_count is a count of harvests used for random
+        # sampling - we pull 1 @random_sample in every @sampling_rate harvests
+        @harvest_count = 0
+        @random_sample = nil
+        @sampling_rate = 10
+        @slow_capture_threshold = 2.0
+        configure!
+
+        # This lock is used to synchronize access to the @last_sample
+        # and related variables. It can become necessary on JRuby or
+        # any 'honest-to-god'-multithreaded system
+        @samples_lock = Mutex.new
+      end
+
+      def configure!
+        # @segment_limit and @stack_trace_threshold come from the
+        # configuration file, with built-in defaults that should
+        # suffice for most customers
+
+        # enable if config.fetch('enabled', true)
+
+        @segment_limit = config.fetch('limit_segments', 4000)
+        @stack_trace_threshold = config.fetch('stack_trace_threshold', 0.500).to_f
+        @explain_threshold = config.fetch('explain_threshold', 0.5).to_f
+        @explain_enabled = config.fetch('explain_enabled', true)
+        @transaction_threshold = config.fetch('transation_threshold', 2.0)
+
+        # Configure the sample storage policy.  Create a list of methods to be called.
+        @store_sampler_methods = [ :store_random_sample, :store_slowest_sample ]
+        if NewRelic::Control.instance.developer_mode?
+          @store_sampler_methods << :store_sample_for_developer_mode
+        end
+      end
+
+      def config
+        NewRelic::Control.instance.fetch('transaction_tracer', {})
+      end
+
+      # Returns the current sample id, delegated from `builder`
+      def current_sample_id
+        b=builder
+        b and b.sample_id
+      end
+
+      # Enable the transaction sampler - this also registers it with
+      # the statistics engine.
+      def enable
+        @disabled = false
+        NewRelic::Agent.instance.stats_engine.transaction_sampler = self
+      end
+
+      # Disable the transaction sampler - this also deregisters it
+      # with the statistics engine.
+      def disable
+        @disabled = true
+        NewRelic::Agent.instance.stats_engine.remove_transaction_sampler(self)
+      end
+
+      def enabled?
+        !@disabled
+      end
+
+      # Set with an integer value n, this takes one in every n
+      # harvested samples. It also resets the harvest count to a
+      # random integer between 0 and (n-1)
+      def sampling_rate=(val)
+        @sampling_rate = val.to_i
+        @harvest_count = rand(val.to_i).to_i
+      end
+
+
+      # Creates a new transaction sample builder, unless the
+      # transaction sampler is disabled. Takes a time parameter for
+      # the start of the transaction sample
+      def notice_first_scope_push(time)
+        start_builder(time.to_f) unless disabled
+      end
+
+      # This delegates to the builder to create a new open transaction
+      # segment for the specified scope, beginning at the optionally
+      # specified time.
+      #
+      # Note that in developer mode, this captures a stacktrace for
+      # the beginning of each segment, which can be fairly slow
+      def notice_push_scope(scope, time=Time.now)
+        return unless builder
+
+        builder.trace_entry(scope, time.to_f)
+
+        capture_segment_trace if NewRelic::Control.instance.developer_mode?
+      end
+
+      # in developer mode, capture the stack trace with the segment.
+      # this is cpu and memory expensive and therefore should not be
+      # turned on in production mode
+      def capture_segment_trace
+        return unless NewRelic::Control.instance.developer_mode?
+        segment = builder.current_segment
+        if segment
+          # Strip stack frames off the top that match /new_relic/agent/
+          trace = caller
+          while trace.first =~/\/lib\/new_relic\/agent\//
+            trace.shift
+          end
+
+          trace = trace[0..39] if trace.length > 40
+          segment[:backtrace] = trace
+        end
+      end
+
+      # Defaults to zero, otherwise delegated to the transaction
+      # sample builder
+      def scope_depth
+        return 0 unless builder
+
+        builder.scope_depth
+      end
+
+      # Informs the transaction sample builder about the end of a
+      # traced scope
+      def notice_pop_scope(scope, time = Time.now)
+        return unless builder
+        raise "frozen already???" if builder.sample.frozen?
+        builder.trace_exit(scope, time.to_f)
+      end
+
+      # This is called when we are done with the transaction.  We've
+      # unwound the stack to the top level. It also clears the
+      # transaction sample builder so that it won't continue to have
+      # scopes appended to it.
+      #
+      # It sets various instance variables to the finished sample,
+      # depending on which settings are active. See `store_sample`
+      def notice_scope_empty(time=Time.now)
+
+        last_builder = builder
+        return unless last_builder
+
+        last_builder.finish_trace(time.to_f)
+        clear_builder
+        return if last_builder.ignored?
+
+        @samples_lock.synchronize do
+          # NB this instance variable may be used elsewhere, it's not
+          # just a side effect
+          @last_sample = last_builder.sample
+          store_sample(@last_sample)
+        end
+      end
+
+      # Samples can be stored in three places: the random sample
+      # variable, when random sampling is active, the developer mode
+      # @samples array, and the @slowest_sample variable if it is
+      # slower than the current occupant of that slot
+      def store_sample(sample)
+        @store_sampler_methods.each{|sym| send sym, sample}
+        if NewRelic::Agent::TransactionInfo.get.force_persist_sample?(sample)
+          store_force_persist(sample)
+        end
+
+      end
+
+      # Only active when random sampling is true - this is very rarely
+      # used. Always store the most recent sample so that random
+      # sampling can pick a few of the samples to store, upon harvest
+      def store_random_sample(sample)
+        if @random_sampling
+          @random_sample = sample
+        end
+      end
+
+      def store_force_persist(sample)
+        @force_persist << sample
+
+        # WARNING - this clamp should be configurable
+        if @force_persist.length > 15
+          @force_persist.sort! {|a,b| b.duration <=> a.duration}
+          @force_persist = @force_persist[0..14]
+        end
+      end
+
+      # Samples take up a ton of memory, so we only store a lot of
+      # them in developer mode - we truncate to @max_samples
+      def store_sample_for_developer_mode(sample)
+        return unless NewRelic::Control.instance.developer_mode?
+        @samples = [] unless @samples
+        @samples << sample
+        truncate_samples
+      end
+
+      # Sets @slowest_sample to the passed in sample if it is slower
+      # than the current sample in @slowest_sample
+      def store_slowest_sample(sample)
+        if slowest_sample?(@slowest_sample, sample)
+          @slowest_sample = sample
+        end
+      end
+
+      # Checks to see if the old sample exists, or if it's duration is
+      # less than the new sample
+      def slowest_sample?(old_sample, new_sample)
+        old_sample.nil? || (new_sample.duration > old_sample.duration)
+      end
+
+      # Smashes the @samples array down to the length of @max_samples
+      # by taking the last @max_samples elements of the array
+      def truncate_samples
+        if @samples.length > @max_samples
+          @samples = @samples[-@max_samples..-1]
+        end
+      end
+
+      # Delegates to the builder to store the path, uri, and
+      # parameters if the sampler is active
+      def notice_transaction(path, uri=nil, params={})
+        builder.set_transaction_info(path, uri, params) if !disabled && builder
+      end
+
+      # Tells the builder to ignore a transaction, if we are currently
+      # creating one. Only causes the sample to be ignored upon end of
+      # the transaction, and does not change the metrics gathered
+      # outside of the sampler
+      def ignore_transaction
+        builder.ignore_transaction if builder
+      end
+
+      # For developer mode profiling support - delegates to the builder
+      def notice_profile(profile)
+        builder.set_profile(profile) if builder
+      end
+
+      # Sets the CPU time used by a transaction, delegates to the builder
+      def notice_transaction_cpu_time(cpu_time)
+        builder.set_transaction_cpu_time(cpu_time) if builder
+      end
+
+      MAX_DATA_LENGTH = 16384
+      # This method is used to record metadata into the currently
+      # active segment like a sql query, memcache key, or Net::HTTP uri
+      #
+      # duration is seconds, float value.
+      def notice_extra_data(message, duration, key, config=nil, config_key=nil)
+        return unless builder
+        segment = builder.current_segment
+        if segment
+          new_message = truncate_message(append_new_message(segment[key],
+                                                            message))
+          if key == :sql && config.respond_to?(:has_key?) && config.has_key?(:adapter)
+            segment[key] = Database::Statement.new(new_message)
+            segment[key].adapter = config[:adapter]
+          else
+            segment[key] = new_message
+          end
+          segment[config_key] = config if config_key
+          append_backtrace(segment, duration)
+        end
+      end
+
+      private :notice_extra_data
+
+      # Truncates the message to `MAX_DATA_LENGTH` if needed, and
+      # appends an ellipsis because it makes the trucation clearer in
+      # the UI
+      def truncate_message(message)
+        if message.length > (MAX_DATA_LENGTH - 4)
+          message[0..MAX_DATA_LENGTH - 4] + '...'
+        else
+          message
+        end
+      end
+
+      # Allows the addition of multiple pieces of metadata to one
+      # segment - i.e. traced method calls multiple sql queries
+      def append_new_message(old_message, message)
+        if old_message
+          old_message + ";\n" + message
+        else
+          message
+        end
+      end
+
+      # Appends a backtrace to a segment if that segment took longer
+      # than the specified duration
+      def append_backtrace(segment, duration)
+        segment[:backtrace] = caller.join("\n") if (duration >= @stack_trace_threshold || Thread.current[:capture_deep_tt])
+      end
+
+      # some statements (particularly INSERTS with large BLOBS
+      # may be very large; we should trim them to a maximum usable length
+      # config is the driver configuration for the connection
+      # duration is seconds, float value.
+      def notice_sql(sql, config, duration)
+        if NewRelic::Agent.is_sql_recorded?
+          notice_extra_data(sql, duration, :sql, config, :connection_config)
+        end
+      end
+
+      # Adds non-sql metadata to a segment - generally the memcached
+      # key
+      #
+      # duration is seconds, float value.
+      def notice_nosql(key, duration)
+        notice_extra_data(key, duration, :key)
+      end
+
+      # Every 1/n harvests, adds the most recent sample to the harvest
+      # array if it exists. Makes sure that the random sample is not
+      # also the slowest sample for this harvest by `uniq!`ing the
+      # result array
+      #
+      # random sampling is very, very seldom used
+      def add_random_sample_to(result)
+        return unless @random_sampling && @sampling_rate && @sampling_rate.to_i > 0
+        @harvest_count += 1
+        if (@harvest_count.to_i % @sampling_rate.to_i) == 0
+          result << @random_sample if @random_sample
+          @harvest_count = 0
+        end
+        nil # don't assume this method returns anything
+      end
+
+      def add_force_persist_to(result)
+        result.concat(@force_persist)
+        @force_persist = []
+      end
+
+      # Returns an array of slow samples, with either one or two
+      # elements - one element unless random sampling is enabled. The
+      # sample returned will be the slowest sample among those
+      # available during this harvest
+      def add_samples_to(result, slow_threshold)
+
+        # pull out force persist
+        force_persist = result.select {|sample| sample.force_persist} || []
+        result.reject! {|sample| sample.force_persist}
+
+        force_persist.each {|sample| store_force_persist(sample)}
+
+
+        # Now get the slowest sample
+        if @slowest_sample && @slowest_sample.duration >= slow_threshold
+          result << @slowest_sample
+        end
+
+        result.compact!
+        result = result.sort_by { |x| x.duration }
+        result = result[-1..-1] || []               # take the slowest sample
+
+        add_random_sample_to(result)
+        add_force_persist_to(result)
+
+        result.uniq
+      end
+
+      # get the set of collected samples, merging into previous samples,
+      # and clear the collected sample list. Truncates samples to a
+      # specified @segment_limit to save memory and bandwith
+      # transmitting samples to the server.
+      def harvest(previous = [], slow_threshold = 2.0)
+        return [] if disabled
+        result = Array(previous)
+
+        @samples_lock.synchronize do
+          result = add_samples_to(result, slow_threshold)
+
+          # clear previous transaction samples
+          @slowest_sample = nil
+          @random_sample = nil
+          @last_sample = nil
+        end
+
+        # Clamp the number of TTs we'll keep in memory and send
+        #
+        result = clamp_number_tts(result, 20) if result.length > 20
+
+        # Truncate the samples at 2100 segments. The UI will clamp them at 2000 segments anyway.
+        # This will save us memory and bandwidth.
+        result.each { |sample| sample.truncate(@segment_limit) }
+        result
+      end
+
+      # JON - THIS CODE NEEDS A UNIT TEST
+      def clamp_number_tts(tts, limit)
+        tts.sort! do |a,b|
+          if a.force_persist && b.force_persist
+            b.duration <=> a.duration
+          elsif a.force_persist
+            -1
+          elsif b.force_persist
+            1
+          else
+            b.duration <=> a.duration
+          end
+        end
+
+        tts[0..(limit-1)]
+      end
+
+      # reset samples without rebooting the web server
+      def reset!
+        @samples = []
+        @last_sample = nil
+        @random_sample = nil
+        @slowest_sample = nil
+      end
+
+      # Checks to see if the transaction sampler is disabled, if
+      # transaction trace recording is disabled by a thread local, or
+      # if execution is untraced - if so it clears the transaction
+      # sample builder from the thread local, otherwise it generates a
+      # new transaction sample builder with the stated time as a
+      # starting point and saves it in the thread local variable
+      def start_builder(time=nil)
+        if disabled || !NewRelic::Agent.is_transaction_traced? || !NewRelic::Agent.is_execution_traced?
+          clear_builder
+        else
+          Thread::current[BUILDER_KEY] ||= TransactionSampleBuilder.new(time)
+        end
+      end
+
+      # The current thread-local transaction sample builder
+      def builder
+        Thread::current[BUILDER_KEY]
+      end
+
+      # Sets the thread local variable storing the transaction sample
+      # builder to nil to clear it
+      def clear_builder
+        Thread::current[BUILDER_KEY] = nil
+      end
+
+    end
+  end
+end