newrelic_rpm 4.0.0.332 → 6.13.1

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

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'new_relic/agent/instrumentation/controller_instrumentation'
 require 'new_relic/agent/instrumentation/sinatra/transaction_namer'
@@ -92,13 +92,24 @@ module NewRelic
             middlewares
           end
 
-          def build_with_newrelic(*args, &block)
-            unless NewRelic::Agent.config[:disable_sinatra_auto_middleware]
-              newrelic_middlewares.each do |middleware_class|
-                try_to_use(self, middleware_class)
+          if RUBY_VERSION < "2.7.0"
+            def build_with_newrelic(*args, &block)
+              unless NewRelic::Agent.config[:disable_sinatra_auto_middleware]
+                newrelic_middlewares.each do |middleware_class|
+                  try_to_use(self, middleware_class)
+                end
               end
+              build_without_newrelic(*args, &block)
+            end
+          else 
+            def build_with_newrelic(*args, **kwargs, &block)
+              unless NewRelic::Agent.config[:disable_sinatra_auto_middleware]
+                newrelic_middlewares.each do |middleware_class|
+                  try_to_use(self, middleware_class)
+                end
+              end
+              build_without_newrelic(*args, **kwargs, &block)
             end
-            build_without_newrelic(*args, &block)
           end
 
           def try_to_use(app, clazz)
@@ -108,14 +119,26 @@ module NewRelic
         end
 
         # Capture last route we've seen. Will set for transaction on route_eval
-        def process_route_with_newrelic(*args, &block)
-          begin
-            env["newrelic.last_route"] = args[0]
-          rescue => e
-            ::NewRelic::Agent.logger.debug("Failed determining last route in Sinatra", e)
+        if RUBY_VERSION < "2.7.0"
+          def process_route_with_newrelic(*args, &block)
+            begin
+              env["newrelic.last_route"] = args[0]
+            rescue => e
+              ::NewRelic::Agent.logger.debug("Failed determining last route in Sinatra", e)
+            end
+  
+            process_route_without_newrelic(*args, &block)
+          end
+        else 
+          def process_route_with_newrelic(*args, **kwargs, &block)
+            begin
+              env["newrelic.last_route"] = args[0]
+            rescue => e
+              ::NewRelic::Agent.logger.debug("Failed determining last route in Sinatra", e)
+            end
+  
+            process_route_without_newrelic(*args, **kwargs, &block)
           end
-
-          process_route_without_newrelic(*args, &block)
         end
 
         # If a transaction name is already set, this call will tromple over it.
@@ -124,18 +147,34 @@ module NewRelic
         #
         # If we're ignored, this remains safe, since set_transaction_name
         # care for the gating on the transaction's existence for us.
-        def route_eval_with_newrelic(*args, &block)
-          begin
-            txn_name = TransactionNamer.transaction_name_for_route(env, request)
-            unless txn_name.nil?
-              ::NewRelic::Agent::Transaction.set_default_transaction_name(
-                "#{self.class.name}/#{txn_name}", :sinatra)
+        if RUBY_VERSION < "2.7.0"
+          def route_eval_with_newrelic(*args, &block)
+            begin
+              txn_name = TransactionNamer.transaction_name_for_route(env, request)
+              unless txn_name.nil?
+                ::NewRelic::Agent::Transaction.set_default_transaction_name(
+                  "#{self.class.name}/#{txn_name}", :sinatra)
+              end
+            rescue => e
+              ::NewRelic::Agent.logger.debug("Failed during route_eval to set transaction name", e)
             end
-          rescue => e
-            ::NewRelic::Agent.logger.debug("Failed during route_eval to set transaction name", e)
+  
+            route_eval_without_newrelic(*args, &block)
+          end
+        else
+          def route_eval_with_newrelic(*args, **kwargs, &block)
+            begin
+              txn_name = TransactionNamer.transaction_name_for_route(env, request)
+              unless txn_name.nil?
+                ::NewRelic::Agent::Transaction.set_default_transaction_name(
+                  "#{self.class.name}/#{txn_name}", :sinatra)
+              end
+            rescue => e
+              ::NewRelic::Agent.logger.debug("Failed during route_eval to set transaction name", e)
+            end
+  
+            route_eval_without_newrelic(*args, **kwargs, &block)
           end
-
-          route_eval_without_newrelic(*args, &block)
         end
 
         def dispatch_with_newrelic #THREAD_LOCAL_ACCESS

data/lib/new_relic/agent/instrumentation/sinatra/ignorer.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module Agent

data/lib/new_relic/agent/instrumentation/sinatra/transaction_namer.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module Agent

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

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 DependencyDetection.defer do
   @name = :sunspot

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

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 DependencyDetection.defer do
   named :typhoeus
@@ -15,7 +15,7 @@ DependencyDetection.defer do
 
   executes do
     ::NewRelic::Agent.logger.info 'Installing Typhoeus instrumentation'
-    require 'new_relic/agent/cross_app_tracing'
+    require 'new_relic/agent/distributed_tracing/cross_app_tracing'
     require 'new_relic/agent/http_clients/typhoeus_wrappers'
   end
 
@@ -33,11 +33,18 @@ DependencyDetection.defer do
   # Apply single TT node for Hydra requests until async support
   executes do
     class Typhoeus::Hydra
-      include NewRelic::Agent::MethodTracer
 
       def run_with_newrelic(*args)
-        trace_execution_scoped("External/Multiple/Typhoeus::Hydra/run") do
+        segment = NewRelic::Agent::Tracer.start_segment(
+          name: NewRelic::Agent::Instrumentation::TyphoeusTracing::HYDRA_SEGMENT_NAME
+        )
+
+        instance_variable_set :@__newrelic_hydra_segment, segment
+
+        begin
           run_without_newrelic(*args)
+        ensure
+          segment.finish if segment
         end
       end
 
@@ -48,36 +55,70 @@ DependencyDetection.defer do
 end
 
 
-module NewRelic::Agent::Instrumentation::TyphoeusTracing
+module NewRelic
+  module Agent
+    module Instrumentation
+      module TyphoeusTracing
 
-  EARLIEST_VERSION = Gem::Version.new("0.5.3")
+        HYDRA_SEGMENT_NAME    = "External/Multiple/Typhoeus::Hydra/run"
+        NOTICIBLE_ERROR_CLASS = "Typhoeus::Errors::TyphoeusError"
+      
+        EARLIEST_VERSION = Gem::Version.new("0.5.3")
+        def self.is_supported_version?
+          Gem::Version.new(Typhoeus::VERSION) >= NewRelic::Agent::Instrumentation::TyphoeusTracing::EARLIEST_VERSION
+        end
 
-  def self.is_supported_version?
-    Gem::Version.new(Typhoeus::VERSION) >= NewRelic::Agent::Instrumentation::TyphoeusTracing::EARLIEST_VERSION
-  end
+        def self.request_is_hydra_enabled?(request)
+          request.respond_to?(:hydra) && request.hydra
+        end
 
-  def self.request_is_hydra_enabled?(request)
-    request.respond_to?(:hydra) && request.hydra
-  end
+        def self.response_message(response)
+          if response.respond_to?(:response_message)
+            response.response_message
+          elsif response.respond_to?(:return_message)
+            response.return_message
+          else
+            # 0.5.4 seems to have lost xxxx_message methods altogether.
+            "timeout" 
+          end
+        end
 
-  def self.trace(request)
-    state = NewRelic::Agent::TransactionState.tl_get
-    if state.is_execution_traced? && !request_is_hydra_enabled?(request)
-      wrapped_request = ::NewRelic::Agent::HTTPClients::TyphoeusHTTPRequest.new(request)
+        def self.trace(request)
+          state = NewRelic::Agent::Tracer.state
+          return unless state.is_execution_traced?
 
-      segment = NewRelic::Agent::Transaction.start_external_request_segment(
-          wrapped_request.type, wrapped_request.uri, wrapped_request.method)
+          wrapped_request = ::NewRelic::Agent::HTTPClients::TyphoeusHTTPRequest.new(request)
 
-      segment.add_request_headers wrapped_request
+          parent = if request_is_hydra_enabled?(request)
+            request.hydra.instance_variable_get(:@__newrelic_hydra_segment)
+          end
 
-      callback = Proc.new do
-        wrapped_response = ::NewRelic::Agent::HTTPClients::TyphoeusHTTPResponse.new(request.response)
-        segment.read_response_headers wrapped_response
-        segment.finish
+          segment = NewRelic::Agent::Tracer.start_external_request_segment(
+            library: wrapped_request.type,
+            uri: wrapped_request.uri,
+            procedure: wrapped_request.method,
+            parent: parent
+          )
+
+          segment.add_request_headers wrapped_request
+
+          callback = Proc.new do
+            wrapped_response = HTTPClients::TyphoeusHTTPResponse.new(request.response)
+
+            segment.process_response_headers wrapped_response
+
+            if request.response.code == 0
+              segment.notice_error NoticibleError.new NOTICIBLE_ERROR_CLASS, response_message(request.response)
+            end
+           
+            segment.finish if segment
+          end
+          request.on_complete.unshift(callback)
+
+        rescue => e
+          NewRelic::Agent.logger.error("Exception during trace setup for Typhoeus request", e)
+        end
       end
-      request.on_complete.unshift(callback)
     end
-  rescue => e
-    NewRelic::Agent.logger.error("Exception during trace setup for Typhoeus request", e)
   end
 end

data/lib/new_relic/agent/internal_agent_error.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 # This is the base class for all errors that we want to record through the
 # NewRelic::Agent::ErrorCollector#notice_agent_error API. It provides the

data/lib/new_relic/agent/javascript_instrumentor.rb

@@ -1,11 +1,10 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 require 'base64'
 require 'json'
 require 'new_relic/agent/obfuscator'
-require 'new_relic/agent/transaction_timings'
 
 module NewRelic
   module Agent
@@ -15,7 +14,7 @@ module NewRelic
       RUM_KEY_LENGTH = 13
 
       def initialize(event_listener)
-        event_listener.subscribe(:finished_configuring, &method(:log_configuration))
+        event_listener.subscribe(:initial_configuration_complete, &method(:log_configuration))
       end
 
       def log_configuration
@@ -65,9 +64,6 @@ module NewRelic
         if !state.current_transaction
           ::NewRelic::Agent.logger.debug "Not in transaction. Skipping browser instrumentation."
           false
-        elsif !state.is_transaction_traced?
-          ::NewRelic::Agent.logger.debug "Transaction is not traced. Skipping browser instrumentation."
-          false
         elsif !state.is_execution_traced?
           ::NewRelic::Agent.logger.debug "Execution is not traced. Skipping browser instrumentation."
           false
@@ -90,7 +86,7 @@ module NewRelic
       def browser_timing_header #THREAD_LOCAL_ACCESS
         return '' unless js_enabled_and_ready? # fast exit
 
-        state = NewRelic::Agent::TransactionState.tl_get
+        state = NewRelic::Agent::Tracer.state
 
         return '' unless insert_js?(state) # slower exit
 
@@ -104,7 +100,7 @@ module NewRelic
       end
 
       def browser_timing_loader
-        html_safe_if_needed("\n<script type=\"text/javascript\">#{Agent.config[:js_agent_loader]}</script>")
+        html_safe_if_needed("\n<script>#{Agent.config[:js_agent_loader]}</script>")
       end
 
       def browser_timing_config(state)
@@ -112,9 +108,9 @@ module NewRelic
         return '' if txn.nil?
 
         txn.freeze_name_and_execute_if_not_ignored do
-          data = data_for_js_agent(state)
+          data = data_for_js_agent(txn)
           json = ::JSON.dump(data)
-          return html_safe_if_needed("\n<script type=\"text/javascript\">window.NREUM||(NREUM={});NREUM.info=#{json}</script>")
+          return html_safe_if_needed("\n<script>window.NREUM||(NREUM={});NREUM.info=#{json}</script>")
         end
 
         ''
@@ -134,22 +130,29 @@ module NewRelic
       ATTS_AGENT_SUBKEY    = "a".freeze
 
       # NOTE: Internal prototyping may override this, so leave name stable!
-      def data_for_js_agent(state)
-        timings = state.timings
+      def data_for_js_agent(transaction)
+        queue_time_in_seconds = [transaction.queue_time.to_f, 0.0].max
+        start_time_in_seconds = [transaction.start_time.to_f, 0.0].max
+        app_time_in_seconds   = Time.now.to_f - start_time_in_seconds
+
+        queue_time_in_millis = (1000.0 * queue_time_in_seconds).round
+        app_time_in_millis   = (1000.0 * app_time_in_seconds).round
+
+        transaction_name = transaction.best_name || ::NewRelic::Agent::UNKNOWN_METRIC
 
         data = {
           BEACON_KEY           => NewRelic::Agent.config[:beacon],
           ERROR_BEACON_KEY     => NewRelic::Agent.config[:error_beacon],
           LICENSE_KEY_KEY      => NewRelic::Agent.config[:browser_key],
           APPLICATIONID_KEY    => NewRelic::Agent.config[:application_id],
-          TRANSACTION_NAME_KEY => obfuscator.obfuscate(timings.transaction_name_or_unknown),
-          QUEUE_TIME_KEY       => timings.queue_time_in_millis,
-          APPLICATION_TIME_KEY => timings.app_time_in_millis,
+          TRANSACTION_NAME_KEY => obfuscator.obfuscate(transaction_name),
+          QUEUE_TIME_KEY       => queue_time_in_millis,
+          APPLICATION_TIME_KEY => app_time_in_millis,
           AGENT_KEY            => NewRelic::Agent.config[:js_agent_file]
         }
 
         add_ssl_for_http(data)
-        add_attributes(data, state.current_transaction)
+        add_attributes(data, transaction)
 
         data
       end

data/lib/new_relic/agent/log_once.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 # This file is distributed under New Relic's license terms.
-# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
 
 module NewRelic
   module Agent

data/lib/new_relic/agent/logging.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/newrelic-ruby-agent/blob/main/LICENSE for complete details.
+
+require 'json'
+require 'new_relic/agent/hostname'
+
+module NewRelic
+  module Agent
+    module Logging
+
+      # This class can be used as the formatter for an existing logger.  It
+      # decorates log messages with trace and entity metadata, and formats each
+      # log messages as a JSON object.
+      #
+      # It can be added to a Rails application like this:
+      #
+      #   require 'newrelic_rpm'
+      #
+      #   Rails.application.configure do
+      #     config.log_formatter = ::NewRelic::Agent::Logging::DecoratingFormatter.new
+      #   end
+      #
+      # @api public
+      class DecoratingFormatter < ::Logger::Formatter
+        TIMESTAMP_KEY = 'timestamp'.freeze
+        MESSAGE_KEY = 'message'.freeze
+        LOG_LEVEL_KEY = 'log.level'.freeze
+        LOG_NAME_KEY = 'logger.name'.freeze
+        NEWLINE = "\n".freeze
+
+        QUOTE = '"'.freeze
+        COLON = ':'.freeze
+        COMMA = ','.freeze
+        CLOSING_BRACE = '}'.freeze
+
+        def initialize
+          Agent.config.register_callback :app_name do
+            @app_name = nil
+          end
+        end
+
+        def call severity, time, progname, msg
+          message = '{'
+          if app_name
+            add_key_value message, ENTITY_NAME_KEY, app_name
+            message << COMMA
+          end
+          add_key_value message, ENTITY_TYPE_KEY, ENTITY_TYPE
+          message << COMMA
+          add_key_value message, HOSTNAME_KEY, Hostname.get
+
+          if entity_guid = Agent.config[:entity_guid]
+            message << COMMA
+            add_key_value message, ENTITY_GUID_KEY, entity_guid
+          end
+
+          if trace_id = Tracer.trace_id
+            message << COMMA
+            add_key_value message, TRACE_ID_KEY, trace_id
+          end
+          if span_id = Tracer.span_id
+            message << COMMA
+            add_key_value message, SPAN_ID_KEY, span_id
+          end
+
+          message << COMMA
+          message << QUOTE << MESSAGE_KEY << QUOTE << COLON << escape(msg)
+          message << COMMA
+          add_key_value message, LOG_LEVEL_KEY, severity
+          if progname
+            message << COMMA
+            add_key_value message, LOG_NAME_KEY, progname
+          end
+
+          message << COMMA
+          message << QUOTE << TIMESTAMP_KEY << QUOTE << COLON << (time.to_f * 1000).round.to_s
+          message << CLOSING_BRACE << NEWLINE
+        end
+
+        def app_name
+          @app_name ||= Agent.config[:app_name][0]
+        end
+
+        def add_key_value message, key, value
+          message << QUOTE << key << QUOTE << COLON << QUOTE << value << QUOTE
+        end
+
+        def escape message
+          if String === message
+            message.to_json
+          else
+            message.inspect.to_json
+          end
+        end
+
+        def clear_tags!
+          # No-op; just avoiding issues with act-fluent-logger-rails
+        end
+      end
+
+
+      # This logger decorates logs with trace and entity metadata, and emits log
+      # messages formatted as JSON objects.  It extends the Logger class from
+      # the Ruby standard library, and accepts the same constructor parameters.
+      #
+      # It aliases the `:info` message to overwrite the `:write` method, so it
+      # can be used in Rack applications that expect the logger to be a file-like
+      # object.
+      #
+      # It can be added to an application like this:
+      #
+      #   require 'newrelic_rpm'
+      #
+      #   config.logger = NewRelic::Agent::Logging::DecoratingLogger.new "log/application.log"
+      #
+      # @api public
+      class DecoratingLogger < (defined?(::ActiveSupport) && defined?(::ActiveSupport::Logger) ? ::ActiveSupport::Logger : ::Logger)
+
+        alias :write :info
+
+        # Positional and Keyword arguments are separated beginning with Ruby 2.7
+        # Signature of ::Logger constructor changes in Ruby 2.4 to have both positional and keyword args
+        # We pivot on Ruby 2.7 for widest supportability with least amount of hassle.
+        if RUBY_VERSION < "2.7.0"
+          def initialize(*args)
+            super(*args)
+            self.formatter = DecoratingFormatter.new
+          end
+        else
+          def initialize(*args, **kwargs)
+            super(*args, **kwargs)
+            self.formatter = DecoratingFormatter.new
+          end
+        end
+      end
+    end
+  end
+end