techarch-newrelic_rpm 2.10.2

data/lib/new_relic/metric_parser/web_frontend.rb

@@ -0,0 +1,14 @@
+# The metric where the mongrel queue time is stored
+
+class NewRelic::MetricParser::WebFrontend < NewRelic::MetricParser
+  def short_name
+    if segments.last == 'Average Queue Time'
+      'Mongrel Average Queue Time'
+    else
+      super
+    end
+  end
+  def legend_name
+    'Mongrel Wait'
+  end
+end

data/lib/new_relic/metric_parser/web_service.rb

@@ -0,0 +1,9 @@
+class NewRelic::MetricParser::WebService < NewRelic::MetricParser
+  def is_web_service?
+    segments[1] != 'Soap' && segments[1] != 'Xml Rpc'
+  end
+
+  def webservice_call_rate_suffix
+    'rpm'
+  end
+end

data/lib/new_relic/metric_spec.rb

@@ -0,0 +1,52 @@
+# this struct uniquely defines a metric, optionally inside
+# the call scope of another metric
+class NewRelic::MetricSpec
+  attr_accessor   :name
+  attr_accessor   :scope
+  
+  def initialize (metric_name, metric_scope = '')
+    self.name = metric_name
+    self.scope = metric_scope
+  end
+
+  def ==(o)
+    self.eql?(o)
+  end
+  
+  def eql? o
+    self.class == o.class &&
+    name.eql?(o.name) && 
+    # coerce scope to a string and compare
+    (scope || '') == (o.scope || '')
+  end
+  
+  def hash
+    h = name.hash
+    h ^= scope.hash unless scope.nil?
+    h
+  end
+  # return a new metric spec if the given regex
+  # matches the name or scope.
+  def sub(pattern, replacement, apply_to_scope = true)
+    return nil if name !~ pattern && 
+                  (!apply_to_scope || scope.nil? || scope !~ pattern)
+    new_name = name.sub(pattern, replacement)
+    new_scope = (scope && scope.sub(pattern, replacement)) 
+    self.class.new new_name, new_scope
+  end
+  
+  def to_s
+    "#{name}:#{scope}"
+  end
+  
+  def to_json(*a)
+    {'name' => name, 
+    'scope' => scope}.to_json(*a)
+  end
+  
+  def <=>(o)
+    namecmp = self.name <=> o.name
+    return namecmp if namecmp != 0
+    return (self.scope || '') <=> (o.scope || '')
+  end
+end

data/lib/new_relic/metrics.rb

@@ -0,0 +1,7 @@
+module NewRelic::Metrics
+  CONTROLLER = "Controller"
+  DISPATCHER = "HttpDispatcher"
+  ACTIVE_RECORD = "ActiveRecord"
+  USER_TIME = "CPU/User Time"
+  MEMORY = "Memory/Physical"
+end

data/lib/new_relic/noticed_error.rb

@@ -0,0 +1,23 @@
+# This class encapsulates an error that was noticed by RPM in a managed app.
+class NewRelic::NoticedError
+  attr_accessor :path, :timestamp, :params, :exception_class, :message
+  
+  def initialize(path, data, exception, timestamp = Time.now)
+    self.path = path
+    self.params = data
+    
+    self.exception_class = exception ? exception.class.name : '<no exception>'
+    
+    if exception.respond_to?('original_exception')
+      self.message = exception.original_exception.message.to_s
+    else
+      self.message = (exception || '<no message>').to_s
+    end
+    
+    # clamp long messages to 4k so that we don't send a lot of
+    # overhead across the wire
+    self.message = self.message[0..4095] if self.message.length > 4096
+
+    self.timestamp = timestamp
+  end
+end

data/lib/new_relic/rack/metric_app.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+module NewRelic::Rack
+  class MetricApp
+    def initialize(options)
+      if options[:install]
+        FileUtils.copy File.join(File.dirname(__FILE__), "newrelic.yml"), "."
+        NewRelic::Control.instance.log.info "==============================="
+        NewRelic::Control.instance.log.info "A newrelic.yml template was copied to #{File.expand_path('.')}."
+        NewRelic::Control.instance.log.info "Please add a license key to the file and restart #{$0}"
+        exit 0
+      end
+      options[:app_name] ||= 'EPM Monitor'
+      options[:disable_samplers] = true
+      NewRelic::Agent.manual_start options
+      unless NewRelic::Control.instance.license_key
+        NewRelic::Control.instance.log.error "Please add a valid license key to newrelic.yml."
+        exit 1
+      end
+    end
+    def call(env)
+      request = ::Rack::Request.new env
+      segments = request.url.gsub(/^.*?\/metrics\//, '').split("?")[0].split("/")
+      metric = "Custom/" + segments.join("/")
+      raise "Expected value parameter!" unless request['value']
+      data = request['value'].to_f
+      stats = NewRelic::Agent.get_stats(metric, false)
+      stats.record_data_point data
+      response = ::Rack::Response.new "#{metric}=#{data}" 
+      response.finish
+    end
+  end
+  class Status
+    def call(env)
+      request = ::Rack::Request.new env
+      data_url = "http://#{env['HTTP_HOST']}/metrics/path?value=nnn"
+      body = StringIO.new
+      body.puts "<html><body>"
+      body.puts "<h1>New Relic Actively Monitoring #{NewRelic::Control.instance.app_names.join(' and ')}</h1>"
+      body.puts "<p>To submit a metric value, use <a href='#{data_url}'>#{data_url}</a></p>"
+      body.puts "<h2>Request Details</h2>"
+      body.puts "<dl>"
+      body.puts "<dt>ip<dd>#{request.ip}"
+      body.puts "<dt>host<dd>#{request.host}"
+      body.puts "<dt>path<dd>#{request.url}"
+      body.puts "<dt>query<dd>#{request.query_string}"
+      body.puts "<dt>params<dd>#{request.params.inspect}"
+      body.puts "</dl>"
+      body.puts "<h2>Complete ENV</h2>"
+      body.puts "<ul>"
+      body.puts env.to_a.map{|k,v| "<li>#{k} = #{v}</li>" }.join("\n")
+      body.puts "</ul></body></html>"
+      response = ::Rack::Response.new body.string
+      response.finish
+    end
+  end
+end

data/lib/new_relic/rack/newrelic.ru

@@ -0,0 +1,25 @@
+# This is so that we don't detect a dispatcher like mongrel and think we are
+# monitoring it.
+ENV['NEWRELIC_DISPATCHER'] = 'none'
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..','..'))
+
+require 'new_relic/rack_app'
+
+# Valid options which may be present in this binding:
+# :license_key   optional license key override
+# :app_name      optional name of app
+# :logging       optional, false to omit request logging to stdout
+
+options ||= {}
+
+use Rack::CommonLogger unless options[:logging] == false
+use Rack::ShowExceptions
+map "http://localhost/metrics" do
+  run NewRelic::Rack::MetricApp.new(options)
+end
+map "/" do
+  run NewRelic::Rack::Status.new
+end
+
+

data/lib/new_relic/rack/newrelic.yml

@@ -0,0 +1,25 @@
+#
+# This file configures the Rack NewRelic Metric Application.  Place a copy of this file
+# in the directory where you start the mongrel_rpm process.
+#
+common: &default_settings
+  log_level: info
+  
+  # This is the key generated by script/create_admin
+  license_key: 'your_license_key_here'
+  
+  # Replace this with the name of the application feeding
+  # metrics into the Metric application;
+  app_name: Application Monitor
+    
+# If RAILS_ENV or RUBY_ENV is defined to be one of the following
+# these values will be overrides
+
+production:
+  <<: *default_settings
+  app_name: Production Monitor
+  
+staging:
+  <<: *default_settings
+  app_name: Staging Monitor
+

data/lib/new_relic/rack_app.rb

@@ -0,0 +1,5 @@
+require 'rack/response'
+require 'newrelic_rpm'
+
+# Rack middlewares and applications used by New Relic
+require 'new_relic/rack/metric_app'

data/lib/new_relic/recipes.rb

@@ -0,0 +1,82 @@
+# 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 RPM.
+# 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 = lambda do
+  
+  namespace :newrelic do
+    
+    # on all deployments, notify RPM 
+    desc "Record a deployment in New Relic RPM (rpm.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__), 'commands', 'deployments.rb')
+      begin
+        # Try getting the changelog from the server.  Then fall back to local changelog
+        # if it doesn't work.  Problem is that I don't know what directory the .git is
+        # in when using git.  I could possibly use the remote cache but i don't know
+        # if that's always there.
+=begin        
+        run "cd #{current_release}; #{log_command}" do | io, stream_id, output |
+          changelog = output
+        end
+=end
+        # allow overrides to be defined for revision, description, changelog and appname
+        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)
+        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
+        new_revision = rev || source.query_revision(source.head()) do |cmd| 
+          logger.debug "executing locally: '#{cmd}'"
+          `#{cmd}` 
+        end
+        deploy_options = { :environment => rails_env,
+          :revision => new_revision,
+          :changelog => changelog, 
+          :description => description,
+          :appname => appname }
+        logger.debug "Uploading deployment to New Relic"
+        deployment = NewRelic::Commands::Deployments.new deploy_options
+        deployment.run
+        logger.info "Uploaded deployment information to New Relic"
+      rescue ScriptError => e
+        logger.info "error creating New Relic deployment (#{e})\n#{e.backtrace.join("\n")}"
+      rescue NewRelic::Commands::CommandFailure => e
+        logger.info "unable to notify New Relic of the deployment (#{e})... skipping"
+      rescue Capistrano::CommandError
+        logger.info "unable to notify New Relic of the deployment... skipping"
+      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 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/stats.rb

@@ -0,0 +1,361 @@
+
+module NewRelic
+  module Stats
+    
+    def absent?
+      # guess on absent values
+      call_count == 0
+    end  
+
+    def time_str(value_ms)
+      case
+        when value_ms >= 10000 
+       "%.1f s" % (value_ms / 1000.0)
+        when value_ms >= 5000 
+       "%.2f s" % (value_ms / 1000.0)
+      else
+       "%.0f ms" % value_ms
+      end
+    end
+    
+    def average_call_time
+      return 0 if call_count == 0
+      total_call_time / call_count
+    end
+    def average_exclusive_time
+      return 0 if call_count == 0
+      total_exclusive_time / call_count
+    end
+    
+    def merge! (other_stats)
+      Array(other_stats).each do |s|
+        self.total_call_time += s.total_call_time
+        self.total_exclusive_time += s.total_exclusive_time
+        self.min_call_time = s.min_call_time if (s.min_call_time < min_call_time && s.call_count > 0) || call_count == 0
+        self.max_call_time = s.max_call_time if s.max_call_time > max_call_time
+        self.call_count += s.call_count
+        self.sum_of_squares += s.sum_of_squares if s.sum_of_squares
+        self.begin_time = s.begin_time if s.begin_time.to_f < begin_time.to_f || begin_time.to_f == 0.0
+        self.end_time = s.end_time if s.end_time.to_f > end_time.to_f
+      end
+      
+      self
+    end
+    
+    def merge (other_stats)
+      stats = self.clone
+      stats.merge! other_stats
+    end
+    
+    # split into an array of timesclices whose
+    # time boundaries start on (begin_time + (n * duration)) and whose
+    # end time ends on (begin_time * (n + 1) * duration), except for the
+    # first and last elements, whose begin time and end time are the begin
+    # and end times of this stats instance, respectively.  Yield to caller
+    # for the code that creates the actual stats instance
+    def split(rollup_begin_time, rollup_period)
+      rollup_begin_time = rollup_begin_time.to_f
+      rollup_begin_time += ((self.begin_time - rollup_begin_time) / rollup_period).floor * rollup_period
+
+      current_begin_time = self.begin_time
+      current_end_time = rollup_begin_time + rollup_period
+
+      return [self] if current_end_time >= self.end_time
+      
+      timeslices = []
+      while current_end_time < self.end_time do
+        ts = yield(current_begin_time, current_end_time)
+        if ts
+          ts.fraction_of(self)
+          timeslices << ts
+        end
+        current_begin_time = current_end_time
+        current_end_time = current_begin_time + rollup_period
+      end
+      
+      if self.end_time > current_begin_time
+        percentage = rollup_period / self.duration + (self.begin_time - rollup_begin_time) / rollup_period
+        ts = yield(current_begin_time, self.end_time)
+        if ts
+          ts.fraction_of(self)
+          timeslices << ts
+        end
+      end
+      
+      timeslices
+    end
+    
+    def is_reset?
+      call_count == 0 && total_call_time == 0.0 && total_exclusive_time == 0.0
+    end
+    
+    def reset
+      self.call_count = 0
+      self.total_call_time = 0.0
+      self.total_exclusive_time = 0.0
+      self.min_call_time = 0.0
+      self.max_call_time = 0.0
+      self.sum_of_squares = 0.0
+      self.begin_time = Time.at(0)
+      self.end_time = Time.at(0)
+    end
+    
+    def as_percentage_of(other_stats)
+      return 0 if other_stats.total_call_time == 0
+      return to_percentage(total_call_time / other_stats.total_call_time)
+    end
+    
+    # the stat total_call_time is a percent
+    def as_percentage
+      return 0 if call_count == 0
+      to_percentage(total_call_time / call_count)
+    end
+    
+    def duration
+      end_time - begin_time
+    end
+
+    def calls_per_minute
+      return 0 if duration.zero?
+      ((call_count / duration.to_f * 6000).round).to_f / 100
+    end
+    
+    def calls_per_second
+      round_to_2 calls_per_minute / 60
+    end
+    def total_call_time_per_minute
+      60.0 * time_percentage
+    end
+    def standard_deviation
+      return 0 if call_count < 2 || self.sum_of_squares.nil?
+      
+      # Convert sum of squares into standard deviation based on
+      # formula for the standard deviation for the entire population
+      x = self.sum_of_squares - (self.call_count * (self.average_value**2))
+      return 0 if x <= 0
+      
+      Math.sqrt(x / self.call_count)
+    end
+    
+    # returns the time spent in this component as a percentage of the total
+    # time window.
+    def time_percentage
+      return 0 if duration == 0
+      total_call_time / duration
+    end
+
+    def exclusive_time_percentage
+      return 0 if duration == 0
+      total_exclusive_time / duration
+    end
+
+    alias average_value average_call_time
+    alias average_response_time average_call_time
+    alias requests_per_minute calls_per_minute
+    
+    def to_s
+      s = "Begin=#{begin_time}, "
+      s << "Duration=#{duration} s, "
+      s << "Count=#{call_count}, "
+      s << "Total=#{to_ms(total_call_time)}, "
+      s << "Total Exclusive=#{to_ms(total_exclusive_time)}, "
+      s << "Avg=#{to_ms(average_call_time)}, "
+      s << "Min=#{to_ms(min_call_time)}, "
+      s << "Max=#{to_ms(max_call_time)}, "
+      s << "StdDev=#{to_ms(standard_deviation)}"
+    end
+    
+    # Summary string to facilitate testing
+    def summary
+      format = "%m/%d %I:%M%p"
+      "[#{Time.at(begin_time).strftime(format)}, #{duration}s. #{call_count} calls; #{to_ms(average_call_time)}ms]"
+    end
+    
+    # round all of the values to n decimal points
+    def round!
+      self.total_call_time = round_to_3(total_call_time)
+      self.total_exclusive_time = round_to_3(total_exclusive_time)
+      self.min_call_time = round_to_3(min_call_time)
+      self.max_call_time = round_to_3(max_call_time)
+      self.sum_of_squares = round_to_3(sum_of_squares)
+      self.begin_time = begin_time
+      self.end_time = end_time
+    end
+
+    # calculate this set of stats to be a percentage fraction 
+    # of the provided stats, which has an overlapping time window.
+    # used as a key part of the split algorithm
+    def fraction_of(s)
+      min_end = (end_time < s.end_time ? end_time : s.end_time)
+      max_begin = (begin_time > s.begin_time ? begin_time : s.begin_time)
+      percentage = (min_end - max_begin) / s.duration
+
+      self.total_exclusive_time = s.total_exclusive_time * percentage
+      self.total_call_time = s.total_call_time * percentage
+      self.min_call_time = s.min_call_time
+      self.max_call_time = s.max_call_time
+      self.call_count = s.call_count * percentage
+      self.sum_of_squares = (s.sum_of_squares || 0) * percentage
+    end
+    
+    # multiply the total time and rate by the given percentage 
+    def multiply_by(percentage)
+      self.total_call_time = total_call_time * percentage
+      self.call_count = call_count * percentage
+      self.sum_of_squares = sum_of_squares * percentage
+      
+      self
+    end
+    
+
+    # returns s,t,f
+    def get_apdex
+      [@call_count, @total_call_time.to_i, @total_exclusive_time.to_i]
+    end
+
+		def apdex_score
+			s, t, f = get_apdex
+			(s.to_f + (t.to_f / 2)) / (s+t+f).to_f
+		end
+    private
+    def to_ms(number)
+      (number*1000).round
+    end
+    # utility method that converts floating point percentage values
+    # to integers as a percentage, to improve readability in ui
+    def to_percentage(value)
+      round_to_2(value * 100)
+    end
+    
+    def round_to_2(val)
+      (val * 100).round / 100.0
+    end
+    def round_to_3(val)
+      (val * 1000).round / 1000.0
+    end
+  end
+  
+  
+  class StatsBase
+    include Stats
+
+    attr_accessor :call_count
+    attr_accessor :min_call_time
+    attr_accessor :max_call_time
+    attr_accessor :total_call_time
+    attr_accessor :total_exclusive_time
+    attr_accessor :sum_of_squares
+    
+    def initialize 
+      reset
+    end
+    
+    def freeze
+      @end_time = Time.now
+      super
+    end
+    
+    def to_json(*a)
+      {'call_count' => call_count, 
+      'min_call_time' => min_call_time, 
+      'max_call_time' => max_call_time, 
+      'total_call_time' => total_call_time,
+      'total_exclusive_time' => total_exclusive_time,
+      'sum_of_squares' => sum_of_squares}.to_json(*a)
+    end
+
+    
+    # In this class, we explicitly don't track begin and end time here, to save space during
+    # cross process serialization via xml.  Still the accessor methods must be provided for merge to work.
+    def begin_time=(t)
+    end
+    
+    def end_time=(t)
+    end
+    
+    def begin_time
+      0.0
+    end
+    
+    def end_time
+      0.0
+    end
+  end
+  
+  
+  class BasicStats < StatsBase
+  end
+  
+  class ApdexStats < StatsBase
+    
+    def record_apdex_s
+      @call_count += 1
+    end
+    
+    def record_apdex_t
+      @total_call_time += 1
+    end
+    
+    def record_apdex_f
+      @total_exclusive_time += 1
+    end
+  end
+  
+  # Statistics used to track the performance of traced methods
+  class MethodTraceStats < StatsBase
+    
+    alias data_point_count call_count
+    
+    # record a single data point into the statistical gatherer.  The gatherer
+    # will aggregate all data points collected over a specified period and upload
+    # its data to the NewRelic server
+    def record_data_point(value, exclusive_time = value)
+      @call_count += 1
+      @total_call_time += value
+      @min_call_time = value if value < @min_call_time || @call_count == 1
+      @max_call_time = value if value > @max_call_time
+      @total_exclusive_time += exclusive_time
+
+      @sum_of_squares += (value * value)
+      self
+    end
+    
+    alias trace_call record_data_point
+    
+    def record_multiple_data_points(total_value, count=1)
+      return record_data_point(total_value) if count == 1
+      @call_count += count
+      @total_call_time += total_value
+      avg_val = total_value / count
+      @min_call_time = avg_val if avg_val < @min_call_time || @call_count == count
+      @max_call_time = avg_val if avg_val > @max_call_time
+      @total_exclusive_time += total_value
+      @sum_of_squares += (avg_val * avg_val) * count
+      self
+    end
+    
+    def increment_count(value = 1)
+      @call_count += value
+    end
+
+  end
+  
+  class ScopedMethodTraceStats < MethodTraceStats
+    def initialize(unscoped_stats)
+      super()
+      @unscoped_stats = unscoped_stats
+    end
+    def trace_call(call_time, exclusive_time = call_time)
+      @unscoped_stats.trace_call call_time, exclusive_time
+      super call_time, exclusive_time
+    end
+    def record_multiple_data_points(total_value, count=1)
+      @unscoped_stats.record_multiple_data_points(total_value, count)
+      super total_value, count
+    end
+    def unscoped_stats
+      @unscoped_stats
+    end
+  end
+end
+