newrelic_rpm 3.6.6.147 → 3.6.7.152

data/.gitignore

@@ -22,4 +22,3 @@ lib/new_relic/build.rb
 .pryrc
 .tm_properties
 .bundle
-/bin/

data/CHANGELOG

@@ -1,5 +1,43 @@
 # New Relic Ruby Agent Release Notes #
 
+## v3.6.7 ##
+
+  * Resque-pool support
+
+  Resque processes started via the resque-pool gem weren't recognized by the
+  Ruby agent. The agent now starts correctly in those worker processes.
+
+  * Environment-based configuration
+
+  All settings in newrelic.yml can now be configured via environment variables.
+  See https://newrelic.com/docs/ruby/ruby-agent-configuration for full details.
+
+  * Fix compatibility issues with excon and curb instrumentation
+
+  This release of the agent fixes a warning seen under certain circumstances
+  with the excon gem (most notably, when excon was used by fog), as well as
+  a bug with the curb instrumentation that conflicted with the  feedzirra gem.
+
+  * Allow license key to be set by Capistrano variables
+
+  A license key can be passed via a Capistrano variable where previously it
+  could only be in newrelic.yml. Thanks Chris Marshall for the contribution!
+
+  * Make HTTP client instrumentation aware of "Host" request header
+
+  If a "Host" header is set explicitly on an HTTP request, that hostname will
+  be used for external metrics. Thanks Mislav Marohnić for the contribution!
+
+  * Fix ActiveSupport::Concern warnings with MethodTracer
+
+  Including NewRelic::Agent::MethodTracer in a class using Concerns could cause
+  deprecation warnings. Thanks Mike Połtyn for the contribution!
+
+  * Fix Authlogic constant name
+
+  Code checking for the Authlogic module was using in the wrong case. Thanks
+  Dharam Gollapudi for the contribution!
+
 ## v3.6.6 ##
 
   * HTTPClient and Curb support
@@ -152,7 +190,7 @@
 
 ## v3.6.0 ##
 
-  * Sidekiq supprt
+  * Sidekiq support
 
   The Ruby agent now supports the Sidekiq background job framework. Traces from
   Sidekiq jobs will automatically show up in the Background tasks on New Relic
@@ -357,7 +395,7 @@
   * The host and the port that the agent reports to can now be set from environment vars
 
     The host can be set with NEW_RELIC_HOST and the port with NEW_RELIC_PORT.  These setting
-    will overrride any other settings in your newrelic.yml.
+    will override any other settings in your newrelic.yml.
 
   * Fix RUM reporting to multiple applications
 
@@ -369,16 +407,16 @@
   * Update the collector protocol to use JSON and Ruby primitives
 
     The communication between the agent and the NewRelic will not longer be
-    marshalled Ruby objects, but rather JSON in the case of Ruby 1.9 and marshalled
+    marshaled Ruby objects, but rather JSON in the case of Ruby 1.9 and marshaled
     Ruby primitives in the case of 1.8.  This results in greater harvest efficiency
     as well as feature parity with other New Relic agents.
 
   * Fix incorrect application of conditions in sinatra instrumentation
 
-    The agent's sinatra instrumentation was causing sinatra's condidtions to
+    The agent's sinatra instrumentation was causing sinatra's conditions to
     be incorrectly applied in some obscure cases.  The bug was triggered
     when a condition was present on a lower priority route that would match
-    the current request, except for the precense of a higher priority route.
+    the current request, except for the presence of a higher priority route.
 
 ## v3.5.2 ##
 
@@ -442,7 +480,7 @@
    dispatcher an INFO level log message it created that includes a link to New Relic
    online doc that has additional steps that may be required to get performance data reporting.
 
- * (Fix) In version 3.4.2 of the Ruby Agent the server side value for Apdex T was disgregarded
+ * (Fix) In version 3.4.2 of the Ruby Agent the server side value for Apdex T was disregarded
 
    With version 3.4.2 of the agent, the value set in the newrelic.yml file took precedence over the
    value set in the New Relic UI.  As of version 3.5.0 only the value for Apdex T set in the
@@ -487,7 +525,7 @@
 
  * The RUM NRAGENT tk value gets more robustly sanitized to prevent potential XSS vulnerabilities
 
-   The code that scrubes the token used in Real User Monitoring has been enhanced to be
+   The code that scrubs the token used in Real User Monitoring has been enhanced to be
    more robust.
 
  * Support for Apdex T in server side configuration
@@ -497,7 +535,7 @@
 
  * Refactoring of agent config code
 
-   The code that reads the configuration information and confirgures the agent
+   The code that reads the configuration information and configures the agent
    got substantially reorganized, consolidated, simplified, and made more robust.
 
 ## v3.4.1 ##
@@ -530,7 +568,7 @@
 
  * corrupt marshal data from pipe children crashing agent
 
-   If the agent receieved corrupted data from the Reqsue worker child agent
+   If the agent received corrupted data from the Reqsue worker child agent
    it could crash the agent itself. fixed.
 
  * should reset RubyBench GC counter between polls
@@ -583,7 +621,7 @@ v3.3.1
   * improved Ruby 1.8.6 support
   * fix for issues with RAILS_ROOT deprecation warnings
   * fixed incorrect 1.9 GC time reporting
-  * obfusction for Slow SQL queries respects transaction trace config
+  * obfuscation for Slow SQL queries respects transaction trace config
   * fix for RUM instrumentation repoting bad timing info in some cases
   * refactored ActiveRecord instrumentation, no longer requires Rails
 
@@ -681,7 +719,7 @@ v2.13.3
   * Delete obsolete links to metric docs in developer mode
   * Detect gems when using Bundler
   * Fix newrelic_ignore in Rails 3
-  * Break metric parser into a seperate vendored gem
+  * Break metric parser into a separate vendored gem
   * When using Unicorn, preload_app: true is recommended to get proper
     after_fork behavior.
 
@@ -712,7 +750,7 @@ v2.13.0
   * added record_transaction method to the api to allow recording
     details from web and background transactions occurring outside RPM
   * fixed a bug related to enabling a gold trial / upgrade not sending
-    trasaction traces correctly
+    transaction traces correctly
 
 v2.12.3
   * fix regression in startup sequence
@@ -773,7 +811,7 @@ v2.10.8
   * preliminary support for rails3
 
 v2.10.6
-  * fix missing URL and referer on some traced errors and transactions
+  * fix missing URL and referrer on some traced errors and transactions
   * gather traced errors *after* executing the rescue chain in ActionController
   * always load controller instrumentation
   * pick up token validation from newrelic.yml
@@ -833,7 +871,7 @@ v2.10.1.
     tasks and eventually things like rack, metal and Sinatra
   * adjusted apdex scores to reflect time spent in the mongrel queue
   * fixed incompatibility with JRuby on startup
-  * implmented CPU measure for JRuby which reflects the cpu burn for
+  * implemented CPU measure for JRuby which reflects the cpu burn for
     all controller actions (does not include background tasks)
   * fixed scope issue with GC instrumentation, subtracting time from caller
   * added # of GC calls to GC instrumentation
@@ -846,7 +884,7 @@ v2.10.0.
   * support unicorn
   * instrumentation of GC for REE and MRE with GC patch
   * support agent restarting when changes are made to the account
-  * removed #newrelic_notice_error from Object class, replaced by NewRelic::Agent#notic_error
+  * removed #newrelic_notice_error from Object class, replaced by NewRelic::Agent#notice_error
   * collect histogram statistics
   * add custom parameters to newrelic_notice_error call to display
     extra info for errors
@@ -957,7 +995,7 @@ v2.9.0.
   Agent improvements to support future RPM enhancements
   * add instrumentation to capture metrics on response codes; not yet
     working in rails 2.3.*
-  * added http referer to traced errors
+  * added http referrer to traced errors
   * capture gem requirements from rails
   * capture cpu utilization adjusted for processor count
   * transaction sampling
@@ -1099,7 +1137,7 @@ v2.3.6.
   * bugfixes
 
 v2.3.5.
-  * bugfixes: pie chart data, rails 1.1 compability
+  * bugfixes: pie chart data, rails 1.1 compatibility
 
 v2.3.4.
   * bugfix

data/Guardfile

@@ -0,0 +1,7 @@
+guard :test, :test_paths => ['test/new_relic'], :all_after_pass => false do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/rum/.*})       { "test/new_relic/rack/browser_monitoring_test.rb" }
+  watch('test/test_helper.rb')  { "test" }
+  watch('test/agent_helper.rb') { "test" }
+end

data/Rakefile

@@ -49,6 +49,12 @@ namespace :test do
     Performance::Runner.new(options).run_and_report
   end
 
+  desc "Run agent within existing mini environments"
+  task :env, [:env1, :env2, :env3, :env4, :env5, :env6] => [] do |t, args|
+    require File.expand_path(File.join(File.dirname(__FILE__), 'test', 'environments', 'lib', 'environments', 'runner'))
+    Environments::Runner.new(args.map{|_,v| v}).run_and_report
+  end
+
   Rake::TestTask.new(:intentional_fail) do |t|
     t.libs << "#{agent_home}/test"
     t.libs << "#{agent_home}/lib"

data/bin/mongrel_rpm

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'rack'
+require 'rack/handler/mongrel'
+require 'optparse'
+
+port = 3000
+options = { }
+appname = nil
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [options] [app_name]"
+  opts.on("-p", "--port=port", Integer, "default: #{port}") { | port | }
+  opts.on("--[no-]logging", "turn off request logging" ) { | l | options[:logging] = l }
+  opts.on("--license=license_key", "override license key" ) { | l | options[:license_key] = l }
+  opts.on("--install", "install a newrelic.yml template" ) { | l | options[:install] = true }
+  opts.separator ""
+  opts.separator "app_name is the name of the application where the metrics will be stored"
+  opts.separator ""
+  # The rackup file references this var
+  appname = opts.parse!(ARGV.clone).first
+end
+
+options[:app_name] = appname if appname
+
+ru_file = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "new_relic", "rack", "mongrel_rpm.ru"))
+rackup_code = File.read ru_file
+builder = Rack::Builder.new { eval rackup_code, binding, ru_file }
+
+options = { :Host => '127.0.0.1', :Port => port }
+Rack::Handler::Mongrel.run(builder.to_app, options) do | server |
+  NewRelic::Agent.logger.info "Started Mongrel listening for '#{NewRelic::Control.instance.app_names.join(" and ")}' data at #{server.host}:#{server.port}" 
+end
+

data/bin/newrelic

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# executes one of the commands in the new_relic/commands directory
+# pass the name of the command as an argument
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..','lib'))
+require 'new_relic/cli/command'
+begin
+  NewRelic::Cli::Command.run
+rescue NewRelic::Cli::Command::CommandFailure => failure
+  STDERR.puts failure.message
+  STDERR.puts failure.options if failure.options
+  exit 1
+end

data/bin/newrelic_cmd

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# This command has been renamed "newrelic"
+# executes one of the commands in the new_relic/commands directory
+# pass the name of the command as an argument
+load File.dirname(__FILE__) + '/newrelic'

data/bin/nrdebug

@@ -0,0 +1,273 @@
+#!/usr/bin/env ruby
+
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+require 'tempfile'
+require 'rbconfig'
+
+def fail(msg, opts={})
+  $stderr.puts(msg)
+  usage() if opts[:usage]
+  exit(-1)
+end
+
+def usage
+  $stderr.puts("Usage: #{$0} <target_pid>")
+end
+
+class Logger
+  def self.log(msg)
+    @messages ||= []
+    @messages << [Time.now, msg]
+  end
+
+  def self.messages
+    @messages
+  end
+end
+
+class ShellWrapper
+  def self.execute(cmd)
+    Logger.log("Executing '#{cmd}'")
+    `#{cmd} 2>&1`
+  end
+end
+
+class ProcessDataProvider
+  attr_reader :pid
+
+  def initialize(pid)
+    @pid = pid
+  end
+
+  def attachable?
+    begin
+      my_uid = Process.uid
+      (my_uid == 0 || uid == my_uid)
+    rescue
+      return false
+    end
+  end
+
+  def alive?
+    Process.kill(0, @pid.to_i)
+    return true
+  rescue Errno::ESRCH
+    return false
+  end
+
+  def uid
+    ShellWrapper.execute("ps -o uid #{pid}").split("\n").last.strip.to_i
+  end
+
+  def user
+    ShellWrapper.execute("ps -o user #{pid}").split("\n").last.strip
+  end
+
+  def ppid
+    ShellWrapper.execute("ps -o ppid #{pid}").split("\n").last
+  end
+
+  def rss
+    ShellWrapper.execute("ps -o rss #{pid}").split("\n").last.to_i
+  end
+
+  def cpu
+    ShellWrapper.execute("ps -o cpu #{pid}").split("\n").last
+  end
+
+  def open_files
+    ShellWrapper.execute("lsof -p #{pid}")
+  end
+
+  def self.for_process(pid)
+    case RbConfig::CONFIG['target_os']
+    when /linux/  then LinuxProcessDataProvider.new(pid)
+    when /darwin/ then DarwinProcessDataProvider.new(pid)
+    end
+  end
+end
+
+class LinuxProcessDataProvider < ProcessDataProvider
+  def proc_path(item)
+    File.join("/proc/#{pid}", item)
+  end
+
+  def procline
+    File.read(proc_path('cmdline')).gsub("\000", " ")
+  end
+
+  def environment
+    File.read(proc_path('environ')).gsub("\000", "\n")
+  end
+end
+
+class DarwinProcessDataProvider < ProcessDataProvider
+  def procline
+    ShellWrapper.execute("ps -o command #{pid}").split("\n").last
+  end
+
+  def environment
+    cmd = "ps -o command -E #{pid}"
+    ShellWrapper.execute(cmd).split("\n").last.gsub(procline, '').strip
+  end
+end
+
+class RubyProcess
+  attr_accessor :pid
+
+  def initialize(pid)
+    @pid = pid
+    @provider = ProcessDataProvider.for_process(pid)
+  end
+
+  [:uid, :ppid, :rss, :cpu, :open_files, :procline, :environment, :alive?, :attachable?].each do |m|
+    define_method(m) do
+      @provider.send(m)
+    end
+  end
+
+  def gather_backtraces
+    backtrace_file = Tempfile.new('nrdebug_ruby_bt')
+    File.chmod(0666, backtrace_file.path)
+
+    gdb_script_body = <<-END
+      attach #{pid}
+      t a a bt
+      call (void)close(1)
+      call (void)close(2)
+      call (int)open("#{backtrace_file.path}", 2, 0)
+      call (int)open("#{backtrace_file.path}", 2, 0)
+      call (void)rb_backtrace()
+      call (void)fflush(0)
+      quit
+    END
+    Logger.log("Using gdb script:\n#{gdb_script_body}")
+
+    script_file = Tempfile.new('nrdebug_gdb_script')
+    script_file.write(gdb_script_body)
+    script_file.close
+
+    gdb_stderr = Tempfile.new('nrdebug_gdb_stderr')
+
+    gdb_cmd = "gdb -batch -x #{script_file.path} 2>#{gdb_stderr.path}"
+    gdb_output = ShellWrapper.execute(gdb_cmd)
+    ruby_backtrace = File.read(backtrace_file.path)
+
+    script_file.close!
+    backtrace_file.close!
+    gdb_stderr.close!
+
+    [gdb_output, ruby_backtrace]
+  end
+end
+
+class ProcessReport
+  attr_reader :target, :path
+
+  def initialize(target, path=nil)
+    @target = target
+    @path = path
+  end
+
+  def open
+    if @path
+      File.open(@path, "w") do |f|
+        yield f
+      end
+    else
+      yield $stdout
+    end
+  end
+
+  def section(f, name=nil)
+    content = begin
+      yield
+    rescue StandardError => e
+      "<Error: #{e}>, backtrace =\n#{e.backtrace.join("\n")}"
+    end
+    if name
+      f.puts("#{name}:")
+      f.puts(content)
+      f.puts ''
+    end
+  end
+
+  def generate
+    open do |f|
+      section(f, "Time")        { Time.now }
+      section(f, "PID")         { @target.pid }
+      section(f, "Command")     { @target.procline }
+      section(f, "RSS")         { @target.rss }
+      section(f, "CPU")         { @target.cpu }
+      section(f, "Parent PID")  { @target.ppid }
+      section(f, "OS")          { ShellWrapper.execute('uname -a') }
+      section(f, "Environment") { @target.environment }
+
+      section(f) do
+        c_backtraces, ruby_backtraces = @target.gather_backtraces
+        if c_backtraces.match(/could not attach/i)
+          fail("Failed to attach to target process. Please try again with sudo.")
+        end
+        section(f, "C Backtraces")   { c_backtraces }
+        section(f, "Ruby Backtrace") { ruby_backtraces }
+      end
+
+      section(f, "Open files") { @target.open_files }
+      section(f, "Log") do
+        commands = Logger.messages.map { |(_,msg)| msg }
+        commands.join("\n")
+      end
+    end
+  end
+end
+
+def prompt_for_confirmation(target_pid, target_cmd)
+  puts "Are you sure you want to attach to PID #{target_pid} ('#{target_cmd}')}?"
+  puts ''
+  puts "Extracting debug information from this process may cause it to hang, crash,"
+  puts "or otherwise malfunction. It is highly recommended that you only run this"
+  puts "script against processes that are already unresponsive."
+  puts ''
+  puts "Additionally, the output may contain sensitive information from the program's"
+  puts "command line arguments, environment, or open file list. Please examine the"
+  puts "output before sharing it."
+  puts ''
+  puts "To continue, type 'continue':"
+
+  until ($stdin.gets.strip == 'continue') do
+    puts "Please type 'continue' to continue, or ctrl-c to abort."
+  end
+end
+
+target_pid = ARGV[0]
+fail("Please provide a PID for the target process", :usage => true) unless target_pid
+
+gdb_path = `which gdb`
+fail("Could not find gdb, please ensure it is installed and in your PATH") if gdb_path.empty?
+
+target = RubyProcess.new(target_pid)
+if !target.attachable?
+  fail("You do not appear to have permissions to attach to the target process.\nPlease check the process owner and try again with sudo if necessary")
+end
+if !target.alive?
+  fail("Could not find process with PID #{target_pid}")
+end
+target_cmd = target.procline
+
+prompt_for_confirmation(target_pid, target_cmd)
+
+puts ''
+puts "Attaching to PID #{target_pid} ('#{target_cmd}')"
+
+timestamp = Time.now.to_i
+report_filename = "nrdebug-#{target_pid}-#{timestamp}.log"
+report = ProcessReport.new(target, report_filename)
+report.generate
+
+puts "Generated '#{report_filename}'"
+puts ''
+puts "Please examine the output file for potentially sensitive information and"
+puts "remove it before sharing this file with anyone."