oneapm_rpm 1.1.0

data/lib/one_apm/transaction/segment.rb

@@ -0,0 +1,193 @@
+# encoding: utf-8
+
+module OneApm
+  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
+
+      # This is only used from developer mode and rpm_site.
+      # No new clients should be added.
+      attr_reader :segment_id
+
+      attr_accessor :metric_name
+
+      UNKNOWN_SEGMENT_NAME = '<unknown>'.freeze
+
+      def initialize(timestamp, metric_name, segment_id=nil)
+        @entry_timestamp = timestamp
+        @metric_name     = metric_name || UNKNOWN_SEGMENT_NAME
+        @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
+
+      include OneApm::Coerce
+
+      def to_array
+        [ OneApm::Helper.time_to_millis(@entry_timestamp),
+          OneApm::Helper.time_to_millis(@exit_timestamp),
+          string(@metric_name),
+          (@params || {}) ] +
+          [ (@called_segments ? @called_segments.map{|s| s.to_array} : []) ]
+      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
+
+      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
+
+      def params=(p)
+        @params = p
+      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
+
+      # This is only for use by developer mode
+      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
+        return params[:explain_plan] if params.key?(:explain_plan)
+
+        statement = params[:sql]
+        return nil unless statement.respond_to?(:config) &&
+                          statement.respond_to?(:explainer)
+
+        OneApm::Agent::Database.explain_sql(statement,
+                                              statement.config,
+                                              &statement.explainer)
+      end
+
+      def obfuscated_sql
+        OneApm::Agent::Database.obfuscate_sql(params[:sql])
+      end
+
+      def called_segments=(segments)
+        @called_segments = segments
+      end
+
+      protected
+      def parent_segment=(s)
+        @parent_segment = s
+      end
+    end
+  end
+end

data/lib/one_apm/transaction/segment_summary.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module OneApm
+  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'
+        OneApm::MetricParser::MetricParser.parse(@metric_name).developer_name
+      end
+    end
+  end
+end

data/lib/one_apm/transaction/thread_local_access.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module OneApm
+  class Transaction
+    module ThreadLocalAccess
+
+      def tl_current
+        TransactionState.tl_get.current_transaction
+      end
+
+      def set_default_transaction_name(name, category = nil, segment_name = nil)
+        txn  = tl_current
+        name = txn.make_transaction_name(name, category)
+        txn.name_last_frame(segment_name || name)
+        txn.set_default_transaction_name(name, category)
+      end
+
+      def set_overriding_transaction_name(name, category = nil)
+        txn = tl_current
+        return unless txn
+
+        name = txn.make_transaction_name(name, category)
+
+        txn.name_last_frame(name)
+        txn.set_overriding_transaction_name(name, category)
+      end
+
+      # Indicate that you don't want to keep the currently saved transaction
+      # information
+      def abort_transaction! #THREAD_LOCAL_ACCESS
+        state = OneApm::TransactionState.tl_get
+        txn = state.current_transaction
+        txn.abort_transaction!(state) if txn
+      end
+
+      # If we have an active transaction, notice the error and increment the error metric.
+      # Options:
+      # * <tt>:request</tt> => Request object to get the uri and referer
+      # * <tt>:uri</tt> => The request path, minus any request params or query string.
+      # * <tt>:referer</tt> => The URI of the referer
+      # * <tt>:metric</tt> => The metric name associated with the transaction
+      # * <tt>:request_params</tt> => Request parameters, already filtered if necessary
+      # * <tt>:custom_params</tt> => Custom parameters
+      # Anything left over is treated as custom params
+
+      def notice_error(e, options={})
+        options = extract_request_options(options)
+        state = OneApm::TransactionState.tl_get
+        txn = state.current_transaction
+        if txn
+          txn.notice_error(e, options)
+        else
+          OneApm::Agent.instance.error_collector.notice_error(e, options)
+        end
+      end
+
+      def extract_request_options(options)
+        req = options.delete(:request)
+        if req
+          options[:uri]     = uri_from_request(req)
+          options[:referer] = referer_from_request(req)
+        end
+        options
+      end
+
+      def recording_web_transaction?
+        txn = tl_current
+        txn && txn.recording_web_transaction?
+      end
+
+    end
+  end
+end

data/lib/one_apm/transaction/transaction_analysis.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+require 'one_apm/transaction/segment_summary'
+# Add these methods to TransactionSample that enable performance analysis in the user interface.
+module OneApm
+  module TransactionAnalysis
+    def database_time
+      time_percentage(/^Database\/.*/)
+    end
+
+    def render_time
+      time_percentage(/^View\/.*/)
+    end
+
+    # return the data that breaks down the performance of the transaction
+    # as an array of SegmentSummary objects.  If a limit is specified, then
+    # limit the data set to the top n
+    def breakdown_data(limit = nil)
+      metric_hash = {}
+      each_segment_with_nest_tracking do |segment|
+        unless segment == root_segment
+          metric_name = segment.metric_name
+          metric_hash[metric_name] ||= SegmentSummary.new(metric_name, self)
+          metric_hash[metric_name] << segment
+          metric_hash[metric_name]
+        end
+      end
+
+      data = metric_hash.values
+
+      data.sort! do |x,y|
+        y.exclusive_time <=> x.exclusive_time
+      end
+
+      if limit && data.length > limit
+        data = data[0..limit - 1]
+      end
+
+      # add one last segment for the remaining time if any
+      remainder = duration
+      data.each do |segment|
+        remainder -= segment.exclusive_time
+      end
+
+      if (remainder*1000).round > 0
+        remainder_summary = SegmentSummary.new('Remainder', self)
+        remainder_summary.total_time = remainder_summary.exclusive_time = remainder
+        remainder_summary.call_count = 1
+        data << remainder_summary
+      end
+
+      data
+    end
+
+    # return an array of sql statements executed by this transaction
+    # each element in the array contains [sql, parent_segment_metric_name, duration]
+    def sql_segments(show_non_sql_segments = true)
+      segments = []
+      each_segment do |segment|
+        segments << segment if segment[:sql] || segment[:sql_obfuscated] || (show_non_sql_segments && segment[:key])
+      end
+      segments
+    end
+
+    private
+    def time_percentage(regex)
+      total = 0
+      each_segment do |segment|
+        if regex =~ segment.metric_name
+          total += segment.duration
+        end
+      end
+      fraction = 100.0 * total / duration
+      # percent value rounded to two digits:
+      return (100 * fraction).round / 100.0
+    end
+  end
+end

data/lib/one_apm/transaction/transaction_apdex.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module OneApm
+  class Transaction
+
+    def apdex_bucket(duration)
+      Transaction.apdex_bucket(duration, had_error?, apdex_t)
+    end
+
+    def apdex_t
+      transaction_specific_apdex_t || Agent.config[:apdex_t]
+    end
+
+    def transaction_specific_apdex_t
+      key = :web_transactions_apdex
+      Agent.config[key] && Agent.config[key][best_name]
+    end
+
+  end
+end

data/lib/one_apm/transaction/transaction_cpu.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module OneApm
+  class Transaction
+
+    def cpu_burn
+      normal_cpu_burn || jruby_cpu_burn
+    end
+
+    def normal_cpu_burn
+      return unless @process_cpu_start
+      process_cpu - @process_cpu_start
+    end
+
+    def process_cpu
+      return nil if defined? JRuby
+      p = Process.times
+      p.stime + p.utime
+    end
+
+  end
+end

data/lib/one_apm/transaction/transaction_finish_append.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module OneApm
+  class Transaction
+    module TransactionFinishAppend
+
+      def append_cat_info(state, duration, payload)
+        return unless include_guid?(state, duration)
+        payload[:guid] = guid
+
+        return unless state.is_cross_app?
+        trip_id             = cat_trip_id(state)
+        path_hash           = cat_path_hash(state)
+        referring_path_hash = cat_referring_path_hash(state)
+
+        payload[:cat_trip_id]             = trip_id             if trip_id
+        payload[:cat_referring_path_hash] = referring_path_hash if referring_path_hash
+
+        if path_hash
+          payload[:cat_path_hash] = path_hash
+
+          alternate_path_hashes = cat_path_hashes - [path_hash]
+          unless alternate_path_hashes.empty?
+            payload[:cat_alternate_path_hashes] = alternate_path_hashes
+          end
+        end
+      end
+
+      def append_apdex_perf_zone(duration, payload)
+        return unless recording_web_transaction?
+
+        bucket = apdex_bucket(duration)
+        bucket_str = case bucket
+        when :apdex_s then Transaction::APDEX_S
+        when :apdex_t then Transaction::APDEX_T
+        when :apdex_f then Transaction::APDEX_F
+        else nil
+        end
+        payload[:apdex_perf_zone] = bucket_str if bucket_str
+      end
+
+      def append_referring_transaction_guid_to(state, payload)
+        referring_guid = OneApm::Agent.instance.cross_app_monitor.client_referring_transaction_guid(state)
+        if referring_guid
+          payload[:referring_transaction_guid] = referring_guid
+        end
+      end
+
+      def append_http_response_code(payload)
+        payload[:http_response_code] = http_response_code if http_response_code
+      end
+
+      def append_synthetics_to(state, payload)
+        return unless is_synthetics_request?
+
+        payload[:synthetics_resource_id] = synthetics_resource_id
+        payload[:synthetics_job_id]      = synthetics_job_id
+        payload[:synthetics_monitor_id]  = synthetics_monitor_id
+      end
+
+      def include_guid?(state, duration)
+        state.is_cross_app? || is_synthetics_request?
+      end
+
+    end
+  end
+end