appsignal 3.9.3 → 3.11.0

data/lib/appsignal/integrations/redis_client.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   module Integrations
+    # @api private
     module RedisClientIntegration
       def write(command)
         sanitized_command =

data/lib/appsignal/integrations/resque.rb

@@ -5,11 +5,7 @@ module Appsignal
     # @api private
     module ResqueIntegration
       def perform
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::BACKGROUND_JOB,
-          Appsignal::Transaction::GenericRequest.new({})
-        )
+        transaction = Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)
 
         Appsignal.instrument "perform.resque" do
           super
@@ -34,6 +30,7 @@ module Appsignal
       end
     end
 
+    # @api private
     class ResqueHelpers
       def self.arguments(payload)
         case payload["class"]

data/lib/appsignal/integrations/shoryuken.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Integrations
+    # @api private
+    class ShoryukenMiddleware
+      def call(worker_instance, queue, sqs_msg, body, &block)
+        transaction = Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)
+
+        Appsignal.instrument("perform_job.shoryuken", &block)
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        transaction.set_error(error)
+        raise
+      ensure
+        batch = sqs_msg.is_a?(Array)
+        attributes = fetch_attributes(batch, sqs_msg)
+        transaction.set_action_if_nil("#{worker_instance.class.name}#perform")
+        transaction.set_params_if_nil { fetch_args(batch, sqs_msg, body) }
+        transaction.set_tags(attributes)
+        transaction.set_tags("queue" => queue)
+        transaction.set_tags("batch" => true) if batch
+
+        if attributes.key?("SentTimestamp")
+          transaction.set_queue_start(Time.at(attributes["SentTimestamp"].to_i).to_i)
+        end
+
+        Appsignal::Transaction.complete_current!
+      end
+
+      private
+
+      def fetch_attributes(batch, sqs_msg)
+        if batch
+          # We can't instrument batched message separately, the `yield` will
+          # perform all the batched messages.
+          # To provide somewhat useful metadata, Get first message based on
+          # SentTimestamp, and use its attributes as metadata for the
+          # transaction. We can't combine them all because then they would
+          # overwrite each other and the last message (in an sorted order)
+          # would be used as the source of the metadata.  With the
+          # oldest/first message at least some useful information is stored
+          # such as the first received time and the number of retries for the
+          # first message. The newer message should have lower values and
+          # timestamps in their metadata.
+          first_msg =
+            sqs_msg.min do |a, b|
+              a.attributes["SentTimestamp"].to_i <=> b.attributes["SentTimestamp"].to_i
+            end
+          first_msg.attributes
+        else
+          sqs_msg.attributes.merge(:message_id => sqs_msg.message_id)
+        end
+      end
+
+      def fetch_args(batch, sqs_msg, body)
+        if batch
+          bodies = {}
+          sqs_msg.each_with_index do |msg, index|
+            # Store all separate bodies on a hash with the key being the
+            # message_id
+            bodies[msg.message_id] = body[index]
+          end
+          bodies
+        else
+          case body
+          when Hash
+            body
+          else
+            { :params => body }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/integrations/sidekiq.rb

@@ -11,6 +11,7 @@ module Appsignal
     # about completing the transaction.
     #
     # Introduced in Sidekiq 5.1.
+    # @api private
     class SidekiqDeathHandler
       def call(_job_context, exception)
         return unless Appsignal.config[:sidekiq_report_errors] == "discard"
@@ -37,12 +38,7 @@ module Appsignal
           # Sidekiq error outside of the middleware scope.
           # Can be a job JSON parse error or some other error happening in
           # Sidekiq.
-          transaction =
-            Appsignal::Transaction.create(
-              SecureRandom.uuid, # Newly generated job id
-              Appsignal::Transaction::BACKGROUND_JOB,
-              Appsignal::Transaction::GenericRequest.new({})
-            )
+          transaction = Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)
           transaction.set_action_if_nil("SidekiqInternal")
           transaction.set_metadata("sidekiq_error", sidekiq_context[:context])
           transaction.set_params_if_nil(:jobstr => sidekiq_context[:jobstr])
@@ -64,13 +60,7 @@ module Appsignal
 
       def call(_worker, item, _queue, &block)
         job_status = nil
-        transaction = Appsignal::Transaction.create(
-          item["jid"],
-          Appsignal::Transaction::BACKGROUND_JOB,
-          Appsignal::Transaction::GenericRequest.new(
-            :queue_start => item["enqueued_at"]
-          )
-        )
+        transaction = Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)
         transaction.set_action_if_nil(formatted_action_name(item))
 
         formatted_metadata(item).each do |key, value|
@@ -83,8 +73,10 @@ module Appsignal
         raise exception
       ensure
         if transaction
-          transaction.set_params_if_nil(filtered_arguments(item))
-          transaction.set_http_or_background_queue_start
+          transaction.set_params_if_nil { parse_arguments(item) }
+          queue_start = (item["enqueued_at"].to_f * 1000.0).to_i # Convert seconds to milliseconds
+          transaction.set_queue_start(queue_start)
+          transaction.set_tags(:request_id => item["jid"])
           Appsignal::Transaction.complete_current! unless exception
 
           queue = item["queue"] || "unknown"
@@ -115,16 +107,6 @@ module Appsignal
         "#{sidekiq_action_name}#perform"
       end
 
-      def filtered_arguments(job)
-        arguments = parse_arguments(job)
-        return unless arguments
-
-        Appsignal::Utils::HashSanitizer.sanitize(
-          arguments,
-          Appsignal.config[:filter_parameters]
-        )
-      end
-
       def formatted_metadata(item)
         {}.tap do |hash|
           (item || {}).each do |key, value|

data/lib/appsignal/integrations/unicorn.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   module Integrations
+    # @api private
     module UnicornIntegration
       # Make sure that appsignal is started and the last transaction
       # in a worker gets flushed.

data/lib/appsignal/integrations/webmachine.rb

@@ -5,20 +5,23 @@ module Appsignal
     # @api private
     module WebmachineIntegration
       def run
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          request,
-          :params_method => :query
-        )
-
-        transaction.set_action_if_nil("#{resource.class.name}##{request.method}")
+        has_parent_transaction = Appsignal::Transaction.current?
+        transaction =
+          if has_parent_transaction
+            Appsignal::Transaction.current
+          else
+            Appsignal::Transaction.create(Appsignal::Transaction::HTTP_REQUEST)
+          end
 
         Appsignal.instrument("process_action.webmachine") do
           super
         end
+      ensure
+        transaction.set_action_if_nil("#{resource.class.name}##{request.method}")
+        transaction.set_params_if_nil(request.query)
+        transaction.set_headers_if_nil { request.headers if request.respond_to?(:headers) }
 
-        Appsignal::Transaction.complete_current!
+        Appsignal::Transaction.complete_current! unless has_parent_transaction
       end
 
       private

data/lib/appsignal/logger.rb

@@ -4,7 +4,10 @@ require "logger"
 require "set"
 
 module Appsignal
-  # Logger that flushes logs to the AppSignal logging service
+  # Logger that flushes logs to the AppSignal logging service.
+  #
+  # @see https://docs.appsignal.com/logging/platforms/integrations/ruby.html
+  #   AppSignal Ruby logging documentation.
   class Logger < ::Logger
     PLAINTEXT = 0
     LOGFMT = 1
@@ -144,8 +147,9 @@ module Appsignal
     # as our logger directly inherits from Ruby base logger.
     #
     # Links:
-    # https://github.com/rails/rails/blob/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/activesupport/lib/active_support/logger.rb#L60-L76
-    # https://github.com/rails/rails/blob/main/activesupport/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/active_support/logger_silence.rb
+    #
+    # - https://github.com/rails/rails/blob/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/activesupport/lib/active_support/logger.rb#L60-L76
+    # - https://github.com/rails/rails/blob/main/activesupport/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/active_support/logger_silence.rb
     def silence(_severity = ERROR, &block)
       block.call
     end

data/lib/appsignal/probes/helpers.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   module Probes
+    # @api private
     module Helpers
       private
 

data/lib/appsignal/probes/mri.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   module Probes
+    # @api private
     class MriProbe
       include Helpers
 

data/lib/appsignal/probes/sidekiq.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   module Probes
+    # @api private
     class SidekiqProbe
       include Helpers
 

data/lib/appsignal/probes.rb

@@ -2,8 +2,10 @@
 
 module Appsignal
   module Probes
+    # @api private
     ITERATION_IN_SECONDS = 60
 
+    # @api private
     class ProbeCollection
       def initialize
         @probes = {}
@@ -72,6 +74,7 @@ module Appsignal
 
       # @see ProbeCollection
       # @return [ProbeCollection] Returns list of probes.
+      # @api private
       def probes
         @probes ||= ProbeCollection.new
       end

data/lib/appsignal/rack/abstract_middleware.rb

@@ -4,6 +4,12 @@ require "rack"
 
 module Appsignal
   module Rack
+    # Base instrumentation middleware.
+    #
+    # Do not use this middleware directly. Instead use
+    # {InstrumentationMiddleware}.
+    #
+    # @abstract
     # @api private
     class AbstractMiddleware
       DEFAULT_ERROR_REPORTING = :default
@@ -14,7 +20,7 @@ module Appsignal
         @options = options
         @request_class = options.fetch(:request_class, ::Rack::Request)
         @params_method = options.fetch(:params_method, :params)
-        @instrument_span_name = options.fetch(:instrument_span_name, "process.abstract")
+        @instrument_event_name = options.fetch(:instrument_event_name, nil)
         @report_errors = options.fetch(:report_errors, DEFAULT_ERROR_REPORTING)
       end
 
@@ -28,11 +34,7 @@ module Appsignal
             if wrapped_instrumentation
               env[Appsignal::Rack::APPSIGNAL_TRANSACTION]
             else
-              Appsignal::Transaction.create(
-                SecureRandom.uuid,
-                Appsignal::Transaction::HTTP_REQUEST,
-                request
-              )
+              Appsignal::Transaction.create(Appsignal::Transaction::HTTP_REQUEST)
             end
 
           unless wrapped_instrumentation
@@ -53,7 +55,7 @@ module Appsignal
                 wrapped_instrumentation
               )
             else
-              instrument_app_call(request.env)
+              instrument_app_call(request.env, transaction)
             end
           ensure
             add_transaction_metadata_after(transaction, request)
@@ -72,28 +74,40 @@ module Appsignal
       # don't report any exceptions here, the top instrumentation middleware
       # will be the one reporting the exception.
       #
-      # Either another {GenericInstrumentation} or {EventHandler} is higher in
-      # the stack and will report the exception and complete the transaction.
+      # Either another {AbstractMiddleware} or {EventHandler} is higher in the
+      # stack and will report the exception and complete the transaction.
       #
-      # @see {#instrument_app_call_with_exception_handling}
-      def instrument_app_call(env)
-        if @instrument_span_name
-          Appsignal.instrument(@instrument_span_name) do
-            @app.call(env)
+      # @see #instrument_app_call_with_exception_handling
+      def instrument_app_call(env, transaction)
+        if @instrument_event_name
+          Appsignal.instrument(@instrument_event_name) do
+            call_app(env, transaction)
           end
         else
-          @app.call(env)
+          call_app(env, transaction)
         end
       end
 
+      def call_app(env, transaction)
+        status, headers, obody = @app.call(env)
+        body =
+          if obody.is_a? Appsignal::Rack::BodyWrapper
+            obody
+          else
+            # Instrument response body and closing of the response body
+            Appsignal::Rack::BodyWrapper.wrap(obody, transaction)
+          end
+        [status, headers, body]
+      end
+
       # Instrument the request fully. This is used by the top instrumentation
       # middleware in the middleware stack. Unlike
       # {#instrument_app_call} this will report any exceptions being
       # raised.
       #
-      # @see {#instrument_app_call}
+      # @see #instrument_app_call
       def instrument_app_call_with_exception_handling(env, transaction, wrapped_instrumentation)
-        instrument_app_call(env)
+        instrument_app_call(env, transaction)
       rescue Exception => error # rubocop:disable Lint/RescueException
         report_errors =
           if @report_errors == DEFAULT_ERROR_REPORTING
@@ -122,15 +136,22 @@ module Appsignal
       # Call `super` to also include the default set metadata.
       def add_transaction_metadata_after(transaction, request)
         default_action =
-          request.env["appsignal.route"] || request.env["appsignal.action"]
+          appsignal_route_env_value(request) || appsignal_action_env_value(request)
         transaction.set_action_if_nil(default_action)
         transaction.set_metadata("path", request.path)
 
         request_method = request_method_for(request)
         transaction.set_metadata("method", request_method) if request_method
 
-        transaction.set_params_if_nil(params_for(request))
-        transaction.set_http_or_background_queue_start
+        transaction.set_params_if_nil { params_for(request) }
+        transaction.set_session_data_if_nil do
+          request.session if request.respond_to?(:session)
+        end
+        transaction.set_headers_if_nil do
+          request.env if request.respond_to?(:env)
+        end
+        queue_start = Appsignal::Rack::Utils.queue_start_from(request.env)
+        transaction.set_queue_start(queue_start) if queue_start
       end
 
       def params_for(request)
@@ -138,9 +159,9 @@ module Appsignal
 
         request.send(@params_method)
       rescue => error
-        # Getting params from the request has been know to fail.
-        Appsignal.internal_logger.debug(
-          "Exception while getting params in #{self.class} from '#{@params_method}': #{error}"
+        Appsignal.internal_logger.error(
+          "Exception while fetching params from '#{@request_class}##{@params_method}': " \
+            "#{error.class} #{error}"
         )
         nil
       end
@@ -148,13 +169,35 @@ module Appsignal
       def request_method_for(request)
         request.request_method
       rescue => error
-        Appsignal.internal_logger.error("Unable to report HTTP request method: '#{error}'")
+        Appsignal.internal_logger.error(
+          "Exception while fetching the HTTP request method: #{error.class}: #{error}"
+        )
         nil
       end
 
       def request_for(env)
         @request_class.new(env)
       end
+
+      def appsignal_route_env_value(request)
+        request.env["appsignal.route"].tap do |value|
+          next unless value
+
+          Appsignal::Utils::StdoutAndLoggerMessage.warning \
+            "Setting the action name with the request env 'appsignal.route' is deprecated. " \
+              "Please use `Appsignal.set_action` instead. "
+        end
+      end
+
+      def appsignal_action_env_value(request)
+        request.env["appsignal.action"].tap do |value|
+          next unless value
+
+          Appsignal::Utils::StdoutAndLoggerMessage.warning \
+            "Setting the action name with the request env 'appsignal.action' is deprecated. " \
+              "Please use `Appsignal.set_action` instead. "
+        end
+      end
     end
   end
 end

data/lib/appsignal/rack/body_wrapper.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Appsignal
+  module Rack
+    # @api private
+    class BodyWrapper
+      def self.wrap(original_body, appsignal_transaction)
+        # The logic of how Rack treats a response body differs based on which methods
+        # the body responds to. This means that to support the Rack 3.x spec in full
+        # we need to return a wrapper which matches the API of the wrapped body as closely
+        # as possible. Pick the wrapper from the most specific to the least specific.
+        # See https://github.com/rack/rack/blob/main/SPEC.rdoc#the-body-
+        #
+        # What is important is that our Body wrapper responds to the same methods Rack
+        # (or a webserver) would be checking and calling, and passes through that functionality
+        # to the original body.
+        #
+        # This comment https://github.com/rails/rails/pull/49627#issuecomment-1769802573
+        # is of particular interest to understand why this has to be somewhat complicated.
+        if original_body.respond_to?(:to_path)
+          PathableBodyWrapper.new(original_body, appsignal_transaction)
+        elsif original_body.respond_to?(:to_ary)
+          ArrayableBodyWrapper.new(original_body, appsignal_transaction)
+        elsif !original_body.respond_to?(:each) && original_body.respond_to?(:call)
+          # This body only supports #call, so we must be running a Rack 3 application
+          # It is possible that a body exposes both `each` and `call` in the hopes of
+          # being backwards-compatible with both Rack 3.x and Rack 2.x, however
+          # this is not going to work since the SPEC says that if both are available,
+          # `each` should be used and `call` should be ignored.
+          # So for that case we can drop to our default EnumerableBodyWrapper
+          CallableBodyWrapper.new(original_body, appsignal_transaction)
+        else
+          EnumerableBodyWrapper.new(original_body, appsignal_transaction)
+        end
+      end
+
+      def initialize(body, appsignal_transaction)
+        @body_already_closed = false
+        @body = body
+        @transaction = appsignal_transaction
+      end
+
+      # This must be present in all Rack bodies and will be called by the serving adapter
+      def close
+        # The @body_already_closed check is needed so that if `to_ary`
+        # of the body has already closed itself (as prescribed) we do not
+        # attempt to close it twice
+        if !@body_already_closed && @body.respond_to?(:close)
+          Appsignal.instrument("close_response_body.rack") { @body.close }
+        end
+        @body_already_closed = true
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+
+    # The standard Rack body wrapper which exposes "each" for iterating
+    # over the response body. This is supported across all 3 major Rack
+    # versions.
+    #
+    # @api private
+    class EnumerableBodyWrapper < BodyWrapper
+      def each(&blk)
+        # This is a workaround for the Rails bug when there was a bit too much
+        # eagerness in implementing to_ary, see:
+        # https://github.com/rails/rails/pull/44953
+        # https://github.com/rails/rails/pull/47092
+        # https://github.com/rails/rails/pull/49627
+        # https://github.com/rails/rails/issues/49588
+        # While the Rack SPEC does not mandate `each` to be callable
+        # in a blockless way it is still a good idea to have it in place.
+        return enum_for(:each) unless block_given?
+
+        Appsignal.instrument("process_response_body.rack", "Process Rack response body (#each)") do
+          @body.each(&blk)
+        end
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+
+    # The callable response bodies are a new Rack 3.x feature, and would not work
+    # with older Rack versions. They must not respond to `each` because
+    # "If it responds to each, you must call each and not call". This is why
+    # it inherits from BodyWrapper directly and not from EnumerableBodyWrapper
+    #
+    # @api private
+    class CallableBodyWrapper < BodyWrapper
+      def call(stream)
+        # `stream` will be closed by the app we are calling, no need for us
+        # to close it ourselves
+        Appsignal.instrument("process_response_body.rack", "Process Rack response body (#call)") do
+          @body.call(stream)
+        end
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+
+    # "to_ary" takes precedence over "each" and allows the response body
+    # to be read eagerly. If the body supports that method, it takes precedence
+    # over "each":
+    # "Middleware may call to_ary directly on the Body and return a new Body in its place"
+    # One could "fold" both the to_ary API and the each() API into one Body object, but
+    # to_ary must also call "close" after it executes - and in the Rails implementation
+    # this pecularity was not handled properly.
+    #
+    # @api private
+    class ArrayableBodyWrapper < EnumerableBodyWrapper
+      def to_ary
+        @body_already_closed = true
+        Appsignal.instrument(
+          "process_response_body.rack",
+          "Process Rack response body (#to_ary)"
+        ) do
+          @body.to_ary
+        end
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+
+    # Having "to_path" on a body allows Rack to serve out a static file, or to
+    # pass that file to the downstream webserver for sending using X-Sendfile
+    class PathableBodyWrapper < EnumerableBodyWrapper
+      def to_path
+        Appsignal.instrument(
+          "process_response_body.rack",
+          "Process Rack response body (#to_path)"
+        ) do
+          @body.to_path
+        end
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        @transaction.set_error(error)
+        raise error
+      end
+    end
+  end
+end