wd_newrelic_rpm 3.3.4.1 → 3.5.5

data/lib/new_relic/agent/thread.rb

@@ -0,0 +1,32 @@
+module NewRelic
+  module Agent
+
+    class AgentThread < ::Thread
+      def initialize(label)
+        ::NewRelic::Agent.logger.debug("Creating New Relic thread: #{label}")
+        self[:newrelic_label] = label
+        super
+      end
+
+      def self.bucket_thread(thread, profile_agent_code)
+        if thread.key?(:newrelic_label)
+          return profile_agent_code ? :agent : :ignore
+        elsif !thread[:newrelic_metric_frame].nil?
+          thread[:newrelic_metric_frame].request.nil? ? :background : :request
+        else
+          :other
+        end
+      end
+
+      def self.scrub_backtrace(thread, profile_agent_code)
+        begin
+          bt = thread.backtrace
+        rescue Exception => e
+          ::NewRelic::Agent.logger.debug("Failed to backtrace #{thread.inspect}: #{e.class.name}: #{e.to_s}")
+        end
+        return nil unless bt
+        profile_agent_code ? bt : bt.select { |t| t !~ /\/newrelic_rpm-\d/ }
+      end
+    end
+  end
+end

data/lib/new_relic/agent/thread_profiler.rb

@@ -0,0 +1,306 @@
+require 'new_relic/agent/thread'
+require 'new_relic/agent/worker_loop'
+
+module NewRelic
+  module Agent
+
+    class ThreadProfiler
+
+      attr_reader :profile
+
+      def self.is_supported?
+        RUBY_VERSION >= "1.9.2"
+      end
+
+      def start(profile_id, duration, interval, profile_agent_code)
+        if !ThreadProfiler.is_supported?
+          ::NewRelic::Agent.logger.debug("Not starting thread profile as it isn't supported on this environment")
+          @profile = nil
+        else
+          ::NewRelic::Agent.logger.debug("Starting thread profile. profile_id=#{profile_id}, duration=#{duration}")
+          @profile = ThreadProfile.new(profile_id, duration, interval, profile_agent_code)
+          @profile.run
+        end
+      end
+
+      def stop(report_data)
+        @profile.stop unless @profile.nil?
+        @profile = nil if !report_data
+      end
+
+      def harvest
+        profile = @profile
+        @profile = nil
+        profile
+      end
+
+      def respond_to_commands(commands, &notify_results)
+        return if commands.empty? || commands.first.size < 2 
+
+        # Doesn't deal with multiple commands in the return set  as 
+        # we currently only have start/stop of thread profiling
+        command_id = commands.first[0]
+        command = commands.first[1]
+
+        name = command["name"]
+        arguments = command["arguments"]
+
+        if (ThreadProfiler.is_supported?)
+          case name
+            when "start_profiler"
+              start_unless_running_and_notify(command_id, arguments, &notify_results)
+
+            when "stop_profiler"
+              stop_and_notify(command_id, arguments, &notify_results)
+          end
+        else
+          msg = <<-EOF
+Thread profiling is only supported on 1.9.2 and greater versions of Ruby.
+We detected running agents capable of profiling, but the profile started with
+an agent running Ruby #{RUBY_VERSION}.
+
+Profiling again might select an appropriate agent, but we recommend running a
+consistent version of Ruby across your application for better results.
+EOF
+          ::NewRelic::Agent.logger.debug(msg)
+          notify_results.call(command_id, msg) if !notify_results.nil?
+        end
+      end
+
+      def running?
+        !@profile.nil?
+      end
+
+      def finished?
+        @profile && @profile.finished?
+      end
+
+      private
+
+      def start_unless_running_and_notify(command_id, arguments)
+        profile_id = arguments.fetch("profile_id", -1)
+        duration =   arguments.fetch("duration", 120)
+        interval =   arguments.fetch("sample_period", 0.1)
+        profile_agent_code = arguments.fetch("profile_agent_code", true)
+
+        if running?
+          msg = "Profile already in progress. Ignoring agent command to start another."
+          ::NewRelic::Agent.logger.debug(msg)
+          yield(command_id, msg) if block_given?
+        else
+          start(profile_id, duration, interval, profile_agent_code)
+          yield(command_id) if block_given?
+        end
+      end
+
+      def stop_and_notify(command_id, arguments)
+        report_data = arguments.fetch("report_data", true)
+        stop(report_data)
+        yield(command_id) if block_given?
+      end
+
+    end
+
+    class ThreadProfile
+
+      attr_reader :profile_id, 
+        :traces, 
+        :profile_agent_code, :interval, 
+        :poll_count, :sample_count, 
+        :start_time, :stop_time
+
+      def initialize(profile_id, duration, interval, profile_agent_code)
+        @profile_id = profile_id
+        @profile_agent_code = profile_agent_code
+
+        @worker_loop = NewRelic::Agent::WorkerLoop.new(:duration => duration)
+        @interval = interval
+        @finished = false
+
+        @traces = {
+          :agent => [],
+          :background => [],
+          :other => [],
+          :request => []
+        }
+        @flattened_nodes = []
+
+        @poll_count = 0
+        @sample_count = 0
+        @failure_count = 0
+      end
+
+      def run
+        AgentThread.new('Thread Profiler') do
+          @start_time = now_in_millis
+
+          @worker_loop.run(@interval) do
+            NewRelic::Agent.instance.stats_engine.
+              record_supportability_metrics_timed("ThreadProfiler/PollingTime") do
+
+              @poll_count += 1
+              AgentThread.list.each do |t|
+                bucket = AgentThread.bucket_thread(t, @profile_agent_code)
+                if bucket != :ignore
+                  backtrace = AgentThread.scrub_backtrace(t, @profile_agent_code)
+                  if backtrace.nil?
+                    @failure_count += 1
+                  else
+                    @sample_count += 1
+                    aggregate(backtrace, @traces[bucket])
+                  end
+                end
+              end
+            end
+          end
+
+          mark_done
+          ::NewRelic::Agent.logger.debug("Finished thread profile. #{@sample_count} backtraces, #{@failure_count} failures. Will send with next harvest.")
+          NewRelic::Agent.instance.stats_engine.
+            record_supportability_metrics_count(@failure_count, "ThreadProfiler/BacktraceFailures")
+        end
+      end
+
+      def stop
+        @worker_loop.stop
+        mark_done
+        ::NewRelic::Agent.logger.debug("Stopping thread profile.")
+      end
+
+      def aggregate(trace, trees=@traces[:request], parent=nil)
+        return nil if trace.nil? || trace.empty?
+        node = Node.new(trace.last)
+        existing = trees.find {|n| n == node}
+
+        if existing.nil?
+          existing = node
+          @flattened_nodes << node
+        end
+
+        if parent
+          parent.add_child(node)
+        else
+          trees << node unless trees.include? node
+        end
+
+        existing.runnable_count += 1
+        aggregate(trace[0..-2], existing.children, existing)
+
+        existing
+      end
+
+      def prune!(count_to_keep)
+        @flattened_nodes.sort!(&:order_for_pruning)
+
+        NewRelic::Agent.instance.stats_engine.
+          record_supportability_metrics_count(@flattened_nodes.size, "ThreadProfiler/NodeCount")
+
+        mark_for_pruning(@flattened_nodes, count_to_keep)
+
+        traces.each { |_, nodes| Node.prune!(nodes) }
+      end
+
+      THREAD_PROFILER_NODES = 20_000
+
+      def to_collector_array(encoder)
+        prune!(THREAD_PROFILER_NODES)
+
+        traces = {
+          "OTHER" => @traces[:other].map{|t| t.to_array },
+          "REQUEST" => @traces[:request].map{|t| t.to_array },
+          "AGENT" => @traces[:agent].map{|t| t.to_array },
+          "BACKGROUND" => @traces[:background].map{|t| t.to_array }
+        }
+
+        [[@profile_id,
+          @start_time.to_f, @stop_time.to_f,
+          @poll_count,
+          encoder.encode(traces),
+          @sample_count, 0]]
+      end
+
+      def now_in_millis
+        Time.now.to_f * 1_000
+      end
+
+      def finished?
+        @finished
+      end
+
+      def mark_done
+        @finished = true
+        @stop_time = now_in_millis
+      end
+
+      def mark_for_pruning(nodes, count_to_keep)
+        to_prune = nodes[count_to_keep..-1] || []
+        to_prune.each { |n| n.to_prune = true }
+      end
+
+      def self.flattened_nodes(nodes)
+        nodes.map { |n| [n, flattened_nodes(n.children)] }.flatten
+      end
+
+      def self.parse_backtrace(trace)
+        trace.map do |line|
+          line =~ /(.*)\:(\d+)\:in `(.*)'/
+          { :method => $3, :line_no => $2.to_i, :file => $1 }
+        end
+      end
+
+      class Node
+        attr_reader :file, :method, :line_no, :children
+        attr_accessor :runnable_count, :to_prune, :depth
+
+        def initialize(line, parent=nil)
+          line =~ /(.*)\:(\d+)\:in `(.*)'/
+          @file = $1
+          @method = $3
+          @line_no = $2.to_i
+          @children = []
+          @runnable_count = 0
+          @to_prune = false
+          @depth = 0
+
+          parent.add_child(self) if parent
+        end
+
+        def ==(other)
+          @file == other.file &&
+            @method == other.method &&
+            @line_no == other.line_no
+        end
+
+        def total_count
+          @runnable_count
+        end
+
+        # Descending order on count, ascending on depth of nodes
+        def order_for_pruning(y)
+          [-runnable_count, depth] <=> [-y.runnable_count, y.depth]
+        end
+
+        def to_array
+          [[@file, @method, @line_no],
+            @runnable_count, 0,
+            @children.map {|c| c.to_array}]
+        end
+
+        def add_child(child)
+          child.depth = @depth + 1
+          @children << child unless @children.include? child
+        end
+
+        def prune!
+          Node.prune!(@children)
+        end
+
+        def self.prune!(kids)
+          kids.delete_if { |child| child.to_prune }
+          kids.each { |child| child.prune! }
+        end
+      end
+
+    end
+  end
+end

data/lib/new_relic/agent/transaction_info.rb

@@ -11,14 +11,15 @@ module NewRelic
         @guid = ""
         @transaction_name = "(unknown)"
         @start_time = Time.now
+        @ignore_end_user = false
       end
 
       def force_persist_sample?(sample)
-        token && sample.duration > NewRelic::Control.instance.apdex_t
+        token && sample.duration > Agent.config[:apdex_t]
       end
 
       def include_guid?
-        token && duration > NewRelic::Control.instance.apdex_t
+        token && duration > Agent.config[:apdex_t]
       end
 
       def guid
@@ -33,6 +34,14 @@ module NewRelic
         Time.now - start_time
       end
 
+      def ignore_end_user?
+        @ignore_end_user
+      end
+      
+      def ignore_end_user=(value)
+        @ignore_end_user = value
+      end
+
       def self.get()
         Thread.current[:newrelic_transaction_info] ||= TransactionInfo.new
       end
@@ -57,17 +66,28 @@ module NewRelic
         return nil unless request
         
         agent_flag = request.cookies['NRAGENT']
-        if agent_flag
+        if agent_flag and agent_flag.instance_of? String 
           s = agent_flag.split("=")
           if s.length == 2
             if s[0] == "tk" && s[1]
-              ERB::Util.h(s[1])
+              ERB::Util.h(sanitize_token(s[1]))
             end
           end
         else
           nil
         end
       end
+
+      # Run through a collection of unsafe characters ( in the context of the token ) 
+      # and set the token to an empty string if any of them are found in the token so that
+      # potential XSS attacks via the token are avoided
+      def self.sanitize_token(token)
+
+        if ( /[<>'"]/ =~ token )
+          token.replace("")
+        end
+        token
+      end
     end
   end
 end

data/lib/new_relic/agent/transaction_sample_builder.rb

@@ -9,7 +9,6 @@ module NewRelic
     # accessed by any other thread so no need for synchronization.
     class TransactionSampleBuilder
       attr_reader :current_segment, :sample
-      attr_accessor :segment_limit
 
       include NewRelic::CollectionHelper
 
@@ -17,8 +16,6 @@ module NewRelic
         @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
@@ -34,19 +31,20 @@ module NewRelic
       end
       
       def trace_entry(metric_name, time)
-        if @sample.count_segments < @segment_limit
+        segment_limit = Agent.config[:'transaction_tracer.limit_segments']
+        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.")
+          if @sample.count_segments == segment_limit
+            ::NewRelic::Agent.logger.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
+        return unless @sample.count_segments < Agent.config[:'transaction_tracer.limit_segments']
         if metric_name != @current_segment.metric_name
           fail "unbalanced entry/exit: #{metric_name} != #{@current_segment.metric_name}"
         end
@@ -58,13 +56,13 @@ module NewRelic
         # 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}"
+          ::NewRelic::Agent.logger.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.params[:custom_params] ||= {}
+        @sample.params[:custom_params].merge!(normalize_params(NewRelic::Agent::Instrumentation::MetricFrame.custom_parameters))
+
         @sample.force_persist = NewRelic::Agent::TransactionInfo.get.force_persist_sample?(sample)
         @sample.freeze
         @current_segment = nil
@@ -93,7 +91,7 @@ module NewRelic
       def set_transaction_info(path, uri, params)
         @sample.params[:path] = path
 
-        if NewRelic::Control.instance.capture_params
+        if Agent.config[:capture_params]
           params = normalize_params params
 
           @sample.params[:request_params].merge!(params)
@@ -104,7 +102,8 @@ module NewRelic
       end
 
       def set_transaction_cpu_time(cpu_time)
-        @sample.params[:cpu_time] = cpu_time
+        @sample.params[:custom_params] ||= {}
+        @sample.params[:custom_params][:cpu_time] = cpu_time
       end
 
       def sample