appsignal 2.11.0.alpha.2-java → 2.11.0.beta.5-java

data/lib/appsignal/hooks.rb

@@ -69,10 +69,34 @@ module Appsignal
         text.size > 200 ? "#{text[0...197]}..." : text
       end
     end
+
+    # Alias Probes constants that have moved to their own module in version
+    # 2.11.0.
+    def self.const_missing(name)
+      case name
+      when :SidekiqProbe
+        callers = caller
+        Appsignal::Utils::DeprecationMessage.message \
+          "The constant Appsignal::Hooks::SidekiqProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::SidekiqProbe " \
+          "in the following file to remove this message.\n#{callers.first}"
+        Appsignal::Probes::SidekiqProbe
+      when :PumaProbe
+        callers = caller
+        Appsignal::Utils::DeprecationMessage.message \
+          "The constant Appsignal::Hooks::PumaProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::PumaProbe " \
+          "in the following file to remove this message.\n#{callers.first}"
+        Appsignal::Probes::PumaProbe
+      else
+        super
+      end
+    end
   end
 end
 
 require "appsignal/hooks/action_cable"
+require "appsignal/hooks/active_job"
 require "appsignal/hooks/active_support_notifications"
 require "appsignal/hooks/celluloid"
 require "appsignal/hooks/delayed_job"
@@ -81,6 +105,7 @@ require "appsignal/hooks/passenger"
 require "appsignal/hooks/puma"
 require "appsignal/hooks/rake"
 require "appsignal/hooks/redis"
+require "appsignal/hooks/resque"
 require "appsignal/hooks/sequel"
 require "appsignal/hooks/shoryuken"
 require "appsignal/hooks/sidekiq"

data/lib/appsignal/hooks/active_job.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class ActiveJobHook < Appsignal::Hooks::Hook
+      register :active_job
+
+      def dependencies_present?
+        defined?(::ActiveJob)
+      end
+
+      def install
+        ::ActiveJob::Base
+          .extend ::Appsignal::Hooks::ActiveJobHook::ActiveJobClassInstrumentation
+      end
+
+      module ActiveJobClassInstrumentation
+        def execute(job)
+          job_status = nil
+          current_transaction = Appsignal::Transaction.current
+          transaction =
+            if current_transaction.nil_transaction?
+              # No standalone integration started before ActiveJob integration.
+              # We don't have a separate integration for this QueueAdapter like
+              # we do for Sidekiq.
+              #
+              # Prefer job_id from provider, instead of ActiveJob's internal ID.
+              Appsignal::Transaction.create(
+                job["provider_job_id"] || job["job_id"],
+                Appsignal::Transaction::BACKGROUND_JOB,
+                Appsignal::Transaction::GenericRequest.new({})
+              )
+            else
+              current_transaction
+            end
+
+          super
+        rescue Exception => exception # rubocop:disable Lint/RescueException
+          job_status = :failed
+          transaction.set_error(exception)
+          raise exception
+        ensure
+          if transaction
+            transaction.params =
+              Appsignal::Utils::HashSanitizer.sanitize(
+                job["arguments"],
+                Appsignal.config[:filter_parameters]
+              )
+
+            transaction_tags = ActiveJobHelpers.transaction_tags_for(job)
+            transaction_tags["active_job_id"] = job["job_id"]
+            provider_job_id = job["provider_job_id"]
+            if provider_job_id
+              transaction_tags[:provider_job_id] = provider_job_id
+            end
+            transaction.set_tags(transaction_tags)
+
+            transaction.set_action_if_nil(ActiveJobHelpers.action_name(job))
+            enqueued_at = job["enqueued_at"]
+            if enqueued_at # Present in Rails 6 and up
+              transaction.set_queue_start((Time.parse(enqueued_at).to_f * 1_000).to_i)
+            end
+
+            if current_transaction.nil_transaction?
+              # Only complete transaction if ActiveJob is not wrapped in
+              # another supported integration, such as Sidekiq.
+              Appsignal::Transaction.complete_current!
+            end
+          end
+
+          metrics = ActiveJobHelpers.metrics_for(job)
+          metrics.each do |(metric_name, tags)|
+            if job_status
+              ActiveJobHelpers.increment_counter metric_name, 1,
+                tags.merge(:status => job_status)
+            end
+            ActiveJobHelpers.increment_counter metric_name, 1,
+              tags.merge(:status => :processed)
+          end
+        end
+      end
+
+      module ActiveJobHelpers
+        ACTION_MAILER_CLASSES = [
+          "ActionMailer::DeliveryJob",
+          "ActionMailer::Parameterized::DeliveryJob",
+          "ActionMailer::MailDeliveryJob"
+        ].freeze
+
+        def self.action_name(job)
+          case job["job_class"]
+          when *ACTION_MAILER_CLASSES
+            job["arguments"][0..1].join("#")
+          else
+            "#{job["job_class"]}#perform"
+          end
+        end
+
+        # Returns an array of metrics with tags used to report the job metrics
+        #
+        # If job ONLY has a queue, it will return `queue_job_count` with tags.
+        # If job has a queue AND priority, it will ALSO return
+        # `queue_priority_job_count` with tags.
+        #
+        # @return [Array] Array of metrics with tags to report.
+        def self.metrics_for(job)
+          tags = { :queue => job["queue_name"] }
+          metrics = [["queue_job_count", tags]]
+
+          priority = job["priority"]
+          if priority
+            metrics << [
+              "queue_priority_job_count",
+              tags.merge(:priority => priority)
+            ]
+          end
+
+          metrics
+        end
+
+        def self.transaction_tags_for(job)
+          tags = {}
+          queue = job["queue_name"]
+          tags[:queue] = queue if queue
+          priority = job["priority"]
+          tags[:priority] = priority if priority
+          tags
+        end
+
+        def self.increment_counter(key, value, tags = {})
+          Appsignal.increment_counter "active_job_#{key}", value, tags
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/puma.rb

@@ -24,7 +24,6 @@ module Appsignal
           # runs in the Puma main process.
           # For more information:
           # https://docs.appsignal.com/ruby/integrations/puma.html
-          require "appsignal/probes/puma"
           Appsignal::Minutely.probes.register :puma, ::Appsignal::Probes::PumaProbe
         end
 

data/lib/appsignal/hooks/resque.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class ResqueHook < Appsignal::Hooks::Hook
+      register :resque
+
+      def dependencies_present?
+        defined?(::Resque)
+      end
+
+      def install
+        Resque::Job.class_eval do
+          alias_method :perform_without_appsignal, :perform
+
+          def perform
+            transaction = Appsignal::Transaction.create(
+              SecureRandom.uuid,
+              Appsignal::Transaction::BACKGROUND_JOB,
+              Appsignal::Transaction::GenericRequest.new({})
+            )
+
+            Appsignal.instrument "perform.resque" do
+              perform_without_appsignal
+            end
+          rescue Exception => exception # rubocop:disable Lint/RescueException
+            transaction.set_error(exception)
+            raise exception
+          ensure
+            if transaction
+              transaction.set_action_if_nil("#{payload["class"]}#perform")
+              args =
+                Appsignal::Utils::HashSanitizer.sanitize(
+                  ResqueHelpers.arguments(payload),
+                  Appsignal.config[:filter_parameters]
+                )
+              transaction.params = args if args
+              transaction.set_tags("queue" => queue)
+
+              Appsignal::Transaction.complete_current!
+            end
+            Appsignal.stop("resque")
+          end
+        end
+      end
+
+      class ResqueHelpers
+        def self.arguments(payload)
+          case payload["class"]
+          when "ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper"
+            nil # Set in the ActiveJob integration
+          else
+            payload["args"]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/sidekiq.rb

@@ -12,7 +12,6 @@ module Appsignal
       end
 
       def install
-        require "appsignal/probes/sidekiq"
         Appsignal::Minutely.probes.register :sidekiq, Appsignal::Probes::SidekiqProbe
 
         ::Sidekiq.configure_server do |config|
@@ -27,8 +26,7 @@ module Appsignal
     class SidekiqPlugin # rubocop:disable Metrics/ClassLength
       include Appsignal::Hooks::Helpers
 
-      UNKNOWN_ACTION_NAME = "unknown".freeze
-      JOB_KEYS = %w[
+      EXCLUDED_JOB_KEYS = %w[
         args backtrace class created_at enqueued_at error_backtrace error_class
         error_message failed_at jid retried_at retry wrapped
       ].freeze
@@ -36,7 +34,7 @@ module Appsignal
       def call(_worker, item, _queue)
         job_status = nil
         transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
+          item["jid"],
           Appsignal::Transaction::BACKGROUND_JOB,
           Appsignal::Transaction::GenericRequest.new(
             :queue_start => item["enqueued_at"]
@@ -55,7 +53,10 @@ module Appsignal
       ensure
         if transaction
           transaction.set_action_if_nil(formatted_action_name(item))
-          transaction.params = filtered_arguments(item)
+
+          params = filtered_arguments(item)
+          transaction.params = params if params
+
           formatted_metadata(item).each do |key, value|
             transaction.set_metadata key, value
           end
@@ -81,16 +82,20 @@ module Appsignal
 
       def formatted_action_name(job)
         sidekiq_action_name = parse_action_name(job)
+        return unless sidekiq_action_name
+
         complete_action = sidekiq_action_name =~ /\.|#/
-        if complete_action || sidekiq_action_name == UNKNOWN_ACTION_NAME
-          return sidekiq_action_name
-        end
+        return sidekiq_action_name if complete_action
+
         "#{sidekiq_action_name}#perform"
       end
 
       def filtered_arguments(job)
+        arguments = parse_arguments(job)
+        return unless arguments
+
         Appsignal::Utils::HashSanitizer.sanitize(
-          parse_arguments(job),
+          arguments,
           Appsignal.config[:filter_parameters]
         )
       end
@@ -98,7 +103,8 @@ module Appsignal
       def formatted_metadata(item)
         {}.tap do |hash|
           (item || {}).each do |key, value|
-            next if JOB_KEYS.include?(key)
+            next if EXCLUDED_JOB_KEYS.include?(key)
+
             hash[key] = truncate(string_or_inspect(value))
           end
         end
@@ -117,81 +123,11 @@ module Appsignal
           safe_load(args[0], job_class) do |target, method, _|
             "#{target}.#{method}"
           end
-        when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
-          wrapped_job = job["wrapped"]
-          if wrapped_job
-            parse_active_job_action_name_from_wrapped job
-          else
-            parse_active_job_action_name_from_arguments job
-          end
         else
           job_class
         end
       end
 
-      # Return the ActiveJob wrapped job name.
-      #
-      # Returns "unknown" if no acceptable job class name could be found.
-      #
-      # @example Payload with "wrapped" value
-      #   {
-      #     "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
-      #     "wrapped" => "MyWrappedJob",
-      #     # ...
-      #   }
-      def parse_active_job_action_name_from_wrapped(job)
-        job_class = job["wrapped"]
-        case job_class
-        when "ActionMailer::DeliveryJob"
-          extract_action_mailer_name job["args"]
-        when String
-          job_class
-        else
-          unknown_action_name_for job
-        end
-      end
-
-      # Return the ActiveJob job name based on the job's arguments.
-      #
-      # Returns "unknown" if no acceptable job class name could be found.
-      #
-      # @example Payload without "wrapped" value
-      #   {
-      #     "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
-      #     "args" => [{
-      #       "job_class" => "MyWrappedJob",
-      #       # ...
-      #     }]
-      #     # ...
-      #   }
-      def parse_active_job_action_name_from_arguments(job)
-        args = job.fetch("args", [])
-        first_arg = args[0]
-        if first_arg == "ActionMailer::DeliveryJob"
-          extract_action_mailer_name args
-        elsif active_job_payload?(first_arg)
-          first_arg["job_class"]
-        else
-          unknown_action_name_for job
-        end
-      end
-
-      # Checks if the first argument in the job payload is an ActiveJob payload.
-      def active_job_payload?(arg)
-        arg.is_a?(Hash) && arg["job_class"].is_a?(String)
-      end
-
-      def unknown_action_name_for(job)
-        Appsignal.logger.debug \
-          "Unable to determine an action name from Sidekiq payload: #{job}"
-        UNKNOWN_ACTION_NAME
-      end
-
-      def extract_action_mailer_name(args)
-        # Returns in format: MailerClass#mailer_method
-        args[0]["arguments"][0..1].join("#")
-      end
-
       # Based on: https://github.com/mperham/sidekiq/blob/63ee43353bd3b753beb0233f64865e658abeb1c3/lib/sidekiq/api.rb#L336-L358
       def parse_arguments(job)
         args = job.fetch("args", [])
@@ -201,20 +137,7 @@ module Appsignal
             arg
           end
         when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
-          is_wrapped = job["wrapped"]
-          first_arg = args[0]
-          job_args =
-            if is_wrapped || active_job_payload?(first_arg)
-              first_arg["arguments"]
-            else
-              []
-            end
-          if (is_wrapped || first_arg) == "ActionMailer::DeliveryJob"
-            # Remove MailerClass, mailer_method and "deliver_now"
-            job_args.drop(3)
-          else
-            job_args
-          end
+          nil # Set in the ActiveJob integration
         else
           # Sidekiq Enterprise argument encryption.
           # More information: https://github.com/mperham/sidekiq/wiki/Ent-Encryption

data/lib/appsignal/integrations/delayed_job_plugin.rb

@@ -64,7 +64,7 @@ module Appsignal
         dot_split = default_name.split(".")
         return default_name if dot_split.length == 2
 
-        ["unknown"]
+        "#{default_name}#perform"
       end
 
       def self.extract_value(object_or_hash, field, default_value = nil, convert_to_s = false)

data/lib/appsignal/integrations/que.rb

@@ -32,7 +32,7 @@ module Appsignal
               transaction.set_error(error)
               raise error
             ensure
-              transaction.set_action "#{local_attrs[:job_class]}#run"
+              transaction.set_action_if_nil "#{local_attrs[:job_class]}#run"
               Appsignal::Transaction.complete_current!
             end
           end

data/lib/appsignal/integrations/resque.rb

@@ -4,18 +4,15 @@ module Appsignal
   module Integrations
     # @api private
     module ResquePlugin
-      # Do not use this file as a template for your own background processor
-      # Resque is an exception to the rule and the code below causes the
-      # extension to shut itself down after a single job.
-      # see http://docs.appsignal.com/background-monitoring/custom.html
-      def around_perform_resque_plugin(*_args)
-        Appsignal.monitor_single_transaction(
-          "perform_job.resque",
-          :class => to_s,
-          :method => "perform"
-        ) do
-          yield
-        end
+      def self.extended(_)
+        callers = caller
+        Appsignal::Utils::DeprecationMessage.message \
+          "The AppSignal ResquePlugin is deprecated and does " \
+          "nothing on extend. In this version of the AppSignal Ruby gem " \
+          "the integration with Resque is automatic on all Resque workers. " \
+          "Please remove the following line from this file to remove this " \
+          "message: extend Appsignal::Integrations::ResquePlugin\n" \
+          "#{callers.first}"
       end
     end
   end