wd_newrelic_rpm 3.3.4.1

data/lib/new_relic/transaction_analysis/segment_summary.rb

@@ -0,0 +1,49 @@
+module NewRelic
+  module TransactionAnalysis
+    # summarizes performance data for all calls to segments
+    # with the same metric_name
+    class SegmentSummary
+      attr_accessor :metric_name, :total_time, :exclusive_time, :call_count, :current_nest_count
+      def initialize(metric_name, sample)
+        @metric_name = metric_name
+        @total_time, @exclusive_time, @call_count = 0,0,0
+        @sample = sample
+        @current_nest_count = 0
+      end
+
+      def <<(segment)
+        if metric_name != segment.metric_name
+          raise ArgumentError, "Metric Name Mismatch: #{segment.metric_name} != #{metric_name}"
+        end
+
+        # a nested segment should use the sum of the top level totals
+        @total_time += segment.duration if current_nest_count == 0
+        @exclusive_time += segment.exclusive_duration
+        @call_count += 1
+      end
+
+      def average_time
+        @total_time / @call_count
+      end
+
+      def average_exclusive_time
+        @exclusive_time / @call_count
+      end
+
+      def exclusive_time_percentage
+        return 0 unless @exclusive_time && @sample.duration && @sample.duration > 0
+        @exclusive_time / @sample.duration
+      end
+
+      def total_time_percentage
+        return 0 unless @total_time && @sample.duration && @sample.duration > 0
+        @total_time / @sample.duration
+      end
+
+      def ui_name
+        return @metric_name if @metric_name == 'Remainder'
+        NewRelic::MetricParser::MetricParser.parse(@metric_name).developer_name
+      end
+    end
+  end
+end

data/lib/new_relic/transaction_sample.rb

@@ -0,0 +1,261 @@
+require 'new_relic/transaction_sample/segment'
+require 'new_relic/transaction_sample/summary_segment'
+require 'new_relic/transaction_sample/fake_segment'
+require 'new_relic/transaction_sample/composite_segment'
+module NewRelic
+  # the number of segments that need to exist before we roll them up
+  # into one segment with multiple executions
+  COLLAPSE_SEGMENTS_THRESHOLD = 2
+
+  class TransactionSample
+
+    attr_accessor :params, :root_segment, :profile, :force_persist, :guid
+    attr_reader :root_segment, :params, :sample_id
+
+    @@start_time = Time.now
+
+    include TransactionAnalysis
+
+    def initialize(time = Time.now.to_f, sample_id = nil)
+      @sample_id = sample_id || object_id
+      @start_time = time
+      @params = { :segment_count => -1, :request_params => {} }
+      @segment_count = -1
+      @root_segment = create_segment 0.0, "ROOT"
+
+      @guid = generate_guid
+      NewRelic::Agent::TransactionInfo.get.guid = @guid
+    end
+
+    def count_segments
+      @segment_count
+    end
+
+    # Truncates the transaction sample to a maximum length determined
+    # by the passed-in parameter. Operates recursively on the entire
+    # tree of transaction segments in a depth-first manner
+    def truncate(max)
+      return if @segment_count < max
+      @root_segment.truncate(max + 1)
+      @segment_count = max
+    end
+
+    # makes sure that the parameter cache for segment count is set to
+    # the correct value
+    def ensure_segment_count_set(count)
+      params[:segment_count] ||= count
+    end
+
+    # offset from start of app
+    def timestamp
+      @start_time - @@start_time.to_f
+    end
+
+    # Used in the server only
+    def to_json(options = {}) #:nodoc:
+      map = {:sample_id => @sample_id,
+        :start_time => @start_time,
+        :root_segment => @root_segment}
+      if @params && !@params.empty?
+        map[:params] = @params
+      end
+      map.to_json
+    end
+
+    def start_time
+      Time.at(@start_time)
+    end
+
+    def path_string
+      @root_segment.path_string
+    end
+
+    def create_segment(relative_timestamp, metric_name, segment_id = nil)
+      raise TypeError.new("Frozen Transaction Sample") if frozen?
+      @params[:segment_count] += 1
+      @segment_count += 1
+      NewRelic::TransactionSample::Segment.new(relative_timestamp, metric_name, segment_id)
+    end
+
+    def duration
+      root_segment.duration
+    end
+
+    # Iterates recursively over each segment in the entire transaction
+    # sample tree
+    def each_segment(&block)
+      @root_segment.each_segment(&block)
+    end
+
+    # Iterates recursively over each segment in the entire transaction
+    # sample tree while keeping track of nested segments
+    def each_segment_with_nest_tracking(&block)
+      @root_segment.each_segment_with_nest_tracking(&block)
+    end
+
+    def to_s_compact
+      @root_segment.to_s_compact
+    end
+
+    # Searches the tree recursively for the segment with the given
+    # id. note that this is an internal id, not an ActiveRecord id
+    def find_segment(id)
+      @root_segment.find_segment(id)
+    end
+
+    def to_s
+      s = "Transaction Sample collected at #{start_time}\n"
+      s << "  {\n"
+      s << "  Path: #{params[:path]} \n"
+
+      params.each do |k,v|
+        next if k == :path
+        s << "  #{k}: " <<
+        case v
+          when Enumerable then v.map(&:to_s).sort.join("; ")
+          when String then v
+          when Float then '%6.3s' % v
+          when Fixnum then v.to_s
+          when nil then ''
+        else
+          raise "unexpected value type for #{k}: '#{v}' (#{v.class})"
+        end << "\n"
+      end
+      s << "  }\n\n"
+      s <<  @root_segment.to_debug_str(0)
+    end
+
+    # return a new transaction sample that treats segments
+    # with the given regular expression in their name as if they
+    # were never called at all.  This allows us to strip out segments
+    # from traces captured in development environment that would not
+    # normally show up in production (like Rails/Application Code Loading)
+    def omit_segments_with(regex)
+      regex = Regexp.new(regex)
+
+      sample = TransactionSample.new(@start_time, sample_id)
+      
+      sample.params = params.dup
+      sample.params[:segment_count] = 0
+      
+      delta = build_segment_with_omissions(sample, 0.0, @root_segment, sample.root_segment, regex)
+      sample.root_segment.end_trace(@root_segment.exit_timestamp - delta)
+      sample.profile = self.profile
+      sample
+    end
+
+    # Return a new transaction sample that can be sent to the New
+    # Relic service. This involves potentially one or more of the
+    # following options
+    #
+    #   :explain_sql : run EXPLAIN on all queries whose response times equal the value for this key
+    #       (for example :explain_sql => 2.0 would explain everything over 2 seconds.  0.0 would explain everything.)
+    #   :keep_backtraces : keep backtraces, significantly increasing size of trace (off by default)
+    #   :record_sql => [ :raw | :obfuscated] : copy over the sql, obfuscating if necessary
+    def prepare_to_send(options={})
+      sample = TransactionSample.new(@start_time, sample_id)
+
+      sample.params.merge! self.params
+      sample.guid = self.guid
+      sample.force_persist = self.force_persist if self.force_persist
+
+      begin
+        build_segment_for_transfer(sample, @root_segment, sample.root_segment, options)
+      ensure
+        NewRelic::Agent::Database.close_connections
+      end
+
+      sample.root_segment.end_trace(@root_segment.exit_timestamp)
+      sample
+    end
+
+    def params=(params)
+      @params = params
+    end
+
+  private
+
+
+
+    HEX_DIGITS = (0..15).map{|i| i.to_s(16)}
+    # generate a random 64 bit uuid
+    def generate_guid
+      guid = ''
+      HEX_DIGITS.each do |a|
+        guid << HEX_DIGITS[rand(16)]
+      end
+      guid
+    end
+
+    # This is badly in need of refactoring
+    def build_segment_with_omissions(new_sample, time_delta, source_segment, target_segment, regex)
+      source_segment.called_segments.each do |source_called_segment|
+        # if this segment's metric name matches the given regular expression, bail
+        # here and increase the amount of time that we reduce the target sample with
+        # by this omitted segment's duration.
+        do_omit = regex =~ source_called_segment.metric_name
+
+        if do_omit
+          time_delta += source_called_segment.duration
+        else
+          target_called_segment = new_sample.create_segment(
+                source_called_segment.entry_timestamp - time_delta,
+                source_called_segment.metric_name,
+                source_called_segment.segment_id)
+
+          target_segment.add_called_segment target_called_segment
+          source_called_segment.params.each do |k,v|
+            target_called_segment[k]=v
+          end
+
+          time_delta = build_segment_with_omissions(
+                new_sample, time_delta, source_called_segment, target_called_segment, regex)
+          target_called_segment.end_trace(source_called_segment.exit_timestamp - time_delta)
+        end
+      end
+
+      return time_delta
+    end
+
+    # see prepare_to_send for what we do with options
+    #
+    # This is badly in need of refactoring
+    def build_segment_for_transfer(new_sample, source_segment, target_segment, options)
+      source_segment.called_segments.each do |source_called_segment|
+        target_called_segment = new_sample.create_segment(
+              source_called_segment.entry_timestamp,
+              source_called_segment.metric_name,
+              source_called_segment.segment_id)
+
+        target_segment.add_called_segment target_called_segment
+        source_called_segment.params.each do |k,v|
+          case k
+          when :backtrace
+            target_called_segment[k]=v if options[:keep_backtraces]
+          when :sql
+            # run an EXPLAIN on this sql if specified.
+            if options[:record_sql] && options[:record_sql] &&
+                options[:explain_sql] &&
+                source_called_segment.duration > options[:explain_sql].to_f
+              target_called_segment[:explain_plan] = source_called_segment.explain_sql
+            end
+
+            target_called_segment[:sql] = case options[:record_sql]
+              when :raw then v
+              when :obfuscated then NewRelic::Agent::Database.obfuscate_sql(v)
+              else raise "Invalid value for record_sql: #{options[:record_sql]}"
+            end.to_s if options[:record_sql]
+          when :connection_config
+            # don't copy it
+          else
+            target_called_segment[k]=v
+          end
+        end
+
+        build_segment_for_transfer(new_sample, source_called_segment, target_called_segment, options)
+        target_called_segment.end_trace(source_called_segment.exit_timestamp)
+      end
+    end
+
+  end
+end

data/lib/new_relic/transaction_sample/composite_segment.rb

@@ -0,0 +1,27 @@
+require 'new_relic/transaction_sample'
+require 'new_relic/transaction_sample/segment'
+require 'new_relic/transaction_sample/summary_segment'
+module NewRelic
+  class TransactionSample
+    class CompositeSegment < Segment
+      attr_reader :detail_segments
+
+      def initialize(segments)
+        summary = SummarySegment.new(segments.first)
+        super summary.entry_timestamp, "Repeating pattern (#{segments.length} repeats)", nil
+
+        summary.end_trace(segments.last.exit_timestamp)
+
+        @detail_segments = segments.clone
+
+        add_called_segment(summary)
+        end_trace summary.exit_timestamp
+      end
+
+      def detail_segments=(segments)
+        @detail_segments = segments
+      end
+
+    end
+  end
+end

data/lib/new_relic/transaction_sample/fake_segment.rb

@@ -0,0 +1,9 @@
+require 'new_relic/transaction_sample'
+require 'new_relic/transaction_sample/segment'
+module NewRelic
+  class TransactionSample
+    class FakeSegment < Segment
+      public :parent_segment=
+    end
+  end
+end

data/lib/new_relic/transaction_sample/segment.rb

@@ -0,0 +1,203 @@
+require 'new_relic/transaction_sample'
+module NewRelic
+  class TransactionSample
+    class Segment
+      attr_reader :entry_timestamp
+      # The exit timestamp will be relative except for the outermost sample which will
+      # have a timestamp.
+      attr_reader :exit_timestamp
+      attr_reader :parent_segment
+      attr_reader :metric_name
+      attr_reader :segment_id
+
+      def initialize(timestamp, metric_name, segment_id)
+        @entry_timestamp = timestamp
+        @metric_name = metric_name || '<unknown>'
+        @segment_id = segment_id || object_id
+      end
+      
+      # sets the final timestamp on a segment to indicate the exit
+      # point of the segment
+      def end_trace(timestamp)
+        @exit_timestamp = timestamp
+      end
+      
+      def add_called_segment(s)
+        @called_segments ||= []
+        @called_segments << s
+        s.parent_segment = self
+      end
+
+      def to_s
+        to_debug_str(0)
+      end
+
+      def to_json(options={})
+        hash = {
+          :entry_timestamp => @entry_timestamp,
+          :exit_timestamp => @exit_timestamp,
+          :metric_name => @metric_name,
+          :segment_id => @segment_id,
+        }
+
+        hash[:called_segments] = called_segments if !called_segments.empty?
+        hash[:params] = @params if @params && !@params.empty?
+
+        hash.to_json
+      end
+
+      def path_string
+        "#{metric_name}[#{called_segments.collect {|segment| segment.path_string }.join('')}]"
+      end
+      def to_s_compact
+        str = ""
+        str << metric_name
+        if called_segments.any?
+          str << "{#{called_segments.map { | cs | cs.to_s_compact }.join(",")}}"
+        end
+        str
+      end
+      def to_debug_str(depth)
+        tab = "  " * depth
+        s = tab.clone
+        s << ">> #{'%3i ms' % (@entry_timestamp*1000)} [#{self.class.name.split("::").last}] #{metric_name} \n"
+        unless params.empty?
+          params.each do |k,v|
+            s << "#{tab}    -#{'%-16s' % k}: #{v.to_s[0..80]}\n"
+          end
+        end
+        called_segments.each do |cs|
+          s << cs.to_debug_str(depth + 1)
+        end
+        s << tab + "<< "
+        s << case @exit_timestamp
+             when nil then ' n/a'
+             when Numeric then '%3i ms' % (@exit_timestamp*1000)
+             else @exit_timestamp.to_s
+             end
+        s << " #{metric_name}\n"
+      end
+
+      def called_segments
+        @called_segments || []
+      end
+
+      # return the total duration of this segment
+      def duration
+        (@exit_timestamp - @entry_timestamp).to_f
+      end
+
+      # return the duration of this segment without
+      # including the time in the called segments
+      def exclusive_duration
+        d = duration
+
+        called_segments.each do |segment|
+          d -= segment.duration
+        end
+        d
+      end
+      
+      def count_segments
+        count = 1
+        called_segments.each { | seg | count  += seg.count_segments }
+        count
+      end
+      
+      # Walk through the tree and truncate the segments in a
+      # depth-first manner
+      def truncate(max)
+        return 1 unless @called_segments
+        total, self.called_segments = truncate_each_child(max - 1)
+        total+1
+      end
+
+      def truncate_each_child(max)
+        total = 0
+        accumulator = []
+        called_segments.each { | s |
+          if total == max
+            true
+          else
+            total += s.truncate(max - total)
+            accumulator << s
+          end
+        }
+        total
+        [total, accumulator]
+      end
+
+      def []=(key, value)
+        # only create a parameters field if a parameter is set; this will save
+        # bandwidth etc as most segments have no parameters
+        params[key] = value
+      end
+
+      def [](key)
+        params[key]
+      end
+
+      def params
+        @params ||= {}
+      end
+
+      # call the provided block for this segment and each
+      # of the called segments
+      def each_segment(&block)
+        block.call self
+
+        if @called_segments
+          @called_segments.each do |segment|
+            segment.each_segment(&block)
+          end
+        end
+      end
+
+      # call the provided block for this segment and each
+      # of the called segments while keeping track of nested segments
+      def each_segment_with_nest_tracking(&block)
+        summary = block.call self
+        summary.current_nest_count += 1 if summary
+
+        if @called_segments
+          @called_segments.each do |segment|
+            segment.each_segment_with_nest_tracking(&block)
+          end
+        end
+
+        summary.current_nest_count -= 1 if summary
+      end
+
+      def find_segment(id)
+        return self if @segment_id == id
+        called_segments.each do |segment|
+          found = segment.find_segment(id)
+          return found if found
+        end
+        nil
+      end
+      
+      def explain_sql
+        NewRelic::Agent::Database.explain_sql(params[:sql],
+                                              params[:connection_config])
+      end
+      
+      def obfuscated_sql
+        NewRelic::Agent::Database.obfuscate_sql(params[:sql])
+      end
+      
+      def params=(p)
+        @params = p
+      end
+
+      def called_segments=(segments)
+        @called_segments = segments
+      end
+
+      protected
+      def parent_segment=(s)
+        @parent_segment = s
+      end
+    end
+  end
+end