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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a510cdd0af6ef1f3780e5d559a41762d7d2b094fb5309d0e10d143b223e76fb
-  data.tar.gz: d7195e855b5a2ea44db9cfdd9c132dfb2afda1994bc4c7c8aba08181f47081d8
+  metadata.gz: e3403327daac577742fc279cc704c58cc766e64e71995d2206cdefa104512993
+  data.tar.gz: 638b4104fc2ac814a28b98ff9de32a675531fed3e6d451adb3dc996551e52458
 SHA512:
-  metadata.gz: bcf0aa5c31a43142fb264dab678ae2b19896d2b1618ae3caf6fbacfff67c3fd46c62c87f062968a92ca93abfc88f159d7c849ca03862c661fd5540112b2a5b9a
-  data.tar.gz: 9eb9618c8cb83f87db2b183573e64313a6fe01651bf2f5e93b748347de38e64716053ba7dcf42ce9a2954caa1c3e2096153acb37543a49cfe4c069afe7e8c705
+  metadata.gz: 2c51e569187ea8f8fa5d99b237c22d4ad14472527329d78463ef2c12d59cb4abce350398ead4a22e8358378eb0d12ee67fd84808c5e91c30c1e0464368b42990
+  data.tar.gz: 4c822a8d331d632f2fc47c06e0823092b29605e1b1f4070a978edd78f5feb4896bedc17d59437fe8b382757d93cf676fa40af0775a98ec53df6227a659cc5282

data/.rubocop.yml

@@ -64,6 +64,9 @@ Style/Encoding: # For Ruby 1.9 as it doesn't default to UTF-8
 Style/Lambda:
   EnforcedStyle: lambda
 
+Style/WordArray:
+  Enabled: false
+
 Naming/FileName:
   Exclude:
     - "ext/Rakefile"

data/.semaphore/semaphore.yml

@@ -214,14 +214,14 @@ blocks:
         value: 1.17.3
       commands:
       - "./support/bundler_wrapper exec rake test"
-    - name: Ruby 2.0.0-p648 for resque
+    - name: Ruby 2.0.0-p648 for resque-1
       env_vars:
       - name: RUBY_VERSION
         value: 2.0.0-p648
       - name: GEMSET
-        value: resque
+        value: resque-1
       - name: BUNDLE_GEMFILE
-        value: gemfiles/resque.gemfile
+        value: gemfiles/resque-1.gemfile
       - name: _RUBYGEMS_VERSION
         value: 2.7.8
       - name: _BUNDLER_VERSION
@@ -600,20 +600,34 @@ blocks:
         value: latest
       commands:
       - "./support/bundler_wrapper exec rake test"
-    - name: Ruby 2.6.5 for resque
+    - name: Ruby 2.6.5 for resque-1
       env_vars:
       - name: RUBY_VERSION
         value: 2.6.5
       - name: GEMSET
-        value: resque
+        value: resque-1
       - name: BUNDLE_GEMFILE
-        value: gemfiles/resque.gemfile
+        value: gemfiles/resque-1.gemfile
       - name: _RUBYGEMS_VERSION
         value: latest
       - name: _BUNDLER_VERSION
         value: 1.17.3
       commands:
       - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 2.6.5 for resque-2
+      env_vars:
+      - name: RUBY_VERSION
+        value: 2.6.5
+      - name: GEMSET
+        value: resque-2
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/resque-2.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
     - name: Ruby 2.6.5 for sequel
       env_vars:
       - name: RUBY_VERSION
@@ -840,20 +854,34 @@ blocks:
         value: latest
       commands:
       - "./support/bundler_wrapper exec rake test"
-    - name: Ruby 2.7.1 for resque
+    - name: Ruby 2.7.1 for resque-1
       env_vars:
       - name: RUBY_VERSION
         value: 2.7.1
       - name: GEMSET
-        value: resque
+        value: resque-1
       - name: BUNDLE_GEMFILE
-        value: gemfiles/resque.gemfile
+        value: gemfiles/resque-1.gemfile
       - name: _RUBYGEMS_VERSION
         value: latest
       - name: _BUNDLER_VERSION
         value: 1.17.3
       commands:
       - "./support/bundler_wrapper exec rake test"
+    - name: Ruby 2.7.1 for resque-2
+      env_vars:
+      - name: RUBY_VERSION
+        value: 2.7.1
+      - name: GEMSET
+        value: resque-2
+      - name: BUNDLE_GEMFILE
+        value: gemfiles/resque-2.gemfile
+      - name: _RUBYGEMS_VERSION
+        value: latest
+      - name: _BUNDLER_VERSION
+        value: latest
+      commands:
+      - "./support/bundler_wrapper exec rake test"
     - name: Ruby 2.7.1 for sequel
       env_vars:
       - name: RUBY_VERSION

data/CHANGELOG.md

@@ -3,8 +3,17 @@
 # 2.11.0
 - Track queue time regardless of namespace. Support custom namespaces. PR #602
 - Improve deprecation message from frontend error middleware. PR #620
-- Report Ruby environment metadata. PR #621, #627
+- Report Ruby environment metadata. PR #621, #627, #619, #618
 - Refactor: Move minutely probes to their own files and modules. PR #623
+- Allow custom action names in Que integration. Needed for Active Job
+  integration. PR #628
+- Add Active Job support. Support Active Job without separate AppSignal
+  integration of the background job library. Add support for previously
+  unsupported Active Job adapters. Adapters that were previously already
+  supported (Sidekiq, DelayedJob and Resque) still work in this new setup.
+  PR #629
+- Add automatic Resque integration. Remove manual Resque and Resque Active Job
+  integrations. PR #630
 
 # 2.10.9
 - Use http proxy if configured when downloading agent. PR #606

data/build_matrix.yml

@@ -165,8 +165,12 @@ matrix:
           - "2.3.8"
           - "2.4.9"
           - "jruby-9.1.17.0"
-    - gem: "resque"
+    - gem: "resque-1"
       bundler: "1.17.3"
+    - gem: "resque-2"
+      exclude:
+        ruby:
+          - "2.0.0-p648"
     - gem: "sequel"
     - gem: "sequel-435"
     - gem: "sinatra"

data/gemfiles/rails-4.2.gemfile

@@ -3,8 +3,15 @@ source 'https://rubygems.org'
 gem 'rails', '~> 4.2.0'
 gem 'mime-types', '~> 2.6'
 
-gemspec :path => '../'
+ruby_version = Gem::Version.new(RUBY_VERSION)
+if ruby_version < Gem::Version.new("2.3.0")
+  gem "sidekiq", "~> 4.0"
+else
+  gem "sidekiq"
+end
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1.0")
+if ruby_version < Gem::Version.new("2.1.0")
   gem 'nokogiri', '~> 1.6.0'
 end
+
+gemspec :path => '../'

data/gemfiles/rails-5.0.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 5.0.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/rails-5.1.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 5.1.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/rails-5.2.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 5.2.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/rails-6.0.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 6.0.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/resque-1.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'resque', "~> 1.27.0"
+gem 'sinatra'
+gem 'mime-types', '~> 2.6'
+
+gemspec :path => '../'

data/gemfiles/{resque.gemfile → resque-2.gemfile}

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'resque'
+gem 'resque', "~> 2.0"
 gem 'sinatra'
 gem 'mime-types', '~> 2.6'
 

data/lib/appsignal/hooks.rb

@@ -73,6 +73,7 @@ module Appsignal
 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 +82,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,89 @@
+# 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
+
+      # @todo Add queue time support for Rails 6's enqueued_at. For both
+      #   existing and new transactions.
+      module ActiveJobClassInstrumentation
+        def execute(job)
+          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
+          transaction.set_error(exception)
+          raise exception
+        ensure
+          if transaction
+            transaction.params =
+              Appsignal::Utils::HashSanitizer.sanitize(
+                job["arguments"],
+                Appsignal.config[:filter_parameters]
+              )
+
+            tags = { :queue => job["queue_name"] }
+            provider_job_id = job["provider_job_id"]
+            tags[:provider_job_id] = provider_job_id if provider_job_id
+            transaction.set_tags(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
+        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
+      end
+    end
+  end
+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

@@ -27,8 +27,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
@@ -55,7 +54,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 +83,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 +104,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 +124,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 +138,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