newrelic_rpm 5.7.0.350 → 6.0.0.351

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625a0434dacaefcf0902757f00bc9da4d6076c6060599b696a582e90187fc883
-  data.tar.gz: fac2ce2e4f4d293a123c93bebbfc62093f2c02ae1580b9a1a24df3c901ad09db
+  metadata.gz: 91ab526e3b85c3d323b557163c7213681e1783c0c6ac9f29bf53dad5dd421a92
+  data.tar.gz: ba03925e985ecaf44b0b56375cb0c38532c2473cf87440c2b7f2c4fccea3d744
 SHA512:
-  metadata.gz: 579cab156bcd049477932f8411b028d83469e21aa6404a6c9a66a7e2289849a78dade9d723bd43233f3889069581217e067c951c42a5ff63f59c5f9213957072
-  data.tar.gz: 62e685079a4f023713ad7a3e520a9b7519b957b762a84dcc5857d2024a52f3180d783e12a9992b0d4696eaa636866d8bf56d1dc130a75a5b32ead180ab1a75e9
+  metadata.gz: 811d5a9f971f18d5e66a2b0826d003603b5771b8378906ee1594ec95834593f31a668e8d8084cbd84db8f0e3d367d93620ed87b86e047c31d20b115cd4c8cfb6
+  data.tar.gz: 115f4a4d0c6186546cdd6d698279e5d60b26a67d7749bd2959c44f0478f594621e78e4785a8b6508d78c986e5a19d6dcb5df145f9891eb323432141336e72845

data/.travis.yml

@@ -11,7 +11,6 @@ sudo: required
 before_install:
   # RUBY-2072 Prevent Travis setup failure before our test even starts
   - sudo rm -f /etc/apt/sources.list.d/travis_ci_zeromq3.list
-
   - gem --version
   - ./test/script/before_install/update_rubygems.sh
   - gem uninstall bundler -a -x

data/.yardopts

@@ -12,6 +12,7 @@ lib/new_relic/agent/stats_engine/metric_stats.rb
 lib/new_relic/agent/datastores.rb
 lib/new_relic/agent/messaging.rb
 lib/new_relic/agent/sql_sampler.rb
+lib/new_relic/agent/tracer.rb
 lib/new_relic/agent/transaction.rb
 lib/new_relic/agent/transaction_sampler.rb
 lib/new_relic/rack/agent_hooks.rb

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # New Relic Ruby Agent Release Notes #
 
+## v6.0.0
+
+   * Tracer API for flexible custom instrumentation
+
+     With agent version 6.0, we are introducing the `Tracer` class, an
+     officially supported public API for more flexible custom
+     instrumentation.  By calling its `in_transaction` method, you can
+     instrument an arbitrary section of Ruby code without needing to
+     juggle any explicit state.  Behind the scenes, the agent will
+     make sure that the measured code results in an APM segment inside
+     a transaction.
+
+     The same API contains additional methods for creating
+     transactions and segments, and for interacting with the current
+     transaction.  For more details, see the [custom instrumentation
+     documentation](https://docs.newrelic.com/docs/agents/ruby-agent/api-guides/ruby-custom-instrumentation).
+
+     If you were previously using any of the agent's private,
+     undocumented APIs, such as `Transaction.wrap` or
+     `Transaction.start/stop`, you will need to update your code to
+     use the Tracer API.
+
+     The full list of APIs that were removed or deprecated are:
+       * `External.start_segment`
+       * `Transaction.create_segment`
+       * `Transaction.start`
+       * `Transaction.stop`
+       * `Transaction.start_datastore_segment`
+       * `Transaction.start_segment`
+       * `Transaction.wrap`
+       * `TransactionState.current_transaction`
+
+     If are you using any of these APIs, please see the [upgrade guide](https://docs.newrelic.com/docs/agents/ruby-agent/troubleshooting/update-private-api-calls-public-tracer-api) for a list of replacements.
+
+   * Agent detects Rails 6.0
+
+     The agent properly detects Rails 6.0 and no longer logs an error when
+     started in a Rails 6.0 environment. This does not include full Rails 6.0
+     support, which will be coming in a future release. Thanks to Jacob Bednarz
+     for the contribution.
+
 ## v5.7.0
 
    * Ruby 2.6 support

data/lib/new_relic/agent.rb

@@ -487,7 +487,7 @@ module NewRelic
     # Yield to the block without collecting any metrics or traces in
     # any of the subsequent calls.  If executed recursively, will keep
     # track of the first entry point and turn on tracing again after
-    # leaving that block.  This uses the thread local TransactionState.
+    # leaving that block.  This uses the thread local Tracer::State.
     #
     # @api public
     #
@@ -544,13 +544,13 @@ module NewRelic
 
     # Check to see if we are capturing metrics currently on this thread.
     def tl_is_execution_traced?
-      NewRelic::Agent::TransactionState.tl_get.is_execution_traced?
+      NewRelic::Agent::Tracer.state.is_execution_traced?
     end
 
     # helper method to check the thread local to determine whether sql
     # is being recorded or not
     def tl_is_sql_recorded?
-      NewRelic::Agent::TransactionState.tl_get.is_sql_recorded?
+      NewRelic::Agent::Tracer.state.is_sql_recorded?
     end
 
     # @!group Adding custom attributes to traces

data/lib/new_relic/agent/agent.rb

@@ -262,7 +262,7 @@ module NewRelic
         # should not record sql in the current thread. Returns the
         # previous value, if there is one
         def set_record_sql(should_record) #THREAD_LOCAL_ACCESS
-          state = TransactionState.tl_get
+          state = Tracer.state
           prev = state.record_sql
           state.record_sql = should_record
           prev.nil? || prev
@@ -273,13 +273,13 @@ module NewRelic
         # children of a transaction without affecting the tracing of
         # the whole transaction
         def push_trace_execution_flag(should_trace=false) #THREAD_LOCAL_ACCESS
-          TransactionState.tl_get.push_traced(should_trace)
+          Tracer.state.push_traced(should_trace)
         end
 
         # Pop the current trace execution status.  Restore trace execution status
         # to what it was before we pushed the current flag.
         def pop_trace_execution_flag #THREAD_LOCAL_ACCESS
-          TransactionState.tl_get.pop_traced
+          Tracer.state.pop_traced
         end
 
         # Herein lies the corpse of the former 'start' method. May
@@ -543,7 +543,7 @@ module NewRelic
           @sql_sampler.reset!
 
           if Agent.config[:clear_transaction_state_after_fork]
-            TransactionState.tl_clear
+            Tracer.clear_state
           end
         end
 

data/lib/new_relic/agent/configuration/default_source.rb

@@ -95,6 +95,8 @@ module NewRelic
                 :rails4
               when 5
                 :rails5
+              when 6
+                :rails6
               else
                 ::NewRelic::Agent.logger.error "Detected unsupported Rails version #{Rails::VERSION::STRING}"
               end
@@ -1735,7 +1737,7 @@ module NewRelic
           :public      => true,
           :type        => Boolean,
           :allowed_from_server => false,
-          :description => 'If <code>true</code>, the agent will clear <code>TransactionState</code> in <code>Agent.drop_buffered_data</code>.'
+          :description => 'If <code>true</code>, the agent will clear <code>Tracer::State</code> in <code>Agent.drop_buffered_data</code>.'
         },
         :account_id => {
           :default => nil,

data/lib/new_relic/agent/cross_app_monitor.rb

@@ -6,7 +6,7 @@ require 'digest'
 require 'json'
 
 require 'new_relic/agent/inbound_request_monitor'
-require 'new_relic/agent/transaction_state'
+require 'new_relic/agent/tracer'
 require 'new_relic/agent/threading/agent_thread'
 require 'new_relic/agent/cross_app_payload'
 
@@ -44,7 +44,7 @@ module NewRelic
 
         events.subscribe(:before_call) do |env| #THREAD_LOCAL_ACCESS
           if id = decoded_id(env) and should_process_request?(id)
-            state = NewRelic::Agent::TransactionState.tl_get
+            state = NewRelic::Agent::Tracer.state
 
             if (transaction = state.current_transaction)
               transaction_info = referring_transaction_info(state, env)
@@ -58,7 +58,7 @@ module NewRelic
         end
 
         events.subscribe(:after_call) do |env, (_status_code, headers, _body)| #THREAD_LOCAL_ACCESS
-          state = NewRelic::Agent::TransactionState.tl_get
+          state = NewRelic::Agent::Tracer.state
 
           insert_response_header(state, env, headers)
         end

data/lib/new_relic/agent/datastores.rb

@@ -47,7 +47,7 @@ module NewRelic
             alias_method method_name_without_newrelic, method_name
 
             define_method(method_name) do |*args, &blk|
-              segment = NewRelic::Agent::Transaction.start_datastore_segment(
+              segment = NewRelic::Agent::Tracer.start_datastore_segment(
                 product: product,
                 operation: operation
               )
@@ -112,7 +112,7 @@ module NewRelic
 
         return yield unless operation
 
-        segment = NewRelic::Agent::Transaction.start_datastore_segment(
+        segment = NewRelic::Agent::Tracer.start_datastore_segment(
           product: product,
           operation: operation,
           collection: collection
@@ -123,8 +123,8 @@ module NewRelic
         ensure
           begin
             if callback
-                elapsed_time = (Time.now - segment.start_time).to_f
-                callback.call(result, segment.name, elapsed_time)
+              elapsed_time = (Time.now - segment.start_time).to_f
+              callback.call(result, segment.name, elapsed_time)
             end
           ensure
             segment.finish if segment
@@ -163,8 +163,7 @@ module NewRelic
       def self.notice_sql(query, scoped_metric, elapsed)
         NewRelic::Agent.record_api_supportability_metric(:notice_sql)
 
-        state = TransactionState.tl_get
-        if (txn = state.current_transaction) && (segment = txn.current_segment) && segment.respond_to?(:notice_sql)
+        if (txn = Tracer.current_transaction) && (segment = txn.current_segment) && segment.respond_to?(:notice_sql)
           segment.notice_sql(query)
         end
         nil
@@ -198,8 +197,7 @@ module NewRelic
 
         # Settings may change eventually, but for now we follow the same
         # capture rules as SQL for non-SQL statements.
-        state = TransactionState.tl_get
-        if (txn = state.current_transaction) && (segment = txn.current_segment) && segment.respond_to?(:notice_nosql_statement)
+        if (txn = Tracer.current_transaction) && (segment = txn.current_segment) && segment.respond_to?(:notice_nosql_statement)
           segment.notice_nosql_statement(statement)
         end
         nil

data/lib/new_relic/agent/datastores/metric_helper.rb

@@ -107,8 +107,7 @@ module NewRelic
         # Allow Transaction#with_database_metric_name to override our
         # collection and operation
         def self.overridden_operation_and_collection #THREAD_LOCAL_ACCESS
-          state = NewRelic::Agent::TransactionState.tl_get
-          txn   = state.current_transaction
+          txn   = Tracer.current_transaction
           txn ? txn.instrumentation_state[:datastore_override] : nil
         end
 

data/lib/new_relic/agent/distributed_trace_monitor.rb

@@ -18,9 +18,8 @@ module NewRelic
       def on_before_call(request)
         return unless NewRelic::Agent.config[:'distributed_tracing.enabled']
         return unless payload = request[NEWRELIC_TRACE_KEY]
+        return unless txn = Tracer.current_transaction
 
-        state = NewRelic::Agent::TransactionState.tl_get
-        txn = state.current_transaction
         if txn.accept_distributed_trace_payload payload
           txn.distributed_trace_payload.caller_transport_type = transport_type(request)
         end

data/lib/new_relic/agent/error_collector.rb

@@ -197,7 +197,7 @@ module NewRelic
 
         tag_exception(exception)
 
-        state = ::NewRelic::Agent::TransactionState.tl_get
+        state = ::NewRelic::Agent::Tracer.state
 
         unless options[:expected]
           increment_error_count!(state, exception, options)

data/lib/new_relic/agent/external.rb

@@ -34,13 +34,16 @@ module NewRelic
       #
       # @api public
       def start_segment(library: nil, uri: nil, procedure: nil)
+        Deprecator.deprecate 'External.start_segment',
+                             'Tracer#start_external_request_segment'
+
         raise ArgumentError, 'Argument `library` is required' if library.nil?
         raise ArgumentError, 'Argument `uri` is required' if uri.nil?
         raise ArgumentError, 'Argument `procedure` is required' if procedure.nil?
 
         ::NewRelic::Agent.record_api_supportability_metric(:start_segment)
 
-        ::NewRelic::Agent::Transaction.start_external_request_segment(
+        ::NewRelic::Agent::Tracer.start_external_request_segment(
           library: library,
           uri: uri,
           procedure: procedure
@@ -64,7 +67,7 @@ module NewRelic
         NewRelic::Agent.record_api_supportability_metric(:process_request_metadata)
         return unless CrossAppTracing.cross_app_enabled?
 
-        state = NewRelic::Agent::TransactionState.tl_get
+        state = NewRelic::Agent::Tracer.state
         if transaction = state.current_transaction
           rmd = ::JSON.parse obfuscator.deobfuscate(request_metadata)
 
@@ -109,8 +112,7 @@ module NewRelic
         NewRelic::Agent.record_api_supportability_metric(:get_response_metadata)
         return unless CrossAppTracing.cross_app_enabled?
 
-        state = NewRelic::Agent::TransactionState.tl_get
-        return unless (transaction = state.current_transaction)
+        return unless (transaction = Tracer.current_transaction)
         return unless (cross_app_payload = transaction.cross_app_payload)
 
         # must freeze the name since we're responding with it

data/lib/new_relic/agent/instrumentation/action_cable_subscriber.rb

@@ -27,7 +27,7 @@ module NewRelic
           event = super
           notice_error payload if payload.key? :exception
           if event.name == PERFORM_ACTION
-            finish_transaction
+            finish_transaction event
           else
             stop_recording_metrics event
           end
@@ -38,15 +38,18 @@ module NewRelic
         private
 
         def start_transaction event
-          Transaction.start(state, :action_cable, :transaction_name => transaction_name_from_event(event))
+          event.payload[:finishable] = Tracer.start_transaction_or_segment(
+            name:     transaction_name_from_event(event),
+            category: :action_cable
+          )
         end
 
-        def finish_transaction
-          Transaction.stop(state)
+        def finish_transaction event
+          (finishable = event.payload[:finishable]) && finishable.finish
         end
 
         def start_recording_metrics event
-          event.payload[:segment] = Transaction.start_segment name: metric_name_from_event(event)
+          event.payload[:segment] = Tracer.start_segment name: metric_name_from_event(event)
         end
 
         def stop_recording_metrics event

data/lib/new_relic/agent/instrumentation/action_controller_subscriber.rb

@@ -43,17 +43,21 @@ module NewRelic
         end
 
         def start_transaction(event)
-          Transaction.start(state, :controller,
-                            :request          => event.request,
-                            :filtered_params  => filter(event.payload[:params]),
-                            :apdex_start_time => event.queue_start,
-                            :transaction_name => event.metric_name,
-                            :ignore_apdex     => event.apdex_ignored?,
-                            :ignore_enduser   => event.enduser_ignored?)
+          event.payload[:finishable] = Tracer.start_transaction_or_segment(
+            name:             event.metric_name,
+            category:         :controller,
+            options: {
+              request:          event.request,
+              filtered_params:  filter(event.payload[:params]),
+              apdex_start_time: event.queue_start,
+              ignore_apdex:     event.apdex_ignored?,
+              ignore_enduser:   event.enduser_ignored?
+            }
+          )
         end
 
         def stop_transaction(event)
-          Transaction.stop(state)
+          (finishable = event.payload[:finishable]) && finishable.finish
         end
 
         def filter(params)

data/lib/new_relic/agent/instrumentation/action_view_subscriber.rb

@@ -14,7 +14,7 @@ module NewRelic
           event = RenderEvent.new(name, Time.now, nil, id, payload)
           push_event(event)
           if state.is_execution_traced? && event.recordable?
-            event.segment = NewRelic::Agent::Transaction.start_segment name: event.metric_name
+            event.segment = NewRelic::Agent::Tracer.start_segment name: event.metric_name
           end
         rescue => e
           log_notification_error(e, name, 'start')

data/lib/new_relic/agent/instrumentation/active_job.rb

@@ -39,7 +39,7 @@ module NewRelic
         end
 
         def self.perform(job, block)
-          state = ::NewRelic::Agent::TransactionState.tl_get
+          state = ::NewRelic::Agent::Tracer.state
           txn = state.current_transaction
 
           # Don't nest transactions if we're already in a web transaction.
@@ -52,7 +52,7 @@ module NewRelic
               transaction_category)
             block.call
           else
-            run_in_transaction(state, job, block)
+            run_in_transaction(job, block)
           end
         end
 
@@ -62,11 +62,10 @@ module NewRelic
           end
         end
 
-        def self.run_in_transaction(state, job, block)
-          ::NewRelic::Agent::Transaction.wrap(state,
-                                              transaction_name_for_job(job),
-                                              :other,
-                                              &block)
+        def self.run_in_transaction(job, block)
+          ::NewRelic::Agent::Tracer.in_transaction(name: transaction_name_for_job(job),
+                                                   category: :other,
+                                                   &block)
         end
 
         def self.transaction_category

data/lib/new_relic/agent/instrumentation/active_record.rb

@@ -44,7 +44,7 @@ module NewRelic
         end
 
         def log_with_newrelic_instrumentation(*args, &block) #THREAD_LOCAL_ACCESS
-          state = NewRelic::Agent::TransactionState.tl_get
+          state = NewRelic::Agent::Tracer.state
 
           if !state.is_execution_traced?
             return log_without_newrelic_instrumentation(*args, &block)
@@ -67,7 +67,7 @@ module NewRelic
             database = @config && @config[:database]
           end
 
-          segment = NewRelic::Agent::Transaction.start_datastore_segment(
+          segment = NewRelic::Agent::Tracer.start_datastore_segment(
             product: product,
             operation: operation,
             collection: collection,

data/lib/new_relic/agent/instrumentation/active_record_subscriber.rb

@@ -114,7 +114,7 @@ module NewRelic
               database = @config && @config[:database]
             end
 
-            segment = Transaction.start_datastore_segment product: product,
+            segment = Tracer.start_datastore_segment product: product,
                                                           operation: operation,
                                                           collection: collection,
                                                           host: host,
@@ -130,7 +130,7 @@ module NewRelic
           end
 
           def state
-            @state ||= NewRelic::Agent::TransactionState.tl_get
+            @state ||= NewRelic::Agent::Tracer.state
           end
 
           def sql

data/lib/new_relic/agent/instrumentation/active_storage_subscriber.rb

@@ -22,7 +22,7 @@ module NewRelic
         end
 
         def start_segment name, id, payload
-          segment = Transaction.start_segment name: metric_name(name, payload)
+          segment = Tracer.start_segment name: metric_name(name, payload)
           segment.params[:key] = payload[:key]
           segment.params[:exist] = payload[:exist] if payload.key? :exist
           event_stack[id].push segment