newrelic_rpm 9.3.0 → 9.4.0

data/lib/new_relic/agent/transaction.rb

@@ -31,11 +31,12 @@ module NewRelic
       RAKE_PREFIX = "#{OTHER_TRANSACTION_PREFIX}Rake/"
       MESSAGE_PREFIX = "#{OTHER_TRANSACTION_PREFIX}Message/"
       RACK_PREFIX = "#{CONTROLLER_PREFIX}Rack/"
+      RODA_PREFIX = "#{CONTROLLER_PREFIX}Roda/"
       SINATRA_PREFIX = "#{CONTROLLER_PREFIX}Sinatra/"
       GRAPE_PREFIX = "#{CONTROLLER_PREFIX}Grape/"
       ACTION_CABLE_PREFIX = "#{CONTROLLER_PREFIX}ActionCable/"
 
-      WEB_TRANSACTION_CATEGORIES = [:web, :controller, :uri, :rack, :sinatra, :grape, :middleware, :action_cable].freeze
+      WEB_TRANSACTION_CATEGORIES = %i[action_cable controller grape middleware rack roda sinatra web uri].freeze
 
       MIDDLEWARE_SUMMARY_METRICS = ['Middleware/all'].freeze
       WEB_SUMMARY_METRIC = 'HttpDispatcher'
@@ -289,7 +290,7 @@ module NewRelic
       end
 
       def sampled?
-        return unless Agent.config[:'distributed_tracing.enabled']
+        return false unless Agent.config[:'distributed_tracing.enabled']
 
         if @sampled.nil?
           @sampled = NewRelic::Agent.instance.adaptive_sampler.sampled?
@@ -545,8 +546,8 @@ module NewRelic
       end
 
       def user_defined_rules_ignore?
-        return unless request_path
-        return if (rules = NewRelic::Agent.config[:"rules.ignore_url_regexes"]).empty?
+        return false unless request_path
+        return false if (rules = NewRelic::Agent.config[:"rules.ignore_url_regexes"]).empty?
 
         rules.any? do |rule|
           request_path.match(rule)

data/lib/new_relic/agent/utilization/vendor.rb

@@ -75,14 +75,12 @@ module NewRelic
           processed_headers = headers
           raise if processed_headers.value?(:error)
 
-          Timeout.timeout(1) do
-            response = nil
-            Net::HTTP.start(endpoint.host, endpoint.port) do |http|
-              req = Net::HTTP::Get.new(endpoint, processed_headers)
-              response = http.request(req)
-            end
-            response
+          response = nil
+          Net::HTTP.start(endpoint.host, endpoint.port, open_timeout: 1, read_timeout: 1) do |http|
+            req = Net::HTTP::Get.new(endpoint, processed_headers)
+            response = http.request(req)
           end
+          response
         rescue
           NewRelic::Agent.logger.debug("#{vendor_name} environment not detected")
         end

data/lib/new_relic/agent.rb

@@ -298,7 +298,7 @@ module NewRelic
 
     # Set a callback proc for determining an error's error group name
     #
-    # @param [Proc] the callback proc
+    # @param callback_proc [Proc] the callback proc
     #
     # Typically this method should be called only once to set a callback for
     # use with all noticed errors. If it is called multiple times, each new

data/lib/new_relic/cli/command.rb

@@ -60,6 +60,7 @@ module NewRelic
         extra = []
         options = ARGV.options do |opts|
           script_name = File.basename($0)
+          # TODO: MAJOR VERSION - remove newrelic_cmd, deprecated since version 2.13
           if /newrelic_cmd$/.match?(script_name)
             $stdout.puts "warning: the 'newrelic_cmd' script has been renamed 'newrelic'"
             script_name = 'newrelic'

data/lib/new_relic/control/class_methods.rb

@@ -49,19 +49,13 @@ module NewRelic
           # maybe it is already loaded by some external system
           # i.e. rpm_contrib or user extensions?
         end
-        NewRelic::Control::Frameworks.const_get(camelize(framework.to_s))
+        NewRelic::Control::Frameworks.const_get(NewRelic::LanguageSupport.camelize(framework.to_s))
       end
 
       # The root directory for the plugin or gem
       def newrelic_root
         File.expand_path(File.join('..', '..', '..', '..'), __FILE__)
       end
-
-      def camelize(snake_case_name)
-        snake_case_name.gsub(/(\_|^)[a-z]/) do |substring|
-          substring[-1].capitalize!
-        end
-      end
     end
     extend ClassMethods
   end

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

@@ -0,0 +1,20 @@
+# 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
+
+require 'new_relic/control/frameworks/ruby'
+module NewRelic
+  class Control
+    module Frameworks
+      # Contains basic control logic for Roda
+      class Roda < NewRelic::Control::Frameworks::Ruby
+        protected
+
+        def install_shim
+          super
+          ::Roda.class_eval { include NewRelic::Agent::Instrumentation::ControllerInstrumentation::Shim }
+        end
+      end
+    end
+  end
+end

data/lib/new_relic/language_support.rb

@@ -78,6 +78,11 @@ module NewRelic
       camelized.split(/\-|\_/).map(&:capitalize).join
     end
 
+    def camelize_with_first_letter_downcased(string)
+      camelized = camelize(string)
+      camelized[0].downcase.concat(camelized[1..-1])
+    end
+
     def bundled_gem?(gem_name)
       defined?(Bundler) && Bundler.rubygems.all_specs.map(&:name).include?(gem_name)
     rescue => e

data/lib/new_relic/noticed_error.rb

@@ -13,7 +13,7 @@ class NewRelic::NoticedError
   attr_accessor :path, :timestamp, :message, :exception_class_name,
     :request_uri, :request_port, :file_name, :line_number,
     :stack_trace, :attributes_from_notice_error, :attributes,
-    :expected
+    :expected, :transaction_id
 
   attr_reader :error_group, :exception_id, :is_internal
 
@@ -45,6 +45,7 @@ class NewRelic::NoticedError
     @is_internal = (exception.class < NewRelic::Agent::InternalAgentError)
 
     extract_class_name_and_message_from(exception)
+    @transaction_id = NewRelic::Agent::Tracer&.current_transaction&.guid
 
     # clamp long messages to 4k so that we don't send a lot of
     # overhead across the wire
@@ -79,11 +80,13 @@ class NewRelic::NoticedError
   include NewRelic::Coerce
 
   def to_collector_array(encoder = nil)
-    [NewRelic::Helper.time_to_millis(timestamp),
+    arr = [NewRelic::Helper.time_to_millis(timestamp),
       string(path),
       string(message),
       string(exception_class_name),
       processed_attributes]
+    arr << @transaction_id if @transaction_id
+    arr
   end
 
   # Note that we process attributes lazily and store the result. This is because

data/lib/new_relic/rack/browser_monitoring.rb

@@ -143,7 +143,7 @@ module NewRelic
       end
 
       # Per "The Response > The Body" section of Rack spec, we should close
-      # if our response is able. http://rack.rubyforge.org/doc/SPEC.html
+      # if our response is able. https://github.com/rack/rack/blob/main/SPEC.rdoc
       def close_old_response(response)
         response.close if response.respond_to?(:close)
       end

data/lib/new_relic/version.rb

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

data/lib/tasks/bump_version.rake

@@ -2,7 +2,7 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-require_relative './helpers/version_bump'
+require_relative 'helpers/version_bump'
 
 namespace :newrelic do
   namespace :version do

data/lib/tasks/config.rake

@@ -21,12 +21,13 @@ namespace :newrelic do
       '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.",
+      'application_logging' => "The Ruby agent supports [APM logs in context](/docs/apm/new-relic-apm/getting-started/get-started-logs-context). For some tips on configuring logs for the Ruby agent, see [Configure Ruby logs in context](/docs/logs/logs-context/configure-logs-context-ruby).\n\nAvailable logging-related config options include:",
       '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',
-      'custom_insights_events' => 'Custom Events'
+      'slow_sql' => 'Slow SQL [#slow-sql]',
+      'custom_insights_events' => 'Custom Events [#custom-events]'
     }
 
     desc 'Describe available New Relic configuration settings'

data/lib/tasks/helpers/config.html.erb

@@ -1,3 +1,96 @@
+---
+title: Ruby agent configuration
+tags:
+  - Agents
+  - Ruby agent
+  - Configuration
+metaDescription: 'APM for Ruby: how to configure the Ruby agent, including editing the config file and setting environment variables.'
+redirects:
+  - /docs/agents/ruby-agent/configuration/ruby-agent-configuration
+  - /docs/ruby/ruby-agent-configuration
+  - /docs/agents/ruby-agent/installation-and-configuration/ruby-agent-configuration
+  - /docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration
+---
+
+<CONTRIBUTOR_NOTE>
+  This file is automatically generated from values defined in `lib/new_relic/agent/configuration/default_source.rb`.
+  All changes should be made directly to `default_source.rb.`
+  Submit PRs or raise issues at: https://github.com/newrelic/newrelic-ruby-agent
+</CONTRIBUTOR_NOTE>
+
+You can configure the New Relic Ruby agent with settings in a configuration file, environment variables, or programmatically with server-side configuration. This document summarizes the configuration options available for the Ruby agent.
+
+If the default value for a configuration option is `(Dynamic)`, this means the Ruby agent calculates the default at runtime. The value for the config setting defaults to the value of another setting as appropriate.
+
+## Configuration methods and precedence [#Options]
+
+The primary (default) method to configure the Ruby agent is via the configuration file (`newrelic.yml`) in the `config` subdirectory. To set configuration values using environment variables:
+
+1. Add the prefix `NEW_RELIC_` to the setting's name.
+2. Replace any periods `.` with underscores `_`.
+
+You can also configure a few values in the UI via [server-side configuration](/docs/agents/manage-apm-agents/configuration/server-side-agent-configuration).
+
+The Ruby agent follows this order of precedence for configuration:
+
+1. Environment variables
+2. Server-side configuration
+3. Configuration file (`newrelic.yml`)
+4. Default configuration settings
+
+In other words, environment variables override all other configuration settings and info, server-side configuration overrides the configuration file and default config settings, and so on.
+
+## View and edit config file options [#Edit]
+
+The Ruby agent's `newrelic.yml` is a standard YAML configuration file. It typically includes a `Defaults` section at the top, plus sections below for each application environment; for example, `Development`, `Testing`, and `Production`.
+
+The Ruby agent determines which section of the `newrelic.yml` config file to read from by looking at certain environment variables to derive the application's environment. This can be useful, for example, when you want to use `info` for the `log_level` config setting in your production environment, and you want more verbose `log_level` config settings (such as `debug` in your development environment.
+
+Here is an example `newrelic.yml` config file:
+
+```yaml
+common: &default_settings
+  license_key: 'YOUR_LICENSE_KEY'
+  app_name: 'My Application Name'
+production:
+  <<: *default_settings
+  log_level: info
+development:
+  <<: *default_settings
+  log_level: debug
+```
+
+For non-Rails apps, the Ruby agent looks for the following environment variables, in this order, to determine the application environment:
+
+1. `NEW_RELIC_ENV`
+2. `RUBY_ENV`
+3. `RAILS_ENV`
+4. `APP_ENV`
+5. `RACK_ENV`
+
+If the Ruby agent does not detect values for any of those environment variables, it will default the application environment to `development` and read from the `development` section of the `newrelic.yml` config file.
+
+When running the Ruby agent in a Rails app, the agent first looks for the `NEW_RELIC_ENV` environment variable to determine the application environment and which section of the `newrelic.yml` to use. If `NEW_RELIC_ENV` is not present, the agent uses the Rails environment (`RAILS_ENV` or `RAILS.env`, depending on the version of Rails) .
+
+When you edit the config file, be sure to:
+
+* Indent only with two spaces.
+* Indent only where relevant, in stanzas such as **`error_collector`**.
+
+If you do not indent correctly, the agent may throw an `Unable to parse configuration file` error on startup.
+
+To view the most current list of available Ruby agent configuration options, use the `rake newrelic:config:docs` command. This document describes the most common options.
+
+## Update the config file [#Updates]
+
+This documentation applies to the Ruby agent's latest release. For details on earlier versions, refer to the comments in `newrelic.yml` itself.
+
+To update `newrelic.yml` file after a new release, use the template in the base directory of the agent gem. When you update to new gem versions, examine or diff `config/newrelic.yml` and `newrelic.yml` in the [installation directory](/docs/agents/manage-apm-agents/troubleshooting/find-agent-root-directory#ruby-agent) to take advantage of new configuration options.
+
+<Callout variant="important">
+  Updating the gem does not automatically update `config/newrelic.yml`.
+</Callout>
+
 <% sections.each do |(section_key, section_name, section_description, configs)| %>
 ## <%=section_name%>
 

data/lib/tasks/helpers/format.rb

@@ -3,16 +3,19 @@
 # frozen_string_literal: true
 
 module Format
-  def output(format)
-    config_hash = build_config_hash
-    sections = flatten_config_hash(config_hash)
+  DEFAULT_CONFIG_PATH = 'ruby-agent-configuration.mdx'
 
-    puts build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('.  ', '. ')
-    sections # silences unused warning to return this
+  def output(format)
+    result = build_erb(format).result(binding).split("\n").map(&:rstrip).join("\n").gsub('.  ', '. ')
+    File.write(DEFAULT_CONFIG_PATH, result)
   end
 
   private
 
+  def sections
+    @sections ||= flatten_config_hash(build_config_hash)
+  end
+
   def add_data_to_sections(sections)
     sections.each do |section|
       section_key = section[0]
@@ -66,7 +69,7 @@ module Format
 
   def format_description(value)
     description = ''
-    description += '<b>DEPRECATED</b> ' if value[:deprecated]
+    description += '**DEPRECATED** ' if value[:deprecated]
     description += value[:description]
     description
   end
@@ -81,9 +84,10 @@ module Format
     name = NAME_OVERRIDES[key]
     return name if name
 
-    key.split('_')
+    title = key.split('_')
       .each { |fragment| fragment[0] = fragment[0].upcase }
       .join(' ')
+    "#{title} [##{key.tr('_', '-')}]"
   end
 
   def format_sections(key, value)

data/lib/tasks/helpers/version_bump.rb

@@ -55,8 +55,8 @@ module VersionBump
   # Replace dev with version number in changelog
   def self.update_changelog(version)
     file = read_file('CHANGELOG.md')
-    file.gsub!(/## dev/, "## v#{version}")
-    file.gsub!(/Version <dev>/, "Version #{version}")
+    file.gsub!('## dev', "## v#{version}")
+    file.gsub!('Version <dev>', "Version #{version}")
     write_file('CHANGELOG.md', file)
   end
 end

data/lib/tasks/newrelicyml.rake

@@ -2,7 +2,7 @@
 # See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 # frozen_string_literal: true
 
-require_relative './helpers/newrelicyml'
+require_relative 'helpers/newrelicyml'
 
 namespace :newrelic do
   desc 'Update newrelic.yml with latest config options from default_source.rb'

data/newrelic.yml

@@ -33,6 +33,9 @@ common: &default_settings
   # - a.third.event
   # active_support_custom_events_names: []
 
+  # If true, enables capture of all HTTP request headers for all destinations.
+  # allow_all_headers: false
+
   # Your New Relic userKey. Required when using the New Relic REST API v2 to record
   # deployments using the newrelic deployments command.
   # api_key: ""
@@ -222,6 +225,10 @@ common: &default_settings
   # (regardless of whether they are installed via Rack::Builder or Rails).
   # disable_middleware_instrumentation: false
 
+  # If true, disables agent middleware for Roda. This middleware is responsible for
+  # advanced feature support such as page load timing and error collection.
+  # disable_roda_auto_middleware: false
+
   # If true, disables the collection of sampler metrics. Sampler metrics are metrics
   # that are not event-based (such as CPU time or memory usage).
   # disable_samplers: false
@@ -479,6 +486,10 @@ common: &default_settings
   # prepend, chain, disabled.
   # instrumentation.resque: auto
 
+  # Controls auto-instrumentation of Roda at start up. May be one of: auto, prepend,
+  # chain, disabled.
+  # instrumentation.roda: auto
+
   # Controls auto-instrumentation of Sinatra at start up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.sinatra: auto

data/newrelic_rpm.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
     https://github.com/newrelic/newrelic-ruby-agent/
   EOS
   s.email = 'support@newrelic.com'
+  # TODO: MAJOR VERSION - remove newrelic_cmd, deprecated since version 2.13
   s.executables = %w[newrelic_cmd newrelic nrdebug]
   s.extra_rdoc_files = [
     'CHANGELOG.md',
@@ -38,13 +39,14 @@ Gem::Specification.new do |s|
     'homepage_uri' => 'https://newrelic.com/ruby'
   }
 
-  reject_list = File.read('./.build_ignore').split("\n")
+  reject_list = File.read(File.expand_path('../.build_ignore', __FILE__)).split("\n")
   file_list = `git ls-files -z`.split("\x0").reject { |f| reject_list.any? { |rf| f.start_with?(rf) } }
-  build_file_path = 'lib/new_relic/build.rb'
-  file_list << build_file_path if File.exist?(build_file_path)
+  # test/agent_helper.rb is a requirement for the NewRelic::Agent.require_test_helper public API
+  test_helper_path = 'test/agent_helper.rb'
+  file_list << test_helper_path
   s.files = file_list
 
-  s.homepage = 'https://github.com/newrelic/rpm'
+  s.homepage = 'https://github.com/newrelic/newrelic-ruby-agent'
   s.require_paths = ['lib']
   s.summary = 'New Relic Ruby Agent'
   s.add_development_dependency 'bundler'
@@ -54,9 +56,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'minitest-stub-const', '0.6'
   s.add_development_dependency 'mocha', '~> 1.16'
   s.add_development_dependency 'pry' unless ENV['CI']
+  s.add_development_dependency 'rack'
   s.add_development_dependency 'rake', '12.3.3'
 
-  s.add_development_dependency 'rubocop', '1.51' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
+  s.add_development_dependency 'rubocop', '1.54' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
   s.add_development_dependency 'rubocop-ast', '1.28.1' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
   s.add_development_dependency 'rubocop-minitest', '0.27.0' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
   s.add_development_dependency 'rubocop-performance', '1.16.0' unless ENV['CI'] && RUBY_VERSION < '3.0.0'