appsignal 4.8.5 → 4.9.0

data/lib/appsignal/integrations/que.rb

@@ -10,7 +10,7 @@ module Appsignal
 
         begin
           Appsignal.instrument("perform_job.que") { super }
-        rescue Exception => error # rubocop:disable Lint/RescueException
+        rescue Exception => error
           transaction.set_error(error)
           raise error
         ensure
@@ -34,5 +34,72 @@ module Appsignal
         end
       end
     end
+
+    # @!visibility private
+    #
+    # Prepended to `Que::Job`'s singleton so it records each enqueue as an
+    # `enqueue.que` event under the active transaction. Like all AppSignal
+    # events, it only records when there's an active transaction (e.g. enqueuing
+    # from within a web request or another job); otherwise it's a transparent
+    # pass-through.
+    module QueClientPlugin
+      def enqueue(*_args, job_options: {}, **_rest)
+        # Inside a `bulk_enqueue` block the batch is recorded once by the
+        # `bulk_enqueue` wrapper, so each inner enqueue is a pass-through to
+        # avoid recording an event per job.
+        return super if Thread.current[:appsignal_que_bulk_enqueue]
+
+        # Under Active Job the enqueue is already recorded as an
+        # `enqueue.active_job` event, so skip recording it again here.
+        return super if Appsignal::Transaction.current? &&
+          Appsignal::Transaction.current.job_enqueue_events_suppressed?
+
+        # Resolve the job class the way Que does: an explicit `:job_class`, else
+        # the class `enqueue` was called on.
+        title = "enqueue #{job_options[:job_class] || name} job"
+        Appsignal.instrument("enqueue.que", title) { super }
+      end
+    end
+
+    # @!visibility private
+    #
+    # `bulk_enqueue` exists only on Que 2+, so this lives in its own module that
+    # the hook prepends only when Que has the method -- otherwise we'd define a
+    # `bulk_enqueue` on Que versions that have none. The whole batch records a
+    # single `bulk_enqueue.que` event; the inner enqueues are pass-throughs.
+    module QueBulkClientPlugin
+      def bulk_enqueue(*_args, job_options: {}, **_rest)
+        # Under Active Job the enqueue is already recorded as an
+        # `enqueue.active_job` event, so skip recording it again here.
+        return super if Appsignal::Transaction.current? &&
+          Appsignal::Transaction.current.job_enqueue_events_suppressed?
+
+        Appsignal.instrument("bulk_enqueue.que", bulk_enqueue_title(job_options)) do
+          # Flag the batch so the enqueues this block triggers pass through
+          # without recording, without reading Que's internal bulk state.
+          was_bulk = Thread.current[:appsignal_que_bulk_enqueue]
+          Thread.current[:appsignal_que_bulk_enqueue] = true
+          begin
+            super
+          ensure
+            Thread.current[:appsignal_que_bulk_enqueue] = was_bulk
+          end
+        end
+      end
+
+      private
+
+      # The batch's job class is known up front only from an explicit
+      # `:job_class` or when `bulk_enqueue` is called on a concrete subclass;
+      # called on `Que::Job` itself the class isn't known until the inner
+      # enqueues run, so the title is left class-less.
+      def bulk_enqueue_title(job_options)
+        job_class = job_options[:job_class]
+        job_class ||= name unless equal?(::Que::Job)
+        return "bulk enqueue jobs" unless job_class
+
+        "bulk enqueue #{job_class} jobs"
+      end
+    end
   end
 end

data/lib/appsignal/integrations/rake.rb

@@ -25,7 +25,7 @@ module Appsignal
           Appsignal.instrument "task.rake" do
             super
           end
-        rescue Exception => error # rubocop:disable Lint/RescueException
+        rescue Exception => error
           Appsignal::Integrations::RakeIntegrationHelper.register_at_exit_hook
           unless RakeIntegration.ignored_error?(error)
             transaction ||= _appsignal_create_transaction

data/lib/appsignal/integrations/resque.rb

@@ -10,7 +10,7 @@ module Appsignal
         Appsignal.instrument "perform.resque" do
           super
         end
-      rescue Exception => exception # rubocop:disable Lint/RescueException
+      rescue Exception => exception
         transaction.set_error(exception)
         raise exception
       ensure
@@ -25,6 +25,25 @@ module Appsignal
       end
     end
 
+    # Wraps `Resque.push` to record an `enqueue.resque` event so the enqueue
+    # shows up under the active transaction.
+    #
+    # Like all AppSignal events, this only records when there's an active
+    # transaction (e.g. enqueuing from within a web request or another job).
+    # An enqueue with no transaction is a transparent pass-through.
+    #
+    # @!visibility private
+    module ResquePushIntegration
+      def push(_queue, item)
+        # Under Active Job the enqueue is already recorded as an
+        # `enqueue.active_job` event, so skip recording it again here.
+        return super if Appsignal::Transaction.current? &&
+          Appsignal::Transaction.current.job_enqueue_events_suppressed?
+
+        Appsignal.instrument("enqueue.resque", "enqueue #{item["class"]} job") { super }
+      end
+    end
+
     # @!visibility private
     class ResqueHelpers
       def self.arguments(payload)

data/lib/appsignal/integrations/shoryuken.rb

@@ -8,7 +8,7 @@ module Appsignal
         transaction = Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)
 
         Appsignal.instrument("perform_job.shoryuken", &block)
-      rescue Exception => error # rubocop:disable Lint/RescueException
+      rescue Exception => error
         transaction.set_error(error)
         raise
       ensure
@@ -71,5 +71,37 @@ module Appsignal
         end
       end
     end
+
+    # Shoryuken client middleware that records an `enqueue.shoryuken` event so
+    # the enqueue shows up under the active transaction.
+    #
+    # Like all AppSignal events, this only records when there's an active
+    # transaction (e.g. enqueuing from within a web request or another job). An
+    # enqueue with no transaction is a transparent pass-through.
+    #
+    # @!visibility private
+    class ShoryukenClientMiddleware
+      def call(options, &block)
+        # Under Active Job the enqueue is already recorded as an
+        # `enqueue.active_job` event, so skip recording it again here.
+        return yield if Appsignal::Transaction.current? &&
+          Appsignal::Transaction.current.job_enqueue_events_suppressed?
+
+        Appsignal.instrument("enqueue.shoryuken", enqueue_title(options), &block)
+      end
+
+      private
+
+      # Enqueues through a Shoryuken worker carry the worker class in the
+      # `shoryuken_class` message attribute. Raw `send_message` enqueues don't,
+      # so there's no worker class to name -- fall back to the queue instead.
+      def enqueue_title(options)
+        worker_class = options.dig(:message_attributes, "shoryuken_class", :string_value)
+        return "enqueue #{worker_class} job" if worker_class
+
+        queue = options[:queue_url].to_s.split("/").last
+        "enqueue on #{queue}"
+      end
+    end
   end
 end

data/lib/appsignal/integrations/sidekiq.rb

@@ -49,6 +49,76 @@ module Appsignal
       end
     end
 
+    # Resolves the name of a Sidekiq job. That's normally the job class, but
+    # the Sidekiq delayed extensions encode the real target and method as YAML
+    # in the job's first argument, so those are decoded into a `Target.method`
+    # (class) or `Target#method` (instance) name.
+    #
+    # Shared between the client middleware, which titles the enqueue event with
+    # it, and the server middleware, which names the perform transaction with
+    # it. The same job then reads the same name on both sides.
+    #
+    # @!visibility private
+    module SidekiqActionName
+      module_function
+
+      # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L316-L334
+      def parse_action_name(job)
+        args = job.fetch("args", [])
+        job_class = job["class"]
+        case job_class
+        when "Sidekiq::Extensions::DelayedModel"
+          safe_load(args[0], job_class) do |target, method, _|
+            "#{target.class}##{method}"
+          end
+        when /\ASidekiq::Extensions::Delayed/
+          safe_load(args[0], job_class) do |target, method, _|
+            "#{target}.#{method}"
+          end
+        else
+          job_class
+        end
+      end
+
+      # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L403-L412
+      def safe_load(content, default)
+        if Gem::Version.new(YAML::VERSION) >= Gem::Version.new("4.0.0")
+          yield(*YAML.unsafe_load(content))
+        else
+          yield(*YAML.load(content)) # rubocop:disable Security/YAMLLoad
+        end
+      rescue => error
+        # Sidekiq issue #1761: in dev mode, it's possible to have jobs enqueued
+        # which haven't been loaded into memory yet so the YAML can't be
+        # loaded.
+        Appsignal.internal_logger.warn(
+          "Unable to load YAML from Sidekiq delayed extension job: #{error.message}"
+        )
+        default
+      end
+    end
+
+    # Sidekiq client middleware that runs on enqueue. Records an
+    # `enqueue.sidekiq` event so the enqueue shows up under the active
+    # transaction.
+    #
+    # Like all AppSignal events, this only records when there's an active
+    # transaction (e.g. enqueuing from within a web request or another job). An
+    # enqueue with no transaction is a transparent pass-through.
+    #
+    # @!visibility private
+    class SidekiqClientMiddleware
+      def call(_worker_class, job, _queue, _redis_pool, &block)
+        # Under Active Job the enqueue is already recorded as an
+        # `enqueue.active_job` event, so skip recording it again here.
+        return yield if Appsignal::Transaction.current? &&
+          Appsignal::Transaction.current.job_enqueue_events_suppressed?
+
+        title = "enqueue #{SidekiqActionName.parse_action_name(job)} job"
+        Appsignal.instrument("enqueue.sidekiq", title, &block)
+      end
+    end
+
     # @!visibility private
     class SidekiqMiddleware
       include Appsignal::Hooks::Helpers
@@ -77,7 +147,7 @@ module Appsignal
 
         begin
           Appsignal.instrument "perform_job.sidekiq", &block
-        rescue Exception => exception # rubocop:disable Lint/RescueException
+        rescue Exception => exception
           job_status = :failed
           raise exception
         ensure
@@ -124,7 +194,7 @@ module Appsignal
       end
 
       def formatted_action_name(job)
-        sidekiq_action_name = parse_action_name(job)
+        sidekiq_action_name = SidekiqActionName.parse_action_name(job)
         return unless sidekiq_action_name
 
         complete_action = sidekiq_action_name =~ /\.|#/
@@ -143,30 +213,12 @@ module Appsignal
         end
       end
 
-      # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L316-L334
-      def parse_action_name(job)
-        args = job.fetch("args", [])
-        job_class = job["class"]
-        case job_class
-        when "Sidekiq::Extensions::DelayedModel"
-          safe_load(args[0], job_class) do |target, method, _|
-            "#{target.class}##{method}"
-          end
-        when /\ASidekiq::Extensions::Delayed/
-          safe_load(args[0], job_class) do |target, method, _|
-            "#{target}.#{method}"
-          end
-        else
-          job_class
-        end
-      end
-
       # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L336-L358
       def parse_arguments(job)
         args = job.fetch("args", [])
         case job["class"]
         when /\ASidekiq::Extensions::Delayed/
-          safe_load(args[0], args) do |_, _, arg|
+          SidekiqActionName.safe_load(args[0], args) do |_, _, arg|
             arg
           end
         else
@@ -179,21 +231,6 @@ module Appsignal
           args
         end
       end
-
-      # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L403-L412
-      def safe_load(content, default)
-        if YAML::VERSION >= "4.0.0"
-          yield(*YAML.unsafe_load(content))
-        else
-          yield(*YAML.load(content))
-        end
-      rescue => error
-        # Sidekiq issue #1761: in dev mode, it's possible to have jobs enqueued
-        # which haven't been loaded into memory yet so the YAML can't be
-        # loaded.
-        Appsignal.internal_logger.warn "Unable to load YAML: #{error.message}"
-        default
-      end
     end
   end
 end

data/lib/appsignal/integrations/webmachine.rb

@@ -32,7 +32,7 @@ module Appsignal
       def handle_exceptions
         super do
           yield
-        rescue Exception => e # rubocop:disable Lint/RescueException
+        rescue Exception => e
           Appsignal.set_error(e)
           raise e
         end

data/lib/appsignal/logger.rb

@@ -67,6 +67,8 @@ module Appsignal
     # @return [Integer]
     attr_reader :level
 
+    # rubocop:disable Lint/MissingSuper
+
     # Create a new logger instance
     #
     # @param group [String] Name of the group for this logger.
@@ -87,6 +89,7 @@ module Appsignal
       @appsignal_attributes = attributes
       @loggers = []
     end
+    # rubocop:enable Lint/MissingSuper
 
     # Sets the formatter for this logger and all broadcasted loggers.
     # @param formatter [Proc] The formatter to use for log messages.
@@ -101,7 +104,7 @@ module Appsignal
     # We support the various methods in the Ruby
     # logger class by supplying this method.
     # @!visibility private
-    def add(severity, message = nil, group = nil, &block) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+    def add(severity, message = nil, group = nil, &block)
       # If we do not need to broadcast to any loggers and the severity is
       # below the log level, we can return early.
       severity ||= UNKNOWN

data/lib/appsignal/rack/abstract_middleware.rb

@@ -108,7 +108,7 @@ module Appsignal
       # @see #instrument_app_call
       def instrument_app_call_with_exception_handling(env, transaction, wrapped_instrumentation)
         instrument_app_call(env, transaction)
-      rescue Exception => error # rubocop:disable Lint/RescueException
+      rescue Exception => error
         report_errors =
           if @report_errors == DEFAULT_ERROR_REPORTING
             # If there's no parent transaction, report the error

data/lib/appsignal/rack/body_wrapper.rb

@@ -53,7 +53,7 @@ module Appsignal
         @body_already_closed = true
       rescue *IGNORED_ERRORS # Do not report
         raise
-      rescue Exception => error # rubocop:disable Lint/RescueException
+      rescue Exception => error
         appsignal_report_error(error)
         raise error
       end
@@ -109,7 +109,7 @@ module Appsignal
         end
       rescue *IGNORED_ERRORS # Do not report
         raise
-      rescue Exception => error # rubocop:disable Lint/RescueException
+      rescue Exception => error
         appsignal_report_error(error)
         raise error
       end
@@ -130,7 +130,7 @@ module Appsignal
         end
       rescue *IGNORED_ERRORS # Do not report
         raise
-      rescue Exception => error # rubocop:disable Lint/RescueException
+      rescue Exception => error
         appsignal_report_error(error)
         raise error
       end
@@ -156,7 +156,7 @@ module Appsignal
         end
       rescue *IGNORED_ERRORS # Do not report
         raise
-      rescue Exception => error # rubocop:disable Lint/RescueException
+      rescue Exception => error
         appsignal_report_error(error)
         raise error
       end
@@ -174,7 +174,7 @@ module Appsignal
         end
       rescue *IGNORED_ERRORS # Do not report
         raise
-      rescue Exception => error # rubocop:disable Lint/RescueException
+      rescue Exception => error
         appsignal_report_error(error)
         raise error
       end

data/lib/appsignal/rack/hanami_middleware.rb

@@ -14,6 +14,7 @@ module Appsignal
 
       HANAMI_ACTION_INSTANCE = "hanami.action_instance"
       ROUTER_PARAMS = "router.params"
+      private_constant :HANAMI_ACTION_INSTANCE, :ROUTER_PARAMS
 
       def add_transaction_metadata_after(transaction, request)
         action_name = fetch_hanami_action(request.env)

data/lib/appsignal/sample_data.rb

@@ -68,6 +68,7 @@ module Appsignal
     private
 
     UNSET_VALUE = nil
+    private_constant :UNSET_VALUE
 
     # Method called by `dup` and `clone` to create a duplicate instance.
     # Make sure the `@blocks` variable is also properly duplicated.

data/lib/appsignal/transaction.rb

@@ -290,6 +290,53 @@ module Appsignal
       @store[key]
     end
 
+    # @!visibility private
+    #
+    # Run a block during which downstream HTTP client integrations (Net::HTTP,
+    # ...) skip recording their own event. Used when an outer HTTP client
+    # integration (Faraday) already records the request, so the same request is
+    # not instrumented twice as nested client events.
+    def suppress_http_client_events
+      # Restore the previous value rather than forcing `false`, so nested calls
+      # don't unsuppress while an outer block is still active.
+      previously_suppressed = store("http_client")[:suppressed]
+      store("http_client")[:suppressed] = true
+      yield
+    ensure
+      store("http_client")[:suppressed] = previously_suppressed
+    end
+
+    # @!visibility private
+    def http_client_events_suppressed?
+      store("http_client")[:suppressed] == true
+    end
+
+    # @!visibility private
+    #
+    # Run a block during which nested job enqueue integrations (Sidekiq, Resque,
+    # ...) skip recording their own enqueue event. Used when an outer integration
+    # (Active Job) already records the enqueue, so the same enqueue is not
+    # instrumented twice as nested enqueue events.
+    def suppress_job_enqueue_events
+      # Restore the previous value rather than forcing `false`, so nested calls
+      # don't unsuppress while an outer block is still active.
+      previously_suppressed = store("job_enqueue")[:suppressed]
+      store("job_enqueue")[:suppressed] = true
+      yield
+    ensure
+      store("job_enqueue")[:suppressed] = previously_suppressed
+    end
+
+    # @!visibility private
+    def job_enqueue_events_suppressed?
+      # When enqueue instrumentation is disabled, every enqueue integration
+      # treats its event as suppressed. That is how the config option turns the
+      # enqueue events off across all integrations at once.
+      return true if Appsignal.config && !Appsignal.config[:enable_job_enqueue_instrumentation]
+
+      store("job_enqueue")[:suppressed] == true
+    end
+
     # Add parameters to the transaction.
     #
     # When this method is called multiple times, it will merge the request parameters.
@@ -311,7 +358,7 @@ module Appsignal
     def add_params(given_params = nil, &block)
       @params.add(given_params, &block)
     end
-    alias :set_params :add_params
+    alias set_params add_params
 
     # @since 4.0.0
     # @return [void]
@@ -337,7 +384,7 @@ module Appsignal
     def add_params_if_nil(given_params = nil, &block)
       add_params(given_params, &block) if !@params.value? && !@params.empty?
     end
-    alias :set_params_if_nil :add_params_if_nil
+    alias set_params_if_nil add_params_if_nil
 
     # Add tags to the transaction.
     #
@@ -357,7 +404,7 @@ module Appsignal
     def add_tags(given_tags = {})
       @tags.merge!(given_tags)
     end
-    alias :set_tags :add_tags
+    alias set_tags add_tags
 
     # Add session data to the transaction.
     #
@@ -379,7 +426,7 @@ module Appsignal
     def add_session_data(given_session_data = nil, &block)
       @session_data.add(given_session_data, &block)
     end
-    alias :set_session_data :add_session_data
+    alias set_session_data add_session_data
 
     # Set session data on the transaction if not already set.
     #
@@ -401,7 +448,7 @@ module Appsignal
     def add_session_data_if_nil(given_session_data = nil, &block)
       add_session_data(given_session_data, &block) unless @session_data.value?
     end
-    alias :set_session_data_if_nil :add_session_data_if_nil
+    alias set_session_data_if_nil add_session_data_if_nil
 
     # Add headers to the transaction.
     #
@@ -418,7 +465,7 @@ module Appsignal
     def add_headers(given_headers = nil, &block)
       @headers.add(given_headers, &block)
     end
-    alias :set_headers :add_headers
+    alias set_headers add_headers
 
     # Add headers to the transaction if not already set.
     #
@@ -439,7 +486,7 @@ module Appsignal
     def add_headers_if_nil(given_headers = nil, &block)
       add_headers(given_headers, &block) unless @headers.value?
     end
-    alias :set_headers_if_nil :add_headers_if_nil
+    alias set_headers_if_nil add_headers_if_nil
 
     # Add custom data to the transaction.
     #
@@ -454,7 +501,7 @@ module Appsignal
     def add_custom_data(data)
       @custom_data.add(data)
     end
-    alias :set_custom_data :add_custom_data
+    alias set_custom_data add_custom_data
 
     # Add breadcrumbs to the transaction.
     #
@@ -601,8 +648,8 @@ module Appsignal
         error = error.cause
       end
     end
-    alias :set_error :add_error
-    alias_method :add_exception, :add_error
+    alias set_error add_error
+    alias add_exception add_error
 
     # @!visibility private
     # @see Helpers::Instrumentation#instrument
@@ -654,7 +701,7 @@ module Appsignal
     def to_h
       JSON.parse(@ext.to_json)
     end
-    alias_method :to_hash, :to_h
+    alias to_hash to_h
 
     protected
 
@@ -738,6 +785,7 @@ module Appsignal
 
     BACKTRACE_REGEX =
       %r{(?<gem>[\w-]+ \(.+\) )?(?<path>:?/?\w+?.+?):(?<line>:?\d+)(?::in `(?<method>.+)')?$}.freeze
+    private_constant :BACKTRACE_REGEX
 
     def first_formatted_backtrace_line(error)
       backtrace = cleaned_backtrace(error.backtrace)

data/lib/appsignal/utils/query_params_sanitizer.rb

@@ -6,6 +6,7 @@ module Appsignal
       REPLACEMENT_KEY = "?"
 
       module ClassMethods
+        # rubocop:disable Style/OptionalBooleanParameter
         def sanitize(params, only_top_level = false, key_sanitizer = nil)
           case params
           when Hash
@@ -16,6 +17,7 @@ module Appsignal
             REPLACEMENT_KEY
           end
         end
+        # rubocop:enable Style/OptionalBooleanParameter
 
         private
 

data/lib/appsignal/version.rb

@@ -2,5 +2,5 @@
 
 module Appsignal
   # @return [String]
-  VERSION = "4.8.5"
+  VERSION = "4.9.0"
 end

data/lib/appsignal.rb

@@ -105,7 +105,7 @@ module Appsignal
     #
     # @return [void]
     # @since 0.7.0
-    def start # rubocop:disable Metrics/AbcSize
+    def start
       if ENV.fetch("_APPSIGNAL_DIAGNOSE", false)
         internal_logger.info("Skipping start in diagnose context")
         return
@@ -169,7 +169,7 @@ module Appsignal
     # @param block [Proc] Optional block to configure the config object.
     # @return [void]
     # @!visibility private
-    def _load_config!(env_param = nil, &block) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+    def _load_config!(env_param = nil, &block)
       # Ensure it's not an empty string if it's a value
       proper_env_param = env_param&.to_s&.strip
       # Unset it if it's an empty string

data/lib/puma/plugin/appsignal.rb

@@ -8,7 +8,7 @@ require "json"
 #
 # For even more information:
 # https://docs.appsignal.com/ruby/integrations/puma.html
-Puma::Plugin.create do # rubocop:disable Metrics/BlockLength
+Puma::Plugin.create do
   def start(launcher)
     @launcher = launcher
     log_debug "AppSignal: Puma plugin start."