newrelic_rpm 8.11.0 → 8.12.0

data/lib/tasks/helpers/format.rb

@@ -25,6 +25,7 @@ module Format
     sections = Hash.new { |hash, key| hash[key] = [] }
     NewRelic::Agent::Configuration::DEFAULTS.each do |key, value|
       next unless value[:public]
+
       key = key.to_s
       section_key = section_key(key, key.split('.'))
       sections[section_key] << format_sections(key, value)
@@ -55,6 +56,7 @@ module Format
 
   def format_default_value(spec)
     return spec[:documentation_default] if !spec[:documentation_default].nil?
+
     if spec[:default].is_a?(Proc)
       '(Dynamic)'
     else
@@ -71,6 +73,7 @@ module Format
 
   def format_env_var(key)
     return "None" if NON_ENV_CONFIGS.include?(key)
+
     "NEW_RELIC_#{key.tr(".", "_").upcase}"
   end
 

data/lib/tasks/instrumentation_generator/instrumentation.thor

@@ -11,6 +11,7 @@ class Instrumentation < Thor
   INSTRUMENTATION_ROOT = 'lib/new_relic/agent/instrumentation/'
   MULTIVERSE_SUITE_ROOT = 'test/multiverse/suites/'
   DEFAULT_SOURCE_LOCATION = 'lib/new_relic/agent/configuration/default_source.rb'
+  NEWRELIC_YML_LOCATION = 'newrelic.yml'
 
   desc('scaffold NAME', 'Scaffold the required files for adding new instrumentation')
   long_desc <<-LONGDESC
@@ -37,7 +38,8 @@ class Instrumentation < Thor
 
     empty_directory(base_path)
     create_instrumentation_files(base_path)
-    create_configuration(name)
+    append_to_default_source(name)
+    append_to_newrelic_yml(name)
     create_tests(name)
   end
 
@@ -76,7 +78,7 @@ class Instrumentation < Thor
     template('templates/newrelic.yml.tt', "#{base_path}/config/newrelic.yml")
   end
 
-  def create_configuration(name)
+  def append_to_default_source(name)
     insert_into_file(
       DEFAULT_SOURCE_LOCATION,
       config_block(name.downcase),
@@ -85,18 +87,38 @@ class Instrumentation < Thor
     )
   end
 
-  def config_block(library)
+  def append_to_newrelic_yml(name)
+    insert_into_file(
+      NEWRELIC_YML_LOCATION,
+      yaml_block(name),
+      after: "# instrumentation.bunny: auto\n"
+    )
+  end
+
+  def config_block(name)
     <<-CONFIG
-        :'instrumentation.#{library}' => {
+        :'instrumentation.#{name.downcase}' => {
           :default => 'auto',
           :public => true,
           :type => String,
           :dynamic_name => true,
           :allowed_from_server => false,
-          :description => 'Controls auto-instrumentation of the #{library} library at start up. May be one of [auto|prepend|chain|disabled].'
+          :description => 'Controls auto-instrumentation of the #{name} library at start up. May be one of [auto|prepend|chain|disabled].'
         },
     CONFIG
   end
+
+  # TODO: OLD RUBIES - RUBY_VERSION 2.2
+  # When we only support 2.3+ this can be changed to a sqiggle heredoc (<<~)
+  # and use standard indentation
+  def yaml_block(name)
+<<HEREDOC # rubocop:disable Layout/IndentationWidth
+
+  # Controls auto-instrumentation of #{name} at start up.
+  # May be one of [auto|prepend|chain|disabled]
+  # instrumentation.#{name.downcase}: auto
+HEREDOC
+  end
 end
 
 Instrumentation.start(ARGV)

data/lib/tasks/instrumentation_generator/templates/chain.tt

@@ -9,9 +9,10 @@ module NewRelic::Agent::Instrumentation
         include NewRelic::Agent::Instrumentation::<%= @class_name %>
 
         alias_method(:<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>)
+        alias_method(:<%= @method.downcase %>, :<%= @method.downcase %>_with_new_relic)
 
         def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-          <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> do
+          <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> do
             <%= @method.downcase %>_without_new_relic<%= "(#{@args})" unless @args.empty? %>
           end
         end

data/lib/tasks/instrumentation_generator/templates/chain_method.tt

@@ -1,7 +1,8 @@
-alias_method :<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>
+alias_method(:<%= @method.downcase %>_without_new_relic, :<%= @method.downcase %>)
+alias_method(:<%= @method.downcase %>, :<%= @method.downcase %>_with_new_relic)
 
 def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-  <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> do
+  <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> do
     <%= @method.downcase %>_without_new_relic<%= "(#{@args})" unless @args.empty? %>
   end
 end

data/lib/tasks/instrumentation_generator/templates/instrumentation.tt

@@ -5,8 +5,9 @@
 module NewRelic::Agent::Instrumentation
   module <%= @class_name %>
 
-    def <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %>
+    def <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %>
       # add instrumentation content here
+      yield
     end
   end
 end

data/lib/tasks/instrumentation_generator/templates/instrumentation_method.tt

@@ -1,3 +1,3 @@
-def <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %>
+def <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %>
   # add instrumentation content here
 end

data/lib/tasks/instrumentation_generator/templates/prepend.tt

@@ -7,7 +7,7 @@ module NewRelic::Agent::Instrumentation
     include NewRelic::Agent::Instrumentation::<%= @class_name %>
 
     def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-      <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> { super }
+      <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> { super }
     end
   end
 end

data/lib/tasks/instrumentation_generator/templates/prepend_method.tt

@@ -1,3 +1,3 @@
 def <%= @method.downcase %><%= "(#{@args})" unless @args.empty? %>
-  <%= @method.downcase %>_with_tracing<%= "(#{@args})" unless @args.empty? %> { super }
+  <%= @method.downcase %>_with_new_relic<%= "(#{@args})" unless @args.empty? %> { super }
 end

data/lib/tasks/instrumentation_generator/templates/test.tt

@@ -11,5 +11,5 @@ class <%= @class_name %>InstrumentationTest < Minitest::Test
     NewRelic::Agent.instance.stats_engine.clear_stats
   end
 
-  # Add tests Here
+  # Add tests here
 end

data/newrelic.yml

@@ -145,7 +145,7 @@ common: &default_settings
 
   # Specify a maximum number of custom Insights events to buffer in memory at a
   # time.
-  # custom_insights_events.max_samples_stored: 1000
+  # custom_insights_events.max_samples_stored: 3000
 
   # If false, the agent will not add database_name parameter to transaction or #
   # slow sql traces.
@@ -271,7 +271,7 @@ common: &default_settings
 
   # Forces the exit handler that sends all cached data to collector before
   # shutting down to be installed regardless of detecting scenarios where it
-  # generally should bot be. Known use-case for this option is where Sinatra is
+  # generally should not be. Known use-case for this option is where Sinatra is
   # running as an embedded service within another framework and the agent is
   # detecting the Sinatra app and skipping the at_exit handler as a result.
   # Sinatra classically runs the entire application in an at_exit block and would
@@ -322,6 +322,10 @@ common: &default_settings
   # May be one of [auto|prepend|chain|disabled].
   # instrumentation.delayed_job: auto
 
+  # 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|disabled].
   # instrumentation.excon: auto
@@ -434,7 +438,7 @@ common: &default_settings
   # instrumentation.grpc.host_denylist: ""
 
   # 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
+  # from this agent. May also be expressed as a semicolon-delimited ; string of
   # colon-separated : pairs.
   # For example,<var>Server</var>:<var>One</var>;<var>Data Center</var>:<var>Primary</var>.
   # labels: ""
@@ -459,6 +463,12 @@ common: &default_settings
   # If true, the agent obfuscates Mongo queries in transaction traces.
   # mongo.obfuscate_queries: true
 
+  # If true, the agent captures Elasticsearch queries in transaction traces.
+  # elasticsearch.capture_queries: true
+
+  # If true, the agent obfuscates Elasticsearch queries in transaction traces.
+  # elasticsearch.obfuscate_queries: true
+
   # When true, the agent transmits data about your app to the New Relic collector.
   # monitor_mode: true
 

data/newrelic_rpm.gemspec

@@ -54,11 +54,11 @@ https://github.com/newrelic/newrelic-ruby-agent/
   s.add_development_dependency 'mocha', '~> 1.14.0'
   s.add_development_dependency 'pry' unless ENV['CI']
   s.add_development_dependency 'rake', '12.3.3'
-  s.add_development_dependency 'rubocop' if RUBY_VERSION > '2.5.0'
-  s.add_development_dependency 'rubocop-minitest' if RUBY_VERSION > '2.5.0'
-  s.add_development_dependency 'rubocop-performance' if RUBY_VERSION > '2.5.0'
-  s.add_development_dependency 'rubocop-rake' if RUBY_VERSION > '2.5.0'
+  s.add_development_dependency 'rubocop' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
+  s.add_development_dependency 'rubocop-minitest' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
+  s.add_development_dependency 'rubocop-performance' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
+  s.add_development_dependency 'rubocop-rake' unless ENV['CI'] && RUBY_VERSION < '3.0.0'
   s.add_development_dependency 'simplecov' if RUBY_VERSION >= '2.7.0'
-  s.add_development_dependency 'thor'
-  s.add_development_dependency 'yard'
+  s.add_development_dependency 'thor' unless ENV['CI']
+  s.add_development_dependency 'yard', "#{RUBY_VERSION < '2.3.0' ? '0.9.26' : '> 0.9.26'}"
 end

data/test/agent_helper.rb

@@ -411,6 +411,7 @@ end
 def build_deferred_error_attributes(segment)
   return unless segment.noticed_error
   return if segment.noticed_error_attributes.frozen?
+
   segment.noticed_error.build_error_attributes
 end
 
@@ -454,6 +455,7 @@ end
 
 def last_transaction_trace
   return unless last_sample = NewRelic::Agent.agent.transaction_sampler.last_sample
+
   NewRelic::Agent::Transaction::TraceBuilder.build_trace(last_sample)
 end
 
@@ -639,6 +641,7 @@ def constant_path(name, opts = {})
     if !path.last.constants.include?(part.to_sym)
       return allow_partial ? path : nil
     end
+
     path << path.last.const_get(part)
   end
   path
@@ -655,6 +658,7 @@ def undefine_constant(constant_symbol)
   parent = get_parent(const_str)
   const_name = const_str.gsub(/.*::/, '')
   return yield unless parent && parent.constants.include?(const_name.to_sym)
+
   removed_constant = parent.send(:remove_const, const_name)
   yield
 ensure
@@ -929,6 +933,7 @@ def mock_http_response(headers, wrap_it = true)
     net_http_resp.add_field(key.to_s, value)
   end
   return net_http_resp unless wrap_it
+
   NewRelic::Agent::HTTPClients::NetHTTPResponse.new(net_http_resp)
 end
 
@@ -974,6 +979,7 @@ def refute_raises(*exp)
   rescue MiniTest::Skip => e
     puts "SKIP REPORTS: #{e.inspect}"
     return e if exp.include?(MiniTest::Skip)
+
     raise e
   rescue Exception => e
     puts "EXCEPTION RAISED: #{e.inspect}\n#{e.backtrace}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_rpm
 version: !ruby/object:Gem::Version
-  version: 8.11.0
+  version: 8.12.0
 platform: ruby
 authors:
 - Tanna McClure
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,62 +83,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 12.3.3
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -153,34 +97,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.26
 description: |
   New Relic is a performance management system, developed by New Relic,
   Inc (http://www.newrelic.com).  New Relic provides you with deep
@@ -272,7 +202,7 @@ files:
 - lib/new_relic/agent/datastores/mongo.rb
 - lib/new_relic/agent/datastores/mongo/event_formatter.rb
 - lib/new_relic/agent/datastores/mongo/metric_translator.rb
-- lib/new_relic/agent/datastores/mongo/obfuscator.rb
+- lib/new_relic/agent/datastores/nosql_obfuscator.rb
 - lib/new_relic/agent/datastores/redis.rb
 - lib/new_relic/agent/deprecator.rb
 - lib/new_relic/agent/distributed_tracing.rb
@@ -339,6 +269,10 @@ files:
 - lib/new_relic/agent/instrumentation/delayed_job/instrumentation.rb
 - lib/new_relic/agent/instrumentation/delayed_job/prepend.rb
 - lib/new_relic/agent/instrumentation/delayed_job_instrumentation.rb
+- lib/new_relic/agent/instrumentation/elasticsearch.rb
+- lib/new_relic/agent/instrumentation/elasticsearch/chain.rb
+- lib/new_relic/agent/instrumentation/elasticsearch/instrumentation.rb
+- lib/new_relic/agent/instrumentation/elasticsearch/prepend.rb
 - lib/new_relic/agent/instrumentation/excon.rb
 - lib/new_relic/agent/instrumentation/excon/middleware.rb
 - lib/new_relic/agent/instrumentation/grape.rb

data/lib/new_relic/agent/datastores/mongo/obfuscator.rb

@@ -1,43 +0,0 @@
-# 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
-  module Agent
-    module Datastores
-      module Mongo
-        module Obfuscator
-          ALLOWLIST = [:operation].freeze
-
-          def self.obfuscate_statement(source, allowlist = ALLOWLIST)
-            if source.is_a?(Hash)
-              obfuscated = {}
-              source.each do |key, value|
-                if allowlist.include?(key)
-                  obfuscated[key] = value
-                else
-                  obfuscated[key] = obfuscate_value(value, allowlist)
-                end
-              end
-              obfuscated
-            else
-              obfuscate_value(source, allowlist)
-            end
-          end
-
-          QUESTION_MARK = '?'.freeze
-
-          def self.obfuscate_value(value, allowlist = ALLOWLIST)
-            if value.is_a?(Hash)
-              obfuscate_statement(value, allowlist)
-            elsif value.is_a?(Array)
-              value.map { |v| obfuscate_value(v, allowlist) }
-            else
-              QUESTION_MARK
-            end
-          end
-        end
-      end
-    end
-  end
-end