sundawg_newrelic_rpm 3.5.8.1

data/lib/new_relic/recipes.rb

@@ -0,0 +1,99 @@
+# When installed as a plugin this is loaded automatically.
+#
+# When installed as a gem, you need to add
+#  require 'new_relic/recipes'
+# to your deploy.rb
+#
+# Defined deploy:notify_rpm which will send information about the deploy to New Relic.
+# The task will run on app servers except where no_release is true.
+# If it fails, it will not affect the task execution or do a rollback.
+#
+make_notify_task = Proc.new do
+
+  namespace :newrelic do
+
+    # on all deployments, notify New Relic
+    desc "Record a deployment in New Relic (newrelic.com)"
+    task :notice_deployment, :roles => :app, :except => {:no_release => true } do
+      rails_env = fetch(:newrelic_rails_env, fetch(:rails_env, "production"))
+
+      require File.join(File.dirname(__FILE__), 'command.rb')
+
+      begin
+        # allow overrides to be defined for revision, description, changelog, appname, and user
+        rev         = fetch(:newrelic_revision)  if exists?(:newrelic_revision)
+        description = fetch(:newrelic_desc)      if exists?(:newrelic_desc)
+        changelog   = fetch(:newrelic_changelog) if exists?(:newrelic_changelog)
+        appname     = fetch(:newrelic_appname)   if exists?(:newrelic_appname)
+        user        = fetch(:newrelic_user)      if exists?(:newrelic_user)
+
+        if !changelog
+          logger.debug "Getting log of changes for New Relic Deployment details"
+          from_revision = source.next_revision(current_revision)
+
+          if scm == :git
+            log_command = "git log --no-color --pretty=format:'  * %an: %s' " +
+              "--abbrev-commit --no-merges #{previous_revision}..#{real_revision}"
+          else
+            log_command = "#{source.log(from_revision)}"
+          end
+
+          changelog = `#{log_command}`
+        end
+
+        if rev.nil?
+          rev = source.query_revision(source.head()) do |cmd|
+            logger.debug "executing locally: '#{cmd}'"
+            `#{cmd}`
+          end
+
+          rev = rev[0..6] if scm == :git
+        end
+
+        new_revision = rev
+        deploy_options = {
+          :environment => rails_env,
+          :revision    => new_revision,
+          :changelog   => changelog,
+          :description => description,
+          :appname     => appname,
+          :user        => user
+        }
+
+        logger.debug "Uploading deployment to New Relic"
+        deployment = NewRelic::Command::Deployments.new deploy_options
+        deployment.run
+        logger.info "Uploaded deployment information to New Relic"
+
+      rescue NewRelic::Command::CommandFailure => e
+        logger.info e.message
+
+      rescue Capistrano::CommandError
+        logger.info "Unable to notify New Relic of the deployment... skipping"
+
+      rescue => e
+        logger.info "Error creating New Relic deployment (#{e})\n#{e.backtrace.join("\n")}"
+      end
+
+      # WIP: For rollbacks, let's update the deployment we created with an indication of the failure:
+      # on_rollback do
+      #   run(...)
+      # end
+    end
+  end
+end
+
+require 'capistrano/version'
+
+if defined?(Capistrano::Version::MAJOR) && Capistrano::Version::MAJOR < 2
+  STDERR.puts "Unable to load #{__FILE__}\nNew Relic Capistrano hooks require at least version 2.0.0"
+else
+  instance = Capistrano::Configuration.instance
+
+  if instance
+    instance.load &make_notify_task
+  else
+    make_notify_task.call
+  end
+end
+

data/lib/new_relic/timer_lib.rb

@@ -0,0 +1,27 @@
+# Copyright:  (C) 2008 David Vollbracht & Philippe Hanrigou
+
+# This code was borrowed from the system_timer gem under the terms
+# of the Ruby license.  It has been slightly modified.
+
+# Defines the constant TimerLib to the appropriate timeout library
+module NewRelic #:nodoc:
+
+  begin
+    # Try to use the SystemTimer gem instead of Ruby's timeout library
+    # when running on Ruby 1.8.x. See:
+    #   http://ph7spot.com/articles/system_timer
+    # We don't want to bother trying to load SystemTimer on jruby,
+    # ruby 1.9+ and rbx.
+    if !defined?(RUBY_ENGINE) || (RUBY_ENGINE == 'ruby' && RUBY_VERSION < '1.9.0')
+      require 'system_timer'
+      TimerLib = SystemTimer
+    else
+      require 'timeout'
+      TimerLib = Timeout
+    end
+  rescue LoadError => e
+    require 'timeout'
+    TimerLib = Timeout
+  end
+
+end

data/lib/new_relic/transaction_analysis.rb

@@ -0,0 +1,77 @@
+require 'new_relic/transaction_analysis/segment_summary'
+# Add these methods to TransactionSample that enable performance analysis in the user interface.
+module NewRelic
+  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/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,272 @@
+require 'base64'
+
+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,
+                  :threshold)
+    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
+
+    def to_json
+      JSON.dump(self.to_array)
+    end
+
+    include NewRelic::Coerce
+
+    def to_array
+      [ float(@start_time),
+        @params[:request_params],
+        @params[:custom_params],
+        @root_segment.to_array ]
+    end
+
+    def to_collector_array(encoder)
+      trace_tree = encoder.encode(self.to_array)
+      [ Helper.time_to_millis(@start_time),
+        Helper.time_to_millis(duration),
+        string(@params[:path]),
+        string(@params[:uri]),
+        trace_tree,
+        string(@guid),
+        nil,
+        !!@force_persist ]
+    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
+
+      build_segment_for_transfer(sample, @root_segment, sample.root_segment, options)
+
+      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