newrelic_rpm 8.2.0 → 8.3.0

data/lib/new_relic/agent.rb

@@ -44,7 +44,7 @@ module NewRelic
     require 'new_relic/agent/sql_sampler'
     require 'new_relic/agent/commands/thread_profiler_session'
     require 'new_relic/agent/error_collector'
-    require 'new_relic/agent/error_filter'   
+    require 'new_relic/agent/error_filter'
     require 'new_relic/agent/sampler'
     require 'new_relic/agent/database'
     require 'new_relic/agent/database_adapter'
@@ -111,19 +111,19 @@ module NewRelic
     @tracer_queue = []
 
     # The singleton Agent instance.  Used internally.
-    def agent #:nodoc:
+    def agent # :nodoc:
       return @agent if @agent
       NewRelic::Agent.logger.warn("Agent unavailable as it hasn't been started.")
       NewRelic::Agent.logger.warn(caller.join("\n"))
       nil
     end
 
-    def agent=(new_instance)#:nodoc:
+    def agent=(new_instance) # :nodoc:
       @agent = new_instance
       add_deferred_method_tracers_now
     end
 
-    alias instance agent #:nodoc:
+    alias instance agent # :nodoc:
 
     # Primary interface to logging is fronted by this accessor
     # Access via ::NewRelic::Agent.logger
@@ -187,7 +187,7 @@ module NewRelic
     # This method is safe to use from any thread.
     #
     # @api public
-    def record_metric(metric_name, value) #THREAD_LOCAL_ACCESS
+    def record_metric(metric_name, value) # THREAD_LOCAL_ACCESS
       record_api_supportability_metric(:record_metric)
 
       return unless agent
@@ -217,14 +217,14 @@ module NewRelic
 
     SUPPORTABILITY_INCREMENT_METRIC = 'Supportability/API/increment_metric'.freeze
 
-    def increment_metric(metric_name, amount=1) #THREAD_LOCAL_ACCESS
+    def increment_metric(metric_name, amount = 1) # THREAD_LOCAL_ACCESS
       return unless agent
       if amount == 1
         metrics = [metric_name, SUPPORTABILITY_INCREMENT_METRIC]
-        agent.stats_engine.tl_record_unscoped_metrics(metrics) {|stats| stats.increment_count}
+        agent.stats_engine.tl_record_unscoped_metrics(metrics) { |stats| stats.increment_count }
       else
-        agent.stats_engine.tl_record_unscoped_metrics(metric_name) {|stats| stats.increment_count(amount)}
-        agent.stats_engine.tl_record_unscoped_metrics(SUPPORTABILITY_INCREMENT_METRIC) {|stats| stats.increment_count}
+        agent.stats_engine.tl_record_unscoped_metrics(metric_name) { |stats| stats.increment_count(amount) }
+        agent.stats_engine.tl_record_unscoped_metrics(SUPPORTABILITY_INCREMENT_METRIC) { |stats| stats.increment_count }
       end
     end
 
@@ -281,7 +281,7 @@ module NewRelic
     #
     # @api public
     #
-    def notice_error(exception, options={})
+    def notice_error(exception, options = {})
       record_api_supportability_metric(:notice_error)
 
       Transaction.notice_error(exception, options)
@@ -347,9 +347,9 @@ module NewRelic
     #
     # @api public
     #
-    def manual_start(options={})
+    def manual_start(options = {})
       raise "Options must be a hash" unless Hash === options
-      NewRelic::Control.instance.init_plugin({ :agent_enabled => true, :sync_startup => true }.merge(options))
+      NewRelic::Control.instance.init_plugin({:agent_enabled => true, :sync_startup => true}.merge(options))
       record_api_supportability_metric(:manual_start)
     end
 
@@ -378,7 +378,7 @@ module NewRelic
     #
     # @api public
     #
-    def after_fork(options={})
+    def after_fork(options = {})
       record_api_supportability_metric(:after_fork)
       agent.after_fork(options) if agent
     end
@@ -390,7 +390,7 @@ module NewRelic
     #
     # @api public
     #
-    def shutdown(options={})
+    def shutdown(options = {})
       record_api_supportability_metric(:shutdown)
       agent.shutdown if agent
     end
@@ -512,7 +512,7 @@ module NewRelic
     #
     def disable_transaction_tracing
       Deprecator.deprecate :disable_transaction_tracing,
-                           'disable_all_tracing or ignore_transaction'
+        'disable_all_tracing or ignore_transaction'
       record_api_supportability_metric(:disable_transaction_tracing)
       yield
     end
@@ -572,7 +572,7 @@ module NewRelic
     #
     # @api public
     #
-    def add_custom_attributes(params) #THREAD_LOCAL_ACCESS
+    def add_custom_attributes(params) # THREAD_LOCAL_ACCESS
       record_api_supportability_metric(:add_custom_attributes)
 
       if params.is_a? Hash
@@ -644,7 +644,7 @@ module NewRelic
     #
     # @api public
     #
-    def set_transaction_name(name, options={})
+    def set_transaction_name(name, options = {})
       record_api_supportability_metric(:set_transaction_name)
       Transaction.set_overriding_transaction_name(name, options[:category])
     end
@@ -654,7 +654,7 @@ module NewRelic
     #
     # @api public
     #
-    def get_transaction_name #THREAD_LOCAL_ACCESS
+    def get_transaction_name # THREAD_LOCAL_ACCESS
       record_api_supportability_metric(:get_transaction_name)
 
       txn = Transaction.tl_current
@@ -686,13 +686,13 @@ module NewRelic
     # Subscribe to events of +event_type+, calling the given +handler+
     # when one is sent.
     def subscribe(event_type, &handler)
-      agent.events.subscribe( event_type, &handler )
+      agent.events.subscribe(event_type, &handler)
     end
 
     # Fire an event of the specified +event_type+, passing it an the given +args+
     # to any registered handlers.
     def notify(event_type, *args)
-      agent.events.notify( event_type, *args )
+      agent.events.notify(event_type, *args)
     rescue
       NewRelic::Agent.logger.debug "Ignoring exception during %p event notification" % [event_type]
     end
@@ -743,7 +743,7 @@ module NewRelic
       metadata
     end
 
-    #@!endgroup
+    # @!endgroup
 
     # @!group Manual browser monitoring configuration
 
@@ -763,7 +763,7 @@ module NewRelic
     #
     # @api public
     #
-    def browser_timing_header(nonce=nil)
+    def browser_timing_header(nonce = nil)
       record_api_supportability_metric(:browser_timing_header)
 
       return "" unless agent

data/lib/new_relic/cli/command.rb

@@ -15,7 +15,7 @@ module NewRelic
       # Capture a failure to execute the command.
       class CommandFailure < StandardError
         attr_reader :options
-        def initialize message, opt_parser=nil
+        def initialize message, opt_parser = nil
           super message
           @options = opt_parser
         end
@@ -32,13 +32,13 @@ module NewRelic
       def initialize(command_line_args)
         if Hash === command_line_args
           # command line args is an options hash
-          command_line_args.each do | key, value |
+          command_line_args.each do |key, value|
             instance_variable_set "@#{key}", value.to_s if value
           end
         else
           # parse command line args.  Throw an exception on a bad arg.
-          @options = options do | opts |
-            opts.on("-h", "Show this help") {  raise CommandFailure, opts.to_s }
+          @options = options do |opts|
+            opts.on("-h", "Show this help") { raise CommandFailure, opts.to_s }
           end
           @leftover = @options.parse(command_line_args)
         end
@@ -55,8 +55,7 @@ module NewRelic
       Dir[cmds].each { |command| require command }
 
       def self.run
-
-        @command_names = @commands.map{ |c| c.command }
+        @command_names = @commands.map { |c| c.command }
 
         extra = []
         options = ARGV.options do |opts|
@@ -65,7 +64,7 @@ module NewRelic
             $stdout.puts "warning: the 'newrelic_cmd' script has been renamed 'newrelic'"
             script_name = 'newrelic'
           end
-          opts.banner = "Usage: #{script_name} [ #{ @command_names.join(" | ")} ] [options]"
+          opts.banner = "Usage: #{script_name} [ #{@command_names.join(" | ")} ] [options]"
           opts.separator "use '#{script_name} <command> -h' to see detailed command options"
           opts
         end
@@ -73,19 +72,18 @@ module NewRelic
         command = extra.shift
         # just make it a little easier on them
         command = 'deployments' if command =~ /deploy/
-          if command.nil?
-            STDERR.puts options
-          elsif !@command_names.include?(command)
-            STDERR.puts "Unrecognized command: #{command}"
-            STDERR.puts options
-          else
-            command_class = @commands.find{ |c| c.command == command}
-            command_class.new(extra).run
-          end
+        if command.nil?
+          STDERR.puts options
+        elsif !@command_names.include?(command)
+          STDERR.puts "Unrecognized command: #{command}"
+          STDERR.puts options
+        else
+          command_class = @commands.find { |c| c.command == command }
+          command_class.new(extra).run
+        end
       rescue OptionParser::InvalidOption => e
         raise NewRelic::Cli::Command::CommandFailure, e.message
       end
     end
-
   end
 end

data/lib/new_relic/cli/commands/deployments.rb

@@ -30,8 +30,8 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
   def initialize command_line_args
     @control = NewRelic::Control.instance
     @environment = nil
-    @changelog   = nil
-    @user        = nil
+    @changelog = nil
+    @user = nil
     super(command_line_args)
     @description ||= @leftover && @leftover.join(" ")
     @user ||= ENV['USER']
@@ -66,12 +66,12 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
       @description = nil if @description && @description.strip.empty?
       create_params = {}
       {
-            :application_id => @appname,
-            :host => NewRelic::Agent::Hostname.get,
-            :description => @description,
-            :user => @user,
-            :revision => @revision,
-            :changelog => @changelog
+        :application_id => @appname,
+        :host => NewRelic::Agent::Hostname.get,
+        :description => @description,
+        :user => @user,
+        :revision => @revision,
+        :changelog => @changelog
       }.each do |k, v|
         create_params["deployment[#{k}]"] = v unless v.nil? || v == ''
       end
@@ -90,9 +90,9 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
       response = http.request(request)
 
       if response.is_a? Net::HTTPSuccess
-        info "Recorded deployment to '#{@appname}' (#{@description || Time.now })"
+        info "Recorded deployment to '#{@appname}' (#{@description || Time.now})"
       else
-        err_string = REXML::Document.new(response.body).elements['errors/error'].map(&:to_s).join("; ") rescue  response.message
+        err_string = REXML::Document.new(response.body).elements['errors/error'].map(&:to_s).join("; ") rescue response.message
         raise NewRelic::Cli::Command::CommandFailure, "Deployment not recorded: #{err_string}"
       end
     rescue SystemCallError, SocketError => e
@@ -111,26 +111,24 @@ class NewRelic::Cli::Deployments < NewRelic::Cli::Command
   private
 
   def options
-    OptionParser.new %Q{Usage: #{$0} #{self.class.command} [OPTIONS] ["description"] }, 40 do |o|
+    OptionParser.new %Q(Usage: #{$0} #{self.class.command} [OPTIONS] ["description"] ), 40 do |o|
       o.separator "OPTIONS:"
       o.on("-a", "--appname=NAME", String,
-             "Set the application name.",
-             "Default is app_name setting in newrelic.yml") { | e | @appname = e }
+        "Set the application name.",
+        "Default is app_name setting in newrelic.yml") { |e| @appname = e }
       o.on("-e", "--environment=name", String,
-               "Override the (RAILS|RUBY|RACK)_ENV setting",
-               "currently: #{control.env}") { | e | @environment = e }
+        "Override the (RAILS|RUBY|RACK)_ENV setting",
+        "currently: #{control.env}") { |e| @environment = e }
       o.on("-u", "--user=USER", String,
-             "Specify the user deploying, for information only",
-             "Default: #{@user || '<none>'}") { | u | @user = u }
+        "Specify the user deploying, for information only",
+        "Default: #{@user || '<none>'}") { |u| @user = u }
       o.on("-r", "--revision=REV", String,
-             "Specify the revision being deployed") { | r | @revision = r }
+        "Specify the revision being deployed") { |r| @revision = r }
       o.on("-l", "--license-key=KEY", String,
-             "Specify the license key of the account for the app being deployed") { | l | @license_key = l }
+        "Specify the license key of the account for the app being deployed") { |l| @license_key = l }
       o.on("-c", "--changes",
-             "Read in a change log from the standard input") { @changelog = STDIN.read }
+        "Read in a change log from the standard input") { @changelog = STDIN.read }
       yield o if block_given?
     end
   end
-
-
 end

data/lib/new_relic/cli/commands/install.rb

@@ -7,7 +7,6 @@ require 'new_relic/version'
 require 'erb'
 
 class NewRelic::Cli::Install < NewRelic::Cli::Command
-
   NO_LICENSE_KEY = "<PASTE LICENSE KEY HERE>"
 
   def self.command; "install"; end
@@ -21,7 +20,7 @@ class NewRelic::Cli::Install < NewRelic::Cli::Command
   # Will throw CommandFailed exception if there's any error.
   #
   attr_reader :dest_dir, :license_key, :generated_for_user, :quiet, :src_file, :app_name
-  def initialize command_line_args={}
+  def initialize command_line_args = {}
     @dest_dir = nil
     super command_line_args
     if @dest_dir.nil?
@@ -43,7 +42,7 @@ class NewRelic::Cli::Install < NewRelic::Cli::Command
     if File.exist?(dest_file) && !@force
       raise NewRelic::Cli::Command::CommandFailure, "newrelic.yml file already exists.  Use --force flag to overwrite."
     end
-    File.open(dest_file, 'w') { | out | out.puts(content) }
+    File.open(dest_file, 'w') { |out| out.puts(content) }
 
     puts <<-EOF unless quiet
 
@@ -60,11 +59,10 @@ you receive upon registration.
 
 Visit support.newrelic.com if you are experiencing installation issues.
     EOF
-
   end
 
   def content
-    @src_file ||= File.expand_path(File.join(File.dirname(__FILE__),"..","..","..","..","newrelic.yml"))
+    @src_file ||= File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "..", "newrelic.yml"))
     template = File.read(@src_file)
     ERB.new(template).result(binding)
   end
@@ -73,14 +71,12 @@ Visit support.newrelic.com if you are experiencing installation issues.
 
   def options
     OptionParser.new "Usage: #{$0} #{self.class.command} [ OPTIONS] 'application name'", 40 do |o|
-      o.on("-f", "--force", "Overwrite newrelic.yml if it exists") { | e | @force = true }
+      o.on("-f", "--force", "Overwrite newrelic.yml if it exists") { |e| @force = true }
       o.on("-l", "--license_key=NAME", String,
-             "Use the given license key") { | e | @license_key = e }
+        "Use the given license key") { |e| @license_key = e }
       o.on("-d", "--destdir=name", String,
-               "Write the newrelic.yml to the given directory, default is '.'") { | e | @dest_dir = e }
+        "Write the newrelic.yml to the given directory, default is '.'") { |e| @dest_dir = e }
       yield o if block_given?
     end
   end
-
-
 end

data/lib/new_relic/coerce.rb

@@ -5,7 +5,6 @@
 
 module NewRelic
   module Coerce
-
     module_function
 
     # We really don't want to send bad values to the collector, and it doesn't
@@ -15,14 +14,14 @@ module NewRelic
     # to provide documentation of expected types on to_collector_array methods,
     # and to log failures if totally invalid data gets into outgoing data
 
-    def int(value, context=nil)
+    def int(value, context = nil)
       Integer(value)
     rescue => error
       log_failure(value, Integer, context, error)
       0
     end
 
-    def int_or_nil(value, context=nil)
+    def int_or_nil(value, context = nil)
       return nil if value.nil?
       Integer(value)
     rescue => error
@@ -30,7 +29,7 @@ module NewRelic
       nil
     end
 
-    def float(value, context=nil)
+    def float(value, context = nil)
       result = Float(value)
       raise "Value #{result.inspect} is not finite." unless result.finite?
       result
@@ -39,7 +38,7 @@ module NewRelic
       0.0
     end
 
-    def string(value, context=nil)
+    def string(value, context = nil)
       return value if value.nil?
       String(value)
     rescue => error
@@ -54,8 +53,6 @@ module NewRelic
       when Float
         if val.finite?
           val
-        else
-          nil
         end
       when Symbol
         val.to_s
@@ -76,7 +73,7 @@ module NewRelic
       value.to_i
     end
 
-    def float! value, precision=NewRelic::PRIORITY_PRECISION
+    def float! value, precision = NewRelic::PRIORITY_PRECISION
       return nil unless value_or_nil(value)
       value.to_f.round(precision)
     end

data/lib/new_relic/collection_helper.rb

@@ -4,58 +4,59 @@
 
 module NewRelic
   module CollectionHelper
-  DEFAULT_TRUNCATION_SIZE=16 * 1024
-  DEFAULT_ARRAY_TRUNCATION_SIZE=128
-  # Transform parameter hash into a hash whose values are strictly
-  # strings
-  def normalize_params(params)
-    case params
-      when Hash
-        # optimize for empty hash since that is often what this is called with.
-        return params if params.empty?
-        new_params = {}
-        params.each do | key, value |
-          new_params[truncate(normalize_params(key),64)] = normalize_params(value)
-        end
-        new_params
-      when Symbol, FalseClass, TrueClass, nil
-        params
-      when Numeric
-        truncate(params.to_s)
-      when String
-        truncate(params)
-      when Array
-        params.first(DEFAULT_ARRAY_TRUNCATION_SIZE).map{|item| normalize_params(item)}
-    else
-      truncate(flatten(params))
+    DEFAULT_TRUNCATION_SIZE = 16 * 1024
+    DEFAULT_ARRAY_TRUNCATION_SIZE = 128
+    # Transform parameter hash into a hash whose values are strictly
+    # strings
+    def normalize_params(params)
+      case params
+        when Hash
+          # optimize for empty hash since that is often what this is called with.
+          return params if params.empty?
+          new_params = {}
+          params.each do |key, value|
+            new_params[truncate(normalize_params(key), 64)] = normalize_params(value)
+          end
+          new_params
+        when Symbol, FalseClass, TrueClass, nil
+          params
+        when Numeric
+          truncate(params.to_s)
+        when String
+          truncate(params)
+        when Array
+          params.first(DEFAULT_ARRAY_TRUNCATION_SIZE).map { |item| normalize_params(item) }
+        else
+          truncate(flatten(params))
+      end
     end
-  end
 
-  private
+    private
 
-  # Convert any kind of object to a short string.
-  def flatten(object)
-    case object
-      when nil then ''
-      when object.instance_of?(String) then object
-      when String then String.new(object)  # convert string subclasses to strings
-      else "#<#{object.class.to_s}>"
+    # Convert any kind of object to a short string.
+    def flatten(object)
+      case object
+        when nil then ''
+        when object.instance_of?(String) then object
+        when String then String.new(object) # convert string subclasses to strings
+        else "#<#{object.class.to_s}>"
+      end
     end
-  end
-  def truncate(string, len=DEFAULT_TRUNCATION_SIZE)
-    case string
-    when Symbol then string
-    when nil then ""
-    when String
-      real_string = flatten(string)
-      if real_string.size > len
-        real_string = real_string.slice(0...len)
-        real_string << "..."
+
+    def truncate(string, len = DEFAULT_TRUNCATION_SIZE)
+      case string
+      when Symbol then string
+      when nil then ""
+      when String
+        real_string = flatten(string)
+        if real_string.size > len
+          real_string = real_string.slice(0...len)
+          real_string << "..."
+        end
+        real_string
+      else
+        truncate(flatten(string), len)
       end
-      real_string
-    else
-      truncate(flatten(string), len)
     end
   end
-  end
 end

data/lib/new_relic/control/class_methods.rb

@@ -9,7 +9,7 @@ module NewRelic
     module ClassMethods
       # Access the Control singleton, lazy initialized.  Default will instantiate a new
       # instance or pass false to defer
-      def instance(create=true)
+      def instance(create = true)
         @instance ||= create && new_instance
       end
 
@@ -35,7 +35,7 @@ module NewRelic
 
       # nb this does not 'load test' the framework, it loads the 'test framework'
       def load_test_framework
-        config = File.expand_path(File.join('..','..','..','..', "test","config","newrelic.yml"), __FILE__)
+        config = File.expand_path(File.join('..', '..', '..', '..', "test", "config", "newrelic.yml"), __FILE__)
         require "config/test_control"
         NewRelic::Control::Frameworks::Test.new(local_env, config)
       end

data/lib/new_relic/control/frameworks/external.rb

@@ -11,7 +11,7 @@ module NewRelic
       # out specifically because in this context we are not monitoring
       # the running process, but actually external things.
       class External < NewRelic::Control::Frameworks::Ruby
-        def init_config(options={})
+        def init_config(options = {})
           super
         end
       end

data/lib/new_relic/control/frameworks/rails.rb

@@ -10,9 +10,8 @@ module NewRelic
       # Rails specific configuration, instrumentation, environment values,
       # etc.
       class Rails < NewRelic::Control::Frameworks::Ruby
-
         def env
-          @env ||= ( ENV['NEW_RELIC_ENV'] || RAILS_ENV.dup )
+          @env ||= (ENV['NEW_RELIC_ENV'] || RAILS_ENV.dup)
         end
 
         # Rails can return an empty string from this method, causing
@@ -43,7 +42,7 @@ module NewRelic
         # In versions of Rails prior to 2.0, the rails config was only available to
         # the init.rb, so it had to be passed on from there.  This is a best effort to
         # find a config and use that.
-        def init_config(options={})
+        def init_config(options = {})
           @config = options[:config]
           # Install the dependency detection,
           if rails_config && ::Rails.configuration.respond_to?(:after_initialize)
@@ -63,8 +62,8 @@ module NewRelic
           end
         rescue => e
           ::NewRelic::Agent.logger.error("Failure during init_config for Rails. Is Rails required in a non-Rails app? Set NEW_RELIC_FRAMEWORK=ruby to avoid this message.",
-                                         "The Ruby agent will continue running, but Rails-specific features may be missing.",
-                                         e)
+            "The Ruby agent will continue running, but Rails-specific features may be missing.",
+            e)
         end
 
         def install_agent_hooks(config)
@@ -103,7 +102,7 @@ module NewRelic
         protected
 
         def rails_vendor_root
-          File.join(root,'vendor','rails')
+          File.join(root, 'vendor', 'rails')
         end
 
         def install_shim

data/lib/new_relic/control/frameworks/rails3.rb

@@ -13,9 +13,8 @@ module NewRelic
       # NewRelic::Control::Frameworks::Rails class, where the two do
       # not differ
       class Rails3 < NewRelic::Control::Frameworks::Rails
-
         def env
-          @env ||= ( ENV['NEW_RELIC_ENV'] || ::Rails.env.to_s )
+          @env ||= (ENV['NEW_RELIC_ENV'] || ::Rails.env.to_s)
         end
 
         def rails_root
@@ -23,7 +22,7 @@ module NewRelic
         end
 
         def vendor_root
-          @vendor_root ||= File.join(root,'vendor','rails')
+          @vendor_root ||= File.join(root, 'vendor', 'rails')
         end
 
         def version

data/lib/new_relic/control/frameworks/ruby.rb

@@ -9,14 +9,14 @@ module NewRelic
       class Ruby < NewRelic::Control
         def env
           @env ||= ENV['NEW_RELIC_ENV'] || ENV['RUBY_ENV'] || ENV['RAILS_ENV'] ||
-                   ENV['APP_ENV']       || ENV['RACK_ENV'] || 'development'
+            ENV['APP_ENV'] || ENV['RACK_ENV'] || 'development'
         end
 
         def root
           @root ||= ENV['APP_ROOT'] || '.'
         end
 
-        def init_config(options={})
+        def init_config(options = {})
         end
       end
     end