newrelic_rpm 7.0.0 → 8.8.0

data/lib/new_relic/version.rb

@@ -3,23 +3,12 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
-
 module NewRelic
-  module VERSION #:nodoc:
-    def self.build_version_string(*parts)
-      parts.compact.join('.')
-    end
-
-    MAJOR = 7
-    MINOR = 0
-    TINY  = 0
-
-    begin
-      require File.join(File.dirname(__FILE__), 'build')
-    rescue LoadError
-      BUILD = nil
-    end
+  module VERSION # :nodoc:
+    MAJOR = 8
+    MINOR = 8
+    TINY = 0
 
-    STRING = build_version_string(MAJOR, MINOR, TINY, BUILD)
+    STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
   end
 end

data/lib/newrelic_rpm.rb

@@ -6,48 +6,24 @@
 #
 # When installed as a gem, you can activate the New Relic agent one of the following ways:
 #
-# For Rails, add:
-#    config.gem 'newrelic_rpm'
-# to your initialization sequence.
+# For applications using Bundler, add this to the Gemfile:
+#    gem 'newrelic_rpm'
 #
-# For merb, do
-#    dependency 'newrelic_rpm'
-# in the Merb config/init.rb
+# You will also need to install the newrelic.yml configuration file
 #
-# For Sinatra, do
-#    require 'newrelic_rpm'
-# after requiring 'sinatra'.
-#
-# For other frameworks, or to manage the agent manually, invoke NewRelic::Agent#manual_start
-# directly.
+# For applications not using Bundler, and for other installation information, visit:
+# https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent/
 #
 
 require 'new_relic/control'
-if defined?(Merb) && defined?(Merb::BootLoader)
-  module NewRelic
-    class MerbBootLoader < Merb::BootLoader
-      after Merb::BootLoader::ChooseAdapter
-      def self.run
-        NewRelic::Control.instance.init_plugin
-      end
-    end
-  end
-elsif defined?(Rails::VERSION)
-  if Rails::VERSION::MAJOR.to_i >= 3
-    module NewRelic
-      class Railtie < Rails::Railtie
 
-        initializer "newrelic_rpm.start_plugin", before: :load_config_initializers do |app|
-          NewRelic::Control.instance.init_plugin(:config => app.config)
-        end
+if defined?(Rails::VERSION)
+  module NewRelic
+    class Railtie < Rails::Railtie
+      initializer "newrelic_rpm.start_plugin", before: :load_config_initializers do |app|
+        NewRelic::Control.instance.init_plugin(config: app.config)
       end
     end
-  else
-    # After version 2.0 of Rails we can access the configuration directly.
-    # We need it to add dev mode routes after initialization finished.
-    config = nil
-    config = Rails.configuration if Rails.respond_to?(:configuration)
-    NewRelic::Control.instance.init_plugin :config => config
   end
 else
   NewRelic::Control.instance.init_plugin

data/lib/sequel/extensions/newrelic_instrumentation.rb

@@ -3,13 +3,12 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
-require 'sequel' unless defined?( Sequel )
-require 'newrelic_rpm' unless defined?( NewRelic )
+require 'sequel' unless defined?(Sequel)
+require 'newrelic_rpm' unless defined?(NewRelic)
 require 'new_relic/agent/instrumentation/sequel_helper'
 require 'new_relic/agent/datastores/metric_helper'
 
 module Sequel
-
   # New Relic's Sequel instrumentation is implemented via a plugin for
   # Sequel::Models, and an extension for Sequel::Databases. Every database
   # handle that Sequel knows about when New Relic is loaded will automatically
@@ -31,7 +30,6 @@ module Sequel
   # `disable_activerecord_instrumentation` setting.
   #
   module NewRelicInstrumentation
-
     module Naming
       def self.query_method_name
         if Sequel::VERSION >= "4.35.0"
@@ -42,7 +40,7 @@ module Sequel
       end
     end
 
-    define_method Naming.query_method_name do |*args, &blk| #THREAD_LOCAL_ACCESS
+    define_method Naming.query_method_name do |*args, &blk| # THREAD_LOCAL_ACCESS
       sql = args.first
 
       product = NewRelic::Agent::Instrumentation::SequelHelper.product_name_from_adapter(self.class.adapter_scheme)
@@ -86,7 +84,7 @@ module Sequel
     def explainer_for sql
       Proc.new do |*|
         if THREAD_SAFE_CONNECTION_POOL_CLASSES.include?(self.pool.class)
-          self[ sql ].explain
+          self[sql].explain
         else
           NewRelic::Agent.logger.log_once(:info, :sequel_explain_skipped, "Not running SQL explains because Sequel is not in recognized multi-threaded mode")
           nil
@@ -97,5 +95,4 @@ module Sequel
 
   NewRelic::Agent.logger.debug "Registering the :newrelic_instrumentation extension."
   Database.register_extension(:newrelic_instrumentation, NewRelicInstrumentation)
-
 end # module Sequel

data/lib/sequel/plugins/newrelic_instrumentation.rb

@@ -3,23 +3,21 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
-require 'sequel' unless defined?( Sequel )
-require 'newrelic_rpm' unless defined?( NewRelic )
+require 'sequel' unless defined?(Sequel)
+require 'newrelic_rpm' unless defined?(NewRelic)
 require 'new_relic/agent/instrumentation/sequel_helper'
 require 'new_relic/agent/datastores/metric_helper'
 
 module Sequel
   module Plugins
-
     # Sequel::Model instrumentation for the New Relic agent.
     module NewrelicInstrumentation
-
       # Meta-programming for creating method tracers for the Sequel::Model plugin.
       module MethodWrapping
         # Install a method named +method_name+ that will trace execution
         # with a metric name derived from +operation_name+ (or +method_name+ if +operation_name+
         # isn't specified).
-        def wrap_sequel_method(method_name, operation_name=method_name)
+        def wrap_sequel_method(method_name, operation_name = method_name)
           define_method(method_name) do |*args, &block|
             klass = self.is_a?(Class) ? self : self.class
             product = NewRelic::Agent::Instrumentation::SequelHelper.product_name_from_adapter(db.adapter_scheme)
@@ -36,7 +34,6 @@ module Sequel
             end
           end
         end
-
       end # module MethodTracer
 
       # Methods to be added to Sequel::Model instances.
@@ -51,10 +48,8 @@ module Sequel
         wrap_sequel_method :update_fields
         wrap_sequel_method :update_only
         wrap_sequel_method :save
-
       end # module InstanceMethods
 
-
       # Methods to be added to Sequel::Model classes.
       module ClassMethods
         extend Sequel::Plugins::NewrelicInstrumentation::MethodWrapping
@@ -64,7 +59,6 @@ module Sequel
         wrap_sequel_method :first
         wrap_sequel_method :create
       end # module ClassMethods
-
     end # module NewRelicInstrumentation
   end # module Plugins
 end # module Sequel

data/lib/tasks/all.rb

@@ -2,7 +2,7 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
-# This is required to load in task definitions from merb
-Dir.glob(File.join(File.dirname(__FILE__),'*.rake')) do |file|
+# This is required to load in task definitions
+Dir.glob(File.join(File.dirname(__FILE__), '*.rake')) do |file|
   load file
 end

data/lib/tasks/config.html.erb

@@ -1,32 +1,21 @@
 <% sections.each do |(section_key, section_name, section_description, configs)| %>
-<h2 id="<%=section_key%>"><%=section_name%></h2>
+## <%=section_name%>
 
-<%= "<p>#{section_description}</p>" unless section_description.nil? %>
+<%= "#{section_description}" unless section_description.nil? %>
 
-<dl class="clamshell-list">
+<CollapserGroup>
   <% configs.each do |config|%>
-  <!-- ********** <%= config[:key] %> ********** -->
-  <dt id="<%= config[:key].gsub('.', '-') %>"><%=config[:key]%></dt>
-  <dd>
-  <table class="specs">
-    <tbody>
-      <tr>
-        <th>Type</th>
-        <td><%=config[:type]%></td>
-      </tr>
-      <tr>
-        <th>Default</th>
-        <td><%=config[:default]%></td>
-      </tr>
-      <tr>
-        <th>Environ variable</th>
-        <td><code><%=config[:env_var]%></code></td>
-      </tr>
-    </tbody>
-  </table>
+  <Collapser id="<%= config[:key].gsub('.', '-') %>" title="<%=config[:key]%>">
+    <table>
+      <tbody>
+        <tr><th>Type</th><td><%=config[:type]%></td></tr>
+        <tr><th>Default</th><td>`<%=config[:default]%>`</td></tr>
+        <tr><th>Environ variable</th><td>`<%=config[:env_var]%>`</td></tr>
+      </tbody>
+    </table>
 
-  <p><%=config[:description]%></p>
-  </dd>
+  <%=config[:description]%>
+  </Collapser>
   <% end %>
-</dl>
+</CollapserGroup>
 <% end %>

data/lib/tasks/config.rake

@@ -2,34 +2,38 @@ namespace :newrelic do
   namespace :config do
     desc "Describe available New Relic configuration settings."
 
-    GENERAL    = "general"
-    DISABLING  = "disabling"
+    GENERAL = "general"
+    DISABLING = "disabling"
     ATTRIBUTES = "attributes"
 
+    # these configuration options are not able to be set using environment variables
+    NON_ENV_CONFIGS = ['error_collector.ignore_classes', 'error_collector.ignore_messages', 'error_collector.expected_classes', 'error_collector.expected_messages']
+
     SECTION_DESCRIPTIONS = {
-      GENERAL              => 'These settings are available for agent configuration. Some settings depend on your New Relic subscription level.',
-      DISABLING            => 'Use these settings to toggle instrumentation types during agent startup.',
-      ATTRIBUTES           => '<a href="https://docs.newrelic.com/docs/features/agent-attributes">Attributes</a> are key-value pairs containing information that determines the properties of an event or transaction. These key-value pairs can be viewed within transaction traces in New Relic APM, traced errors in New Relic APM, transaction events in Insights, and page views in Insights. You can customize exactly which attributes will be sent to each of these destinations.',
-      "transaction_tracer" => 'The <a href="/docs/apm/traces/transaction-traces/transaction-traces">transaction traces</a> feature collects detailed information from a selection of transactions, including a summary of the calling sequence, a breakdown of time spent, and a list of SQL queries and their query plans (on mysql and postgresql). Available features depend on your New Relic subscription level.',
-      "error_collector"    => 'The agent collects and reports all uncaught exceptions by default. These configuration options allow you to customize the error collection.',
-      "browser_monitoring" => 'New Relic Browser\'s <a href="/docs/browser/new-relic-browser/page-load-timing/page-load-timing-process">page load timing</a> feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users\' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page.',
-      "analytics_events"   => '<a href="/docs/insights/new-relic-insights/understanding-insights/new-relic-insights">New Relic Insights</a> is a software analytics resource to gather and visualize data about your software and what it says about your business. With it you can quickly and easily create real-time dashboards to get immediate answers about end-user experiences, clickstreams, mobile activities, and server transactions.'
+      GENERAL => 'These settings are available for agent configuration. Some settings depend on your New Relic subscription level.',
+      DISABLING => 'Use these settings to toggle instrumentation types during agent startup.',
+      ATTRIBUTES => '[Attributes](/docs/features/agent-attributes) are key-value pairs containing information that determines the properties of an event or transaction. These key-value pairs can be viewed within transaction traces in APM, traced errors in APM, transaction events in dashboards, and page views in dashboards. You can customize exactly which attributes will be sent to each of these destinations',
+      "transaction_tracer" => 'The [transaction traces](/docs/apm/traces/transaction-traces/transaction-traces) feature collects detailed information from a selection of transactions, including a summary of the calling sequence, a breakdown of time spent, and a list of SQL queries and their query plans (on mysql and postgresql). Available features depend on your New Relic subscription level.',
+      "error_collector" => "The agent collects and reports all uncaught exceptions by default. These configuration options allow you to customize the error collection.\n\nFor information on ignored and expected errors, [see this page on Error Analytics in APM](/docs/agents/manage-apm-agents/agent-data/manage-errors-apm-collect-ignore-or-mark-expected/). To set expected errors via the `NewRelic::Agent.notice_error` Ruby method, [consult the Ruby Agent API](/docs/agents/ruby-agent/api-guides/sending-handled-errors-new-relic/).",
+      "browser_monitoring" => "The browser monitoring [page load timing](/docs/browser/new-relic-browser/page-load-timing/page-load-timing-process) feature (sometimes referred to as real user monitoring or RUM) gives you insight into the performance real users are experiencing with your website. This is accomplished by measuring the time it takes for your users' browsers to download and render your web pages by injecting a small amount of JavaScript code into the header and footer of each page.",
+      "analytics_events" => '[New Relic dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-new-relic-one-dashboards) is a resource to gather and visualize data about your software and what it says about your business. With it you can quickly and easily create real-time dashboards to get immediate answers about end-user experiences, clickstreams, mobile activities, and server transactions.'
     }
 
     NAME_OVERRIDES = {
-      "slow_sql"     => "Slow SQL"
+      "slow_sql" => "Slow SQL",
+      "custom_insights_events" => "Custom Events"
     }
 
     def output(format)
       config_hash = build_config_hash
       sections = flatten_config_hash(config_hash)
 
-      puts build_erb(format).result(binding)
+      puts build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('.  ', '. ')
       sections # silences unused warning to return this
     end
 
     def build_config_hash
-      sections = Hash.new {|hash, key| hash[key] = []}
+      sections = Hash.new { |hash, key| hash[key] = [] }
       NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
         next unless value[:public]
 
@@ -37,20 +41,20 @@ namespace :newrelic do
         key = key.to_s
         components = key.split(".")
 
-        if key.match(/^disable_/)           # "disable_httpclient"
+        if key.match(/^disable_/) # "disable_httpclient"
           section_key = DISABLING
-        elsif components.length == 2        # "analytics_events.enabled"
+        elsif components.length >= 2 && !(components[1] == "attributes") # "analytics_events.enabled"
           section_key = components.first
         elsif components[1] == "attributes" # "transaction_tracer.attributes.enabled"
           section_key = ATTRIBUTES
         end
 
         sections[section_key] << {
-          :key         => key,
-          :type        => format_type(value[:type]),
+          :key => key,
+          :type => format_type(value[:type]),
           :description => format_description(value),
-          :default     => format_default_value(value),
-          :env_var     => format_env_var(key)
+          :default => format_default_value(value),
+          :env_var => format_env_var(key)
         }
       end
       sections
@@ -60,10 +64,12 @@ namespace :newrelic do
       sections = []
       sections << pluck(GENERAL, config_hash)
       sections << pluck("transaction_tracer", config_hash)
-      sections << pluck("error_collector",    config_hash)
+      sections << pluck("error_collector", config_hash)
       sections << pluck("browser_monitoring", config_hash)
-      sections << pluck("analytics_events",   config_hash)
-      sections.concat(config_hash.to_a.sort_by { |a| a.first})
+      sections << pluck("analytics_events", config_hash)
+      sections << pluck("transaction_events", config_hash)
+      sections << pluck("application_logging", config_hash)
+      sections.concat(config_hash.to_a.sort_by { |a| a.first })
 
       add_data_to_sections(sections)
 
@@ -82,9 +88,9 @@ namespace :newrelic do
       name = NAME_OVERRIDES[key]
       return name if name
 
-      key.split("_").
-          each { |fragment| fragment[0] = fragment[0].upcase }.
-          join(" ")
+      key.split("_")
+        .each { |fragment| fragment[0] = fragment[0].upcase }
+        .join(" ")
     end
 
     def format_type(type)
@@ -96,20 +102,23 @@ namespace :newrelic do
     end
 
     def format_description(value)
-      description = value[:description]
-      description = "<b>DEPRECATED</b> #{description}" if value[:deprecated]
+      description = ''
+      description += "<b>DEPRECATED</b> " if value[:deprecated]
+      description += value[:description]
       description
     end
 
     def format_default_value(spec)
+      return spec[:documentation_default] if !spec[:documentation_default].nil?
       if spec[:default].is_a?(Proc)
         '(Dynamic)'
       else
-        "<code>#{spec[:default].inspect}</code>"
+        "#{spec[:default].inspect}"
       end
     end
 
     def format_env_var(key)
+      return "None" if NON_ENV_CONFIGS.include? key
       "NEW_RELIC_#{key.gsub(".", "_").upcase}"
     end
 

data/lib/tasks/multiverse.rb

@@ -42,10 +42,9 @@ namespace :test do
   end
 
   namespace :multiverse do
-
     def remove_local_multiverse_databases
-      list_databases_command = %{echo "show databases" | mysql -u root}
-      databases = `#{list_databases_command}`.chomp!.split("\n").select{|s| s =~ /multiverse/}
+      list_databases_command = %(echo "show databases" | mysql -u root)
+      databases = `#{list_databases_command}`.chomp!.split("\n").select { |s| s =~ /multiverse/ }
       databases.each do |database|
         puts "Dropping #{database}"
         `echo "drop database #{database}" | mysql -u root`
@@ -58,7 +57,7 @@ namespace :test do
     def remove_generated_gemfiles
       file_path = File.expand_path "test/multiverse/suites"
       Dir.glob(File.join file_path, "**", "Gemfile*").each do |fn|
-        puts "Removing #{fn.gsub(file_path,'.../suites')}"
+        puts "Removing #{fn.gsub(file_path, '.../suites')}"
         FileUtils.rm fn
       end
     end
@@ -66,7 +65,7 @@ namespace :test do
     def remove_generated_gemfile_lockfiles
       file_path = File.expand_path "test/environments"
       Dir.glob(File.join file_path, "**", "Gemfile.lock").each do |fn|
-        puts "Removing #{fn.gsub(file_path,'.../environments')}"
+        puts "Removing #{fn.gsub(file_path, '.../environments')}"
         FileUtils.rm fn
       end
     end
@@ -99,6 +98,5 @@ namespace :test do
     task :prime, [:suite] => [:env] do |_, args|
       Multiverse::Runner.prime(args.suite, Multiverse::Runner.parse_args(args))
     end
-
   end
 end

data/lib/tasks/tests.rake

@@ -9,26 +9,23 @@ if defined? Rake::TestTask
       matches = tasks.map { |t| /(seed=.*?)[,\]]/.match(t) }.compact
       if matches.any?
         matches.first[1]
-      else
-        nil
       end
     end
 
     tasks = Rake.application.top_level_tasks
     ENV["TESTOPTS"] ||= ""
-    if tasks.any? { |t| t.include?("verbose")}
+    if tasks.any? { |t| t.include?("verbose") }
       ENV["TESTOPTS"] += " -v"
     end
     if seed = look_for_seed(tasks)
       ENV["TESTOPTS"] += " --" + seed
     end
 
-    agent_home = File.expand_path(File.join(File.dirname(__FILE__),'..','..'))
+    agent_home = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
 
     Rake::TestTask.new(:newrelic) do |t|
-      
       file_pattern = ENV["file"]
-      file_pattern = file_pattern.split(",").map{|f| "#{agent_home}/#{f}".gsub("//", "/")} if file_pattern
+      file_pattern = file_pattern.split(",").map { |f| "#{agent_home}/#{f}".gsub("//", "/") } if file_pattern
       file_pattern ||= "#{agent_home}/test/new_relic/**/*_test.rb"
 
       t.libs << "#{agent_home}/test"
@@ -36,6 +33,5 @@ if defined? Rake::TestTask
       t.pattern = Array(file_pattern)
       t.verbose = true
     end
-
   end
 end