newrelic_rpm 8.6.0 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a27c57733a8526d02022000c47f15de428bda5cb685078adcdb3fd73cf11eda
-  data.tar.gz: 8f51f79eb70cf8fb9ac70d2fe0d669e2f69eb64e5083291a544ed6210d64efd7
+  metadata.gz: 5346c26b9d9c2f9200860b562f1dadb5e79e3eb5d8904850d015c3096cc27d5a
+  data.tar.gz: acf374f8f16b88746f6a8451255bb0c6c571fbb0a3875c967648b5a8c5286217
 SHA512:
-  metadata.gz: ff3ff2a548356d2820d90b387f41697f4ccee9e5813e18f2b82b3e77a8892f09607eac403f08c24e016c889b2f9d3892d2767985e8b513adcac174d3a8b085f2
-  data.tar.gz: 72c0a812656455286d0e3d9af0fb1c4d5c7700039617f6cf40250d31cda0adce549a144317932b65c29abce5c220a6a602d6d5b3cdb6aab1150f544a9ab6ed04
+  metadata.gz: fb227c6b6d69c8900b5693567b03cc2b4f3d95e4059953e7c45287e51892cbb9ae70e6fb9b9ad6015e5eab1b162281fcc384db07ae4367174617726fca086ad0
+  data.tar.gz: e0bca3ab2559e65d9e2f900ddf69a1882190bc7034948760f87829772cfac441f8b14a4028c441316de2126c85b9dc18bf5acafc7587f10deae7beeb7ba0f386

data/CHANGELOG.md

@@ -1,14 +1,94 @@
 # New Relic Ruby Agent Release Notes #
 
+  ## v8.7.0
+
+  * **APM logs-in-context log forwarding on by default**
+
+    Automatic application log forwarding is now enabled by default. This version of the agent will automatically send enriched application logs to New Relic. To learn more about about this feature see [here](https://docs.newrelic.com/docs/apm/new-relic-apm/getting-started/get-started-logs-context/), and additional configuration options are available [here](https://docs.newrelic.com/docs/logs/logs-context/configure-logs-context-ruby). To learn about how to toggle log ingestion on or off by account see [here](https://docs.newrelic.com/docs/logs/logs-context/disable-automatic-logging).
+
+  * **Improved async support and Thread instrumentation**
+
+    Previously, the agent was not able to record events and metrics inside Threads created inside of an already running transaction. This release includes 2 new configuration options to support multithreaded applications to automatically instrument threads. A new configuration option,`instrumentation.thread.tracing` (disabled by default), has been introduced that, when enabled, will allow the agent to insert New Relic tracing inside of all Threads created by an application. To support applications that only want some threads instrumented by New Relic, a new class is available, `NewRelic::TracedThread`, that will create a thread that includes New Relic instrumentation, see our [API documentation](https://www.rubydoc.info/gems/newrelic_rpm/NewRelic) for more details.
+
+    New configuration options included in this release:
+    | Configuration name | Default | Behavior |
+    | ----------- | ----------- |----------- |
+    | `instrumentation.thread`  | `auto` (enabled) | Allows the agent to correctly nest spans inside of an asyncronous transaction   |
+    | `instrumentation.thread.tracing` | `false` (disabled)   |  Automatically add tracing to all Threads created in the application. This may be enabled by default in a future release. |
+
+    We'd like to thank @mikeantonelli for sharing a gist with us that provided our team with an entry point for this feature.
+
+  * **Deprecate support for Ruby 2.2**
+
+    Ruby 2.2 reached end of life on March 31, 2018. The agent has deprecated support for Ruby 2.2 and will make breaking changes for this version in its next major release.
+
+  *  **Deprecate instrumentation versions with low adoption and/or versions over five years old**
+
+    This release deprecates the following instrumentation:
+    | Deprecated | Replacement |
+    | ----------- | ----------- |
+    | ActiveMerchant < 1.65.0 | ActiveMerchant >= 1.65.0 |
+    | Acts As Solr (all versions) | none |
+    | Authlogic (all versions) | none |
+    | Bunny < 2.7.0 | bunny >= 2.7.0 |
+    | Dalli < 3.2.1 | Dalli >= 3.2.1 |
+    | DataMapper (all versions) | none |
+    | Delayed Job < 4.1.0 | Delayed Job >= 4.1.0 |
+    | Excon < 0.56.0 | Excon >= 0.56.0 |
+    | Grape < 0.19.2 | Grape >= 0.19.2 |
+    | HTTPClient < 2.8.3 | HTTPClient 2.8.3 |
+    | HTTP.rb < 2.2.2 | HTTP.rb >= 2.2.2 |
+    | Mongo < 2.4.1 | Mongo >= 2.4.1 |
+    | Padrino < 0.15.0 | Padrino >= 0.15.0 |
+    | Passenger < 5.1.3 | Passenger >= 5.1.3 |
+    | Puma < 3.9.0 | Puma >= 3.9.0 |
+    | Rack < 1.6.8 | Rack >= 1.6.8 |
+    | Rails 3.2.x | Rails >= 4.x |
+    | Rainbows (all versions) | none |
+    | Sequel < 4.45.0 | Sequel >= 4.45.0 |
+    | Sidekiq < 5.0.0 | Sidekiq >= 5.0.0 |
+    | Sinatra < 2.0.0 | Sinatra >= 2.0.0 |
+    | Sunspot (all versions) | none |
+    | Typhoeus < 1.3.0 | Typhoeus >= 1.3.0 |
+    | Unicorn < 5.3.0 | Unicorn >= 5.3.0 |
+
+    For the gems with deprecated versions, we will no longer test those versions in our multiverse suite. They may, however, still be compatible with the agent. We will no longer fix bug reports for issues related to these gem versions.
+
+  * **Clarify documentation for `rake.tasks` configuration**
+
+    The `rake.tasks` description in the default `newrelic.yml` file and the [New Relic Ruby Agent Configuration docs](https://docs.newrelic.com/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration#rake-tasks) have been updated to clarify its behavior and usage. The documentation now reads:
+
+    > 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].
+
+    We thank @robotfelix for suggesting these changes.
+
+  * **Internally leverage `Object.const_get` and `Object.const_defined?`**
+
+    When dynamically checking for or obtaining a handle to a class constant from a string, leverage the `Object` class's built in methods wherever possible to enjoy simpler, more performant operations. All JRubies and CRubies v2.5 and below need a bit of assistance beyond what `Object` can provide given that those Rubies may yield an unwanted constant from a different namespace than the one that was specified. But for all other Rubies and even for those Rubies in contexts where we can 100% trust the string value coming in, leverage the `Object` class's methods and reap the benefits.
+
+  * **Enable Environment Variables setting Array configurations to be converted to Arrays**
+
+    Prior to this change, when comma-separated lists were passed as environment variables, an error would be emitted to the `newrelic_agent.log` and a String would be set as the value. Now, Arrays will be accurately coerced.
+
+  * **Bugfix: Allow TransactionEvents to be sampled at the expected rate**
+
+    The `transaction_events.max_samples_stored` capacity value within the TransactionEventAggregator did not match up with its expected harvest cycle interval, causing TransactionEvents to be over-sampled. This bugfix builds upon the updates made in [#952](https://github.com/newrelic/newrelic-ruby-agent/pull/952) so that the interval and capacity behave as expected for the renamed `transaction_events*` configuration options.
+
+  * **Bugfix: Error events missing attributes when created outside of a transaction**
+
+    Previously the agent was not assigning a priority to error events that were created by calling notice_error outside the scope of a transaction. This caused issues with sampling when the error event buffer was full, resulting in a `NoMethodError: undefined method '<' for nil:NilClass` in the newrelic_agent.log. This bugfix ensures that a priority is always assigned on error events so that the agent will be able to sample these error events correctly. Thank you to @olleolleolle for bringing this issue to our attention.
+    
+
+
   ## v8.6.0
 
-* **Telemetry-in-Context: Automatic Application Logs, a quick way to view logs no matter where you are in the platform**
+  * **Telemetry-in-Context: Automatic Application Logs, a quick way to view logs no matter where you are in the platform**
 
     - Adds support for forwarding application logs to New Relic. This automatically sends application logs that have been enriched to power Telemetry-in-Context. This is disabled by default in this release. This may be on by default in a future release.
     - Adds support for enriching application logs written to disk or standard out. This can be used with another log forwarder to power Telemetry-in-Context if in-agent log forwarding is not desired. We recommend enabling either log forwarding or local log decorating, but not both features. This is disabled by default in this release.
     - Improves speed and Resque support for logging metrics which shows the rate of log message by severity in the Logs chart in the APM Summary view. This is enabled by default in this release.
 
-    To learn more about Telemetry-in-Context and the configuration options please see the documentation [here](https://docs.newrelic.com/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration/).  
+    To learn more about Telemetry-in-Context and the configuration options please see the documentation [here](https://docs.newrelic.com/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration/).
 
   * **Improve the usage of the 'hostname' executable and other executables**
 
@@ -25,7 +105,7 @@
   * **Bugfix: Curb - satify method_with_tracing's verb argument requirement**
 
     When Curb instrumentation is used (either via prepend or chain), be sure to always pass the verb argument over to `method_with_tracing` which requires it. Thank you to @knarewski for bringing this issue to our attention, for providing a means of reproducing an error, and for providing a fix. That fix has been replicated by the agent team with permission. See [Issue 1033](https://github.com/newrelic/newrelic-ruby-agent/issues/1033) for more details.
-  
+
 
   ## v8.5.0
 

data/README.md

@@ -1,4 +1,4 @@
-[![Community Plus header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
+[![Blue banner - Community Plus: This code is currently maintained by New Relic engineering teams and delivered here in GitHub. See the README for troubleshooting and defect reporting instructions.](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
 
 # New Relic Ruby Agent
 

data/Rakefile

@@ -65,7 +65,7 @@ task :record_build, [:build_number, :stage] do |t, args|
   build_string = args.build_number
   build_string << ".#{args.stage}" unless args.stage.nil? || args.stage.empty?
 
-  gitsha = File.exists?(".git") ? `git rev-parse HEAD` : "Unknown"
+  gitsha = File.exist?(".git") ? `git rev-parse HEAD` : "Unknown"
   gitsha.chomp!
 
   File.open("lib/new_relic/build.rb", "w") do |f|

data/docker-compose.yml

@@ -53,7 +53,7 @@ services:
     build:
       context: .
       args:
-        - ruby_version=${RUBY_VERSION}
+        - ruby_version=${RUBY_VERSION:-3.1}
     image: newrelic_rpm
     tty: true
     stdin_open: true

data/lib/new_relic/agent/agent.rb

@@ -9,6 +9,7 @@ require 'logger'
 require 'zlib'
 require 'stringio'
 require 'new_relic/constants'
+require 'new_relic/traced_thread'
 require 'new_relic/coerce'
 require 'new_relic/agent/autostart'
 require 'new_relic/agent/harvester'
@@ -459,6 +460,7 @@ module NewRelic
           # requests, we need to wait until the children are forked
           # before connecting, otherwise the parent process sends useless data
           def using_forking_dispatcher?
+            # TODO: MAJOR VERSION - remove :rainbows
             if [:puma, :passenger, :rainbows, :unicorn].include? Agent.config[:dispatcher]
               ::NewRelic::Agent.logger.info "Deferring startup of agent reporting thread because #{Agent.config[:dispatcher]} may fork."
               true
@@ -608,7 +610,7 @@ module NewRelic
             :"#{interval}_second_harvest"
           end
 
-          ANALYTIC_EVENT_DATA = "analytic_event_data".freeze
+          TRANSACTION_EVENT_DATA = "transaction_event_data".freeze
           CUSTOM_EVENT_DATA = "custom_event_data".freeze
           ERROR_EVENT_DATA = "error_event_data".freeze
           SPAN_EVENT_DATA = "span_event_data".freeze
@@ -623,7 +625,7 @@ module NewRelic
               transmit_data
             end
 
-            @event_loop.on(interval_for ANALYTIC_EVENT_DATA) do
+            @event_loop.on(interval_for TRANSACTION_EVENT_DATA) do
               transmit_analytic_event_data
             end
             @event_loop.on(interval_for CUSTOM_EVENT_DATA) do
@@ -638,6 +640,7 @@ module NewRelic
             @event_loop.on(interval_for LOG_EVENT_DATA) do
               transmit_log_event_data
             end
+
             @event_loop.on(:reset_log_once_keys) do
               ::NewRelic::Agent.logger.clear_already_logged
             end

data/lib/new_relic/agent/autostart.rb

@@ -31,10 +31,19 @@ module NewRelic
       COMMA = ",".freeze
 
       def denylisted_constants?
-        constants = NewRelic::Agent.config[:'autostart.denylisted_constants']
-
-        denylisted?(constants) do |name|
-          constant_is_defined?(name)
+        denylisted?(NewRelic::Agent.config[:'autostart.denylisted_constants']) do |name|
+          if RUBY_PLATFORM.eql?('java')
+            # As of JRuby 9.3.4.0, Object.const_defined? will still cross
+            # namespaces to find constants, which is not what we want. This
+            # behavior is similar to CRuby's Object.const_get prior to v2.6.
+            #
+            # Example:
+            #  irb> class MyClass; end; module MyModule; end
+            #  irb> Object.const_defined?('MyModule::MyClass') # => true
+            !!::NewRelic::LanguageSupport.constantize(name)
+          else
+            Object.const_defined?(name)
+          end
         end
       end
 
@@ -44,12 +53,6 @@ module NewRelic
         end
       end
 
-      # Lookup whether namespaced constants (e.g. ::Foo::Bar::Baz) are in the
-      # environment.
-      def constant_is_defined?(const_name)
-        !!::NewRelic::LanguageSupport.constantize(const_name)
-      end
-
       def denylisted?(value, &block)
         value.split(/\s*,\s*/).any?(&block)
       end