newrelic_rpm 9.3.0 → 9.6.0

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: ""
@@ -99,7 +102,7 @@ common: &default_settings
   # Specify a list of constants that should prevent the agent from starting
   # automatically. Separate individual constants with a comma ,. For example,
   # "Rails::Console,UninstrumentedBackgroundJob".
-  # autostart.denylisted_constants: Rails::Console
+  # autostart.denylisted_constants: Rails::Command::ConsoleCommand,Rails::Command::CredentialsCommand,Rails::Command::Db::System::ChangeCommand,Rails::Command::DbConsoleCommand,Rails::Command::DestroyCommand,Rails::Command::DevCommand,Rails::Command::EncryptedCommand,Rails::Command::GenerateCommand,Rails::Command::InitializersCommand,Rails::Command::NotesCommand,Rails::Command::RoutesCommand,Rails::Command::SecretsCommand,Rails::Console,Rails::DBConsole
 
   # Defines a comma-delimited list of executables that the agent should not
   # instrument. For example, "rake,my_ruby_script.rb".
@@ -220,8 +223,15 @@ common: &default_settings
 
   # If true, the agent won't wrap third-party middlewares in instrumentation
   # (regardless of whether they are installed via Rack::Builder or Rails).
+  # When middleware instrumentation is disabled, if an application is using
+  # middleware that could alter the response code, the HTTP status code reported on
+  # the transaction may not reflect the altered value.
   # 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
@@ -364,39 +374,51 @@ common: &default_settings
   # Configures the TCP/IP port for the trace observer Host
   # infinite_tracing.trace_observer.port: 443
 
+  # Controls auto-instrumentation of ActiveSupport::BroadcastLogger at start up. May
+  # be one of: auto, prepend, chain, disabled. Used in Rails versions >= 7.1.
+  # instrumentation.active_support_broadcast_logger: auto
+
   # Controls auto-instrumentation of ActiveSupport::Logger at start up. May be one
-  # of: auto, prepend, chain, disabled.
+  # of: auto, prepend, chain, disabled. Used in Rails versions below 7.1.
   # instrumentation.active_support_logger: auto
 
-  # Controls auto-instrumentation of bunny at start up. May be one of: auto,
+  # Controls auto-instrumentation of Async::HTTP at start up. May be one of: auto,
+  # prepend, chain, disabled.
+  # instrumentation.async_http: auto
+
+  # Controls auto-instrumentation of bunny at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.bunny: auto
 
-  # Controls auto-instrumentation of the concurrent-ruby library at start up. May be
+  # Controls auto-instrumentation of the concurrent-ruby library at start-up. May be
   # one of: auto, prepend, chain, disabled.
   # instrumentation.concurrent_ruby: auto
 
-  # Controls auto-instrumentation of Curb at start up. May be one of: auto, prepend,
+  # Controls auto-instrumentation of Curb at start-up. May be one of: auto, prepend,
   # chain, disabled.
   # instrumentation.curb: auto
 
-  # Controls auto-instrumentation of Delayed Job at start up. May be one of: auto,
+  # Controls auto-instrumentation of Delayed Job at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.delayed_job: auto
 
-  # Controls auto-instrumentation of the elasticsearch library at start up. May be
+  # Controls auto-instrumentation of the elasticsearch library at start-up. May be
   # one of: auto, prepend, chain, disabled.
   # instrumentation.elasticsearch: auto
 
-  # Controls auto-instrumentation of Excon at start up. May be one of: enabled,
+  # Controls auto-instrumentation of ethon at start up. May be one of
+  # [auto|prepend|chain|disabled]
+  # instrumentation.ethon: auto
+
+  # Controls auto-instrumentation of Excon at start-up. May be one of: enabled,
   # disabled.
   # instrumentation.excon: enabled
 
-  # Controls auto-instrumentation of the Fiber class at start up. May be one of:
+  # Controls auto-instrumentation of the Fiber class at start-up. May be one of:
   # auto, prepend, chain, disabled.
   # instrumentation.fiber: auto
 
-  # Controls auto-instrumentation of Grape at start up. May be one of: auto,
+  # Controls auto-instrumentation of Grape at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.grape: auto
 
@@ -409,43 +431,47 @@ common: &default_settings
   # example, "private.com$,exception.*"
   # instrumentation.grpc.host_denylist: []
 
-  # Controls auto-instrumentation of gRPC clients at start up. May be one of: auto,
+  # Controls auto-instrumentation of gRPC clients at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.grpc_client: auto
 
-  # Controls auto-instrumentation of gRPC servers at start up. May be one of: auto,
+  # Controls auto-instrumentation of gRPC servers at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.grpc_server: auto
 
-  # Controls auto-instrumentation of HTTPClient at start up. May be one of: auto,
+  # Controls auto-instrumentation of HTTPClient at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.httpclient: auto
 
-  # Controls auto-instrumentation of http.rb gem at start up. May be one of: auto,
+  # Controls auto-instrumentation of http.rb gem at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.httprb: auto
 
-  # Controls auto-instrumentation of Ruby standard library Logger at start up. May
+  # Controls auto-instrumentation of httpx at start up. May be one of
+  # [auto|prepend|chain|disabled]
+  # instrumentation.httpx: auto
+
+  # Controls auto-instrumentation of Ruby standard library Logger at start-up. May
   # be one of: auto, prepend, chain, disabled.
   # instrumentation.logger: auto
 
-  # Controls auto-instrumentation of dalli gem for Memcache at start up. May be one
+  # Controls auto-instrumentation of dalli gem for Memcache at start-up. May be one
   # of: auto, prepend, chain, disabled.
   # instrumentation.memcache: auto
 
-  # Controls auto-instrumentation of memcache-client gem for Memcache at start up.
+  # Controls auto-instrumentation of memcache-client gem for Memcache at start-up.
   # May be one of: auto, prepend, chain, disabled.
   # instrumentation.memcache_client: auto
 
-  # Controls auto-instrumentation of memcached gem for Memcache at start up. May be
+  # Controls auto-instrumentation of memcached gem for Memcache at start-up. May be
   # one of: auto, prepend, chain, disabled.
   # instrumentation.memcached: auto
 
-  # Controls auto-instrumentation of Mongo at start up. May be one of: enabled,
+  # Controls auto-instrumentation of Mongo at start-up. May be one of: enabled,
   # disabled.
   # instrumentation.mongo: enabled
 
-  # Controls auto-instrumentation of Net::HTTP at start up. May be one of: auto,
+  # Controls auto-instrumentation of Net::HTTP at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.net_http: auto
 
@@ -454,7 +480,7 @@ common: &default_settings
   # application startup. May be one of: auto, prepend, chain, disabled.
   # instrumentation.puma_rack: auto
 
-  # Controls auto-instrumentation of Puma::Rack::URLMap at start up. May be one of:
+  # Controls auto-instrumentation of Puma::Rack::URLMap at start-up. May be one of:
   # auto, prepend, chain, disabled.
   # instrumentation.puma_rack_urlmap: auto
 
@@ -463,41 +489,49 @@ common: &default_settings
   # startup. May be one of: auto, prepend, chain, disabled.
   # instrumentation.rack: auto
 
-  # Controls auto-instrumentation of Rack::URLMap at start up. May be one of: auto,
+  # Controls auto-instrumentation of Rack::URLMap at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.rack_urlmap: auto
 
-  # Controls auto-instrumentation of rake at start up. May be one of: auto, prepend,
+  # Controls auto-instrumentation of rake at start-up. May be one of: auto, prepend,
   # chain, disabled.
   # instrumentation.rake: auto
 
-  # Controls auto-instrumentation of Redis at start up. May be one of: auto,
+  # Controls auto-instrumentation of Redis at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.redis: auto
 
-  # Controls auto-instrumentation of resque at start up. May be one of: auto,
+  # Controls auto-instrumentation of resque at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.resque: auto
 
-  # Controls auto-instrumentation of Sinatra at start up. May be one of: 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
 
-  # Controls auto-instrumentation of the Thread class at start up to allow the agent
+  # Controls auto-instrumentation of Stripe at startup. May be one of: enabled,
+  # disabled.
+  # instrumentation.stripe: enabled
+
+  # Controls auto-instrumentation of the Thread class at start-up to allow the agent
   # to correctly nest spans inside of an asynchronous transaction. This does not
   # enable the agent to automatically trace all threads created (see
   # instrumentation.thread.tracing). May be one of: auto, prepend, chain, disabled.
   # instrumentation.thread: auto
 
-  # Controls auto-instrumentation of the Thread class at start up to automatically
+  # Controls auto-instrumentation of the Thread class at start-up to automatically
   # add tracing to all Threads created in the application.
   # instrumentation.thread.tracing: true
 
-  # Controls auto-instrumentation of the Tilt template rendering library at start
-  # up. May be one of: auto, prepend, chain, disabled.
+  # Controls auto-instrumentation of the Tilt template rendering library at
+  # start-up. May be one of: auto, prepend, chain, disabled.
   # instrumentation.tilt: auto
 
-  # Controls auto-instrumentation of Typhoeus at start up. May be one of: auto,
+  # Controls auto-instrumentation of Typhoeus at start-up. May be one of: auto,
   # prepend, chain, disabled.
   # instrumentation.typhoeus: auto
 
@@ -574,6 +608,26 @@ common: &default_settings
   # before shutting down.
   # send_data_on_exit: true
 
+  # An array of strings that will collectively serve as a denylist for filtering
+  # which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq
+  # arguments, 'job.sidekiq.args.*' must be added to the separate
+  # :'attributes.include' configuration option. Each string in this array will be
+  # turned into a regular expression via Regexp.new to permit advanced matching. For
+  # job argument hashes, if either a key or value matches the pair will be excluded.
+  # All matching job argument array elements and job argument scalars will be
+  # excluded.
+  # sidekiq.args.exclude: []
+
+  # An array of strings that will collectively serve as an allowlist for filtering
+  # which Sidekiq job arguments get reported to New Relic. To capture any Sidekiq
+  # arguments, 'job.sidekiq.args.*' must be added to the separate
+  # :'attributes.include' configuration option. Each string in this array will be
+  # turned into a regular expression via Regexp.new to permit advanced matching. For
+  # job argument hashes, if either a key or value matches the pair will be included.
+  # All matching job argument array elements and job argument scalars will be
+  # included.
+  # sidekiq.args.include: []
+
   # If true, the agent collects slow SQL queries.
   # slow_sql.enabled: true
 
@@ -623,6 +677,24 @@ common: &default_settings
   # allowlist. Enabled automatically in high security mode.
   # strip_exception_messages.enabled: false
 
+  # An array of strings to specify which keys and/or values inside a Stripe event's
+  # user_data hash should
+  # not be reported to New Relic. Each string in this array will be turned into a
+  # regular expression via
+  # Regexp.new to permit advanced matching. For each hash pair, if either the key or
+  # value is matched the
+  # pair will not be reported. By default, no user_data is reported, so this option
+  # should only be used if
+  # the stripe.user_data.include option is being used.
+  # stripe.user_data.exclude: []
+
+  # An array of strings to specify which keys inside a Stripe event's user_data hash
+  # should be reported
+  # to New Relic. Each string in this array will be turned into a regular expression
+  # via Regexp.new to
+  # permit advanced matching. Setting the value to ["."] will report all user_data.
+  # stripe.user_data.include: []
+
   # When set to true, forces a synchronous connection to the New Relic collector
   # during application startup. For very short-lived processes, this helps ensure
   # the New Relic agent has time to report.

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,25 +39,30 @@ 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_dependency 'base64'
+
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'feedjira', '3.2.1' unless ENV['CI'] || RUBY_VERSION < '2.5' # for Gabby
   s.add_development_dependency 'httparty' unless ENV['CI'] # for perf tests and Gabby
   s.add_development_dependency 'minitest', "#{RUBY_VERSION >= '2.7.0' ? '5.3.3' : '4.7.5'}"
   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 'pry' if ENV['ENABLE_PRY']
+  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'