newrelic_rpm 8.6.0 → 8.7.0

data/lib/new_relic/local_environment.rb

@@ -76,6 +76,7 @@ module NewRelic
         rainbows
         unicorn
       ]
+      # TODO: MAJOR VERSION - remove rainbows
       while dispatchers.any? && @discovered_dispatcher.nil?
         send 'check_for_' + (dispatchers.shift)
       end
@@ -127,6 +128,7 @@ module NewRelic
       end
     end
 
+    # TODO: MAJOR VERSION - remove this method
     def check_for_rainbows
       if (defined?(::Rainbows) && defined?(::Rainbows::HttpServer)) && NewRelic::LanguageSupport.object_space_usable?
         v = find_class_in_object_space(::Rainbows::HttpServer)

data/lib/new_relic/supportability_helper.rb

@@ -50,6 +50,7 @@ module NewRelic
       :shutdown,
       :start_segment,
       :trace,
+      :traced_thread,
       :trace_execution_scoped,
       :trace_execution_unscoped,
       :wrap

data/lib/new_relic/traced_thread.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+# frozen_string_literal: true
+
+module NewRelic
+  #
+  # This class allows the current transaction to be passed to a Thread so that nested segments can be created from the operations performed within the Thread's block.
+  # To have the New Relic Ruby agent automatically trace all of your applications threads,
+  # enable the `instrumentation.thread.tracing` configuration option in your newrelic.yml.
+  #
+  # Note: disabling the configuration option `instrumentation.thread` while using this class can cause incorrectly nested spans.
+  #
+  # @api public
+  class TracedThread < Thread
+    #
+    # Creates a new Thread whose work will be traced by New Relic.
+    # Use this class as a replacement for the native Thread class.
+    # Example: Instead of using `Thread.new`, use:
+    # ```ruby
+    #   NewRelic::TracedThread.new { execute_some_code }
+    # ```
+    #
+    # @api public
+    def initialize(*args, &block)
+      NewRelic::Agent.record_api_supportability_metric(:traced_thread)
+      traced_block = create_traced_block(*args, &block)
+      super(*args, &traced_block)
+    end
+
+    def create_traced_block(*args, &block)
+      return block if NewRelic::Agent.config[:'instrumentation.thread.tracing'] # if this is on, don't double trace
+      NewRelic::Agent::Tracer.thread_block_with_current_transaction(*args, &block)
+    end
+  end
+end

data/lib/new_relic/version.rb

@@ -6,7 +6,7 @@
 module NewRelic
   module VERSION # :nodoc:
     MAJOR = 8
-    MINOR = 6
+    MINOR = 7
     TINY = 0
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}"

data/lib/tasks/config.rake

@@ -6,18 +6,22 @@ namespace :newrelic do
     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 => '[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.\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/).',
+      "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)
@@ -39,7 +43,7 @@ namespace :newrelic do
 
         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
@@ -63,6 +67,8 @@ namespace :newrelic do
       sections << pluck("error_collector", config_hash)
       sections << pluck("browser_monitoring", config_hash)
       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)
@@ -103,6 +109,7 @@ namespace :newrelic do
     end
 
     def format_default_value(spec)
+      return spec[:documentation_default] if !spec[:documentation_default].nil?
       if spec[:default].is_a?(Proc)
         '(Dynamic)'
       else
@@ -111,6 +118,7 @@ namespace :newrelic do
     end
 
     def format_env_var(key)
+      return "None" if NON_ENV_CONFIGS.include? key
       "NEW_RELIC_#{key.gsub(".", "_").upcase}"
     end
 

data/newrelic.yml

@@ -31,7 +31,7 @@ common: &default_settings
 # application_logging.enabled: true
 
 # If `true`, the agent captures log records emitted by this application.
-# application_logging.forwarding.enabled: false
+# application_logging.forwarding.enabled: true
 
 # Defines the maximum number of log records to buffer in memory at a time.
 # application_logging.forwarding.max_samples_stored: 10000
@@ -395,6 +395,13 @@ common: &default_settings
 # May be one of [auto|prepend|chain|disabled].
 # instrumentation.typhoeus: auto
 
+# Controls auto-instrumentation of the Thread class at start up to allow the agent to correctly nest spans inside of an asyncronous transaction.
+# May be one of [auto|prepend|chain|disabled].
+# instrumentation.thread: auto
+
+# Controls auto-instrumentation of the Thread class at start up to automatically add tracing to all Threads created in the application.
+# instrumentation.thread.tracing: false
+
 # A dictionary of label names and values that will be applied to the data sent
 # from this agent. May also be expressed asa semicolon-delimited ; string of
 # colon-separated : pairs.
@@ -452,6 +459,10 @@ common: &default_settings
 # rake.connect_timeout: 10
 
 # Specify an array of Rake tasks to automatically instrument.
+# This configuration option converts the Array to a RegEx list.
+# If you'd like to allow all tasks by default, use `rake.tasks: [.+]`.
+# Rake tasks will not be instrumented unless they're added to this list.
+# For more information, visit the (New Relic Rake Instrumentation docs)[/docs/apm/agents/ruby-agent/background-jobs/rake-instrumentation].
 # rake.tasks: []
 
 # Define transactions you want the agent to ignore, by specifying a list of

data/newrelic_rpm.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.version = NewRelic::VERSION::STRING
   s.required_ruby_version = '>= 2.2.0'
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Tanna McClure", "Kayla Reopelle", "James Bunch"]
+  s.authors = ["Tanna McClure", "Kayla Reopelle", "James Bunch", "Hannah Ramadan"]
   s.licenses = ['Apache-2.0']
   s.description = <<-EOS
 New Relic is a performance management system, developed by New Relic,
@@ -47,7 +47,10 @@ https://github.com/newrelic/newrelic-ruby-agent/
   s.require_paths = ["lib"]
   s.rubygems_version = Gem::VERSION
   s.summary = "New Relic Ruby Agent"
-
+  s.post_install_message = 'Thanks for installing the latest version of newrelic_rpm. '\
+    'This version turns on application log forwarding by default. If you want to turn ' \
+    'off this feature, set `application_logging.forwarding.enabled: false`. ' \
+    'For more information, visit: https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-ruby'
   s.add_development_dependency 'rake', '12.3.3'
   s.add_development_dependency 'rb-inotify', '0.9.10' # locked to support < Ruby 2.3 (and listen 3.0.8)
   s.add_development_dependency 'listen', '3.0.8' # locked to support < Ruby 2.3

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 8.6.0
+  version: 8.7.0
 platform: ruby
 authors:
 - Tanna McClure
 - Kayla Reopelle
 - James Bunch
+- Hannah Ramadan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -448,6 +449,10 @@ files:
 - lib/new_relic/agent/instrumentation/sinatra/prepend.rb
 - lib/new_relic/agent/instrumentation/sinatra/transaction_namer.rb
 - lib/new_relic/agent/instrumentation/sunspot.rb
+- lib/new_relic/agent/instrumentation/thread.rb
+- lib/new_relic/agent/instrumentation/thread/chain.rb
+- lib/new_relic/agent/instrumentation/thread/instrumentation.rb
+- lib/new_relic/agent/instrumentation/thread/prepend.rb
 - lib/new_relic/agent/instrumentation/tilt.rb
 - lib/new_relic/agent/instrumentation/tilt/chain.rb
 - lib/new_relic/agent/instrumentation/tilt/instrumentation.rb
@@ -586,6 +591,7 @@ files:
 - lib/new_relic/recipes/capistrano3.rb
 - lib/new_relic/recipes/capistrano_legacy.rb
 - lib/new_relic/supportability_helper.rb
+- lib/new_relic/traced_thread.rb
 - lib/new_relic/version.rb
 - lib/newrelic_rpm.rb
 - lib/sequel/extensions/newrelic_instrumentation.rb
@@ -612,7 +618,10 @@ metadata:
   documentation_uri: https://docs.newrelic.com/docs/agents/ruby-agent
   source_code_uri: https://github.com/newrelic/newrelic-ruby-agent
   homepage_uri: https://newrelic.com/ruby
-post_install_message: 
+post_install_message: 'Thanks for installing the latest version of newrelic_rpm. This
+  version turns on application log forwarding by default. If you want to turn off
+  this feature, set `application_logging.forwarding.enabled: false`. For more information,
+  visit: https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-ruby'
 rdoc_options: []
 require_paths:
 - lib