Add config options to control instrumentation

Add an instrument option for each background job framework and library
that lacked one. Sidekiq, Shoryuken, Que, Resque, Delayed Job, Active
Job, Excon and MongoDB can now each be turned off through
instrument_<name>, matching the existing options for Faraday, http.rb,
Net::HTTP, Redis and Sequel. Setting one to false makes the hook report
its dependencies as absent, so the integration never installs. That
turns off both the job or request instrumentation and the enqueue
instrumentation for that framework.

Add the enable_job_enqueue_instrumentation option. When it is false,
job_enqueue_events_suppressed? reports true, which every enqueue
integration already checks before recording its event. This reuses the
existing enqueue suppression path, so one option turns the enqueue
events off everywhere without touching how the jobs themselves are
instrumented. The Active Job integration did not check that flag for its
own event yet, so it now does, the same way the standalone adapters do.

Author: unflxw

.changesets/add-instrument-config-options.md

@@ -0,0 +1,13 @@
+---
+bump: minor
+type: add
+---
+
+Add config options to turn individual integrations off. Set
+`instrument_sidekiq`, `instrument_shoryuken`, `instrument_que`,
+`instrument_resque`, `instrument_delayed_job`, `instrument_active_job`,
+`instrument_excon` or `instrument_mongo` to `false` to disable that
+integration entirely. This turns off both the instrumentation of the jobs or
+requests and the enqueue instrumentation for that integration. They all
+default to `true`. Each can also be set through its environment variable, such
+as `APPSIGNAL_INSTRUMENT_SIDEKIQ`.

lib/appsignal/config.rb

@@ -96,6 +96,7 @@ def dsl_config_file?
       :enable_at_exit_hook => "on_error",
       :enable_at_exit_reporter => true,
       :enable_host_metrics => true,
+      :enable_job_enqueue_instrumentation => true,
       :enable_minutely_probes => true,
       :enable_statsd => true,
       :enable_nginx_metrics => false,
@@ -113,13 +114,21 @@ def dsl_config_file?
       :ignore_errors => [],
       :ignore_logs => [],
       :ignore_namespaces => [],
+      :instrument_active_job => true,
       :instrument_code_ownership => true,
+      :instrument_delayed_job => true,
+      :instrument_excon => true,
       :instrument_faraday => true,
       :instrument_http_rb => true,
+      :instrument_mongo => true,
       :instrument_net_http => true,
       :instrument_ownership => true,
+      :instrument_que => true,
       :instrument_redis => true,
+      :instrument_resque => true,
       :instrument_sequel => true,
+      :instrument_shoryuken => true,
+      :instrument_sidekiq => true,
       :log => "file",
       :logging_endpoint => "https://appsignal-endpoint.net",
       :ownership_set_namespace => false,
@@ -181,6 +190,8 @@ def dsl_config_file?
       :enable_allocation_tracking => "APPSIGNAL_ENABLE_ALLOCATION_TRACKING",
       :enable_at_exit_reporter => "APPSIGNAL_ENABLE_AT_EXIT_REPORTER",
       :enable_host_metrics => "APPSIGNAL_ENABLE_HOST_METRICS",
+      :enable_job_enqueue_instrumentation =>
+        "APPSIGNAL_ENABLE_JOB_ENQUEUE_INSTRUMENTATION",
       :enable_minutely_probes => "APPSIGNAL_ENABLE_MINUTELY_PROBES",
       :enable_statsd => "APPSIGNAL_ENABLE_STATSD",
       :enable_nginx_metrics => "APPSIGNAL_ENABLE_NGINX_METRICS",
@@ -192,13 +203,21 @@ def dsl_config_file?
       :enable_rake_performance_instrumentation =>
         "APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION",
       :files_world_accessible => "APPSIGNAL_FILES_WORLD_ACCESSIBLE",
+      :instrument_active_job => "APPSIGNAL_INSTRUMENT_ACTIVE_JOB",
       :instrument_code_ownership => "APPSIGNAL_INSTRUMENT_CODE_OWNERSHIP",
+      :instrument_delayed_job => "APPSIGNAL_INSTRUMENT_DELAYED_JOB",
+      :instrument_excon => "APPSIGNAL_INSTRUMENT_EXCON",
       :instrument_faraday => "APPSIGNAL_INSTRUMENT_FARADAY",
       :instrument_http_rb => "APPSIGNAL_INSTRUMENT_HTTP_RB",
+      :instrument_mongo => "APPSIGNAL_INSTRUMENT_MONGO",
       :instrument_net_http => "APPSIGNAL_INSTRUMENT_NET_HTTP",
       :instrument_ownership => "APPSIGNAL_INSTRUMENT_OWNERSHIP",
+      :instrument_que => "APPSIGNAL_INSTRUMENT_QUE",
       :instrument_redis => "APPSIGNAL_INSTRUMENT_REDIS",
+      :instrument_resque => "APPSIGNAL_INSTRUMENT_RESQUE",
       :instrument_sequel => "APPSIGNAL_INSTRUMENT_SEQUEL",
+      :instrument_shoryuken => "APPSIGNAL_INSTRUMENT_SHORYUKEN",
+      :instrument_sidekiq => "APPSIGNAL_INSTRUMENT_SIDEKIQ",
       :ownership_set_namespace => "APPSIGNAL_OWNERSHIP_SET_NAMESPACE",
       :running_in_container => "APPSIGNAL_RUNNING_IN_CONTAINER",
       :send_environment_metadata => "APPSIGNAL_SEND_ENVIRONMENT_METADATA",
@@ -828,6 +847,8 @@ def activate_if_environment(*envs)
       #   @return [Boolean] Configure whether the at_exit reporter is enabled
       # @!attribute [rw] enable_host_metrics
       #   @return [Boolean] Configure whether host metrics collection is enabled
+      # @!attribute [rw] enable_job_enqueue_instrumentation
+      #   @return [Boolean] Configure whether to record an event when a background job is enqueued
       # @!attribute [rw] enable_minutely_probes
       #   @return [Boolean] Configure whether minutely probes are enabled
       # @!attribute [rw] enable_statsd
@@ -846,18 +867,34 @@ def activate_if_environment(*envs)
       #   @return [Boolean] Configure whether Rake performance instrumentation is enabled
       # @!attribute [rw] files_world_accessible
       #   @return [Boolean] Configure whether files created by AppSignal should be world accessible
+      # @!attribute [rw] instrument_active_job
+      #   @return [Boolean] Configure whether to instrument Active Job
+      # @!attribute [rw] instrument_delayed_job
+      #   @return [Boolean] Configure whether to instrument Delayed Job
+      # @!attribute [rw] instrument_excon
+      #   @return [Boolean] Configure whether to instrument requests made with the Excon gem
       # @!attribute [rw] instrument_faraday
       #   @return [Boolean] Configure whether to instrument requests made with the Faraday gem
       # @!attribute [rw] instrument_http_rb
       #   @return [Boolean] Configure whether to instrument requests made with the http.rb gem
+      # @!attribute [rw] instrument_mongo
+      #   @return [Boolean] Configure whether to instrument MongoDB queries
       # @!attribute [rw] instrument_net_http
       #   @return [Boolean] Configure whether to instrument requests made with Net::HTTP
       # @!attribute [rw] instrument_ownership
       #   @return [Boolean] Configure whether to instrument the Ownership gem
+      # @!attribute [rw] instrument_que
+      #   @return [Boolean] Configure whether to instrument Que
       # @!attribute [rw] instrument_redis
       #   @return [Boolean] Configure whether to instrument Redis queries
+      # @!attribute [rw] instrument_resque
+      #   @return [Boolean] Configure whether to instrument Resque
       # @!attribute [rw] instrument_sequel
       #   @return [Boolean] Configure whether to instrument Sequel queries
+      # @!attribute [rw] instrument_shoryuken
+      #   @return [Boolean] Configure whether to instrument Shoryuken
+      # @!attribute [rw] instrument_sidekiq
+      #   @return [Boolean] Configure whether to instrument Sidekiq
       # @!attribute [rw] ownership_set_namespace
       #   @return [Boolean] Configure whether the Ownership gem instrumentation should set namespace
       # @!attribute [rw] running_in_container

lib/appsignal/hooks/active_job.rb

@@ -22,7 +22,8 @@ def self.dependencies_present?
       end
 
       def dependencies_present?
-        self.class.dependencies_present?
+        self.class.dependencies_present? && Appsignal.config &&
+          Appsignal.config[:instrument_active_job]
       end
 
       def install
@@ -56,6 +57,15 @@ def install
       # @!visibility private
       module ActiveJobEnqueueInstrumentation
         def enqueue(*, **)
+          # Skip recording the event when enqueue events are suppressed. That is
+          # the case when enqueue instrumentation is disabled, and it keeps this
+          # integration consistent with the standalone adapters (Sidekiq, ...),
+          # which already gate their own enqueue event on this check.
+          if Appsignal::Transaction.current? &&
+              Appsignal::Transaction.current.job_enqueue_events_suppressed?
+            return super
+          end
+
           Appsignal.instrument("enqueue.active_job", "enqueue #{self.class.name} job") do
             # Active Job enqueues through an adapter (Sidekiq, Resque, ...) that
             # has its own enqueue instrumentation. Suppress it so the enqueue is

lib/appsignal/hooks/delayed_job.rb

@@ -7,7 +7,8 @@ class DelayedJobHook < Appsignal::Hooks::Hook
       register :delayed_job
 
       def dependencies_present?
-        defined?(::Delayed::Plugin)
+        defined?(::Delayed::Plugin) && Appsignal.config &&
+          Appsignal.config[:instrument_delayed_job]
       end
 
       def install

lib/appsignal/hooks/excon.rb

@@ -7,7 +7,7 @@ class ExconHook < Appsignal::Hooks::Hook
       register :excon
 
       def dependencies_present?
-        Appsignal.config && defined?(::Excon)
+        Appsignal.config && defined?(::Excon) && Appsignal.config[:instrument_excon]
       end
 
       def install

lib/appsignal/hooks/mongo_ruby_driver.rb

@@ -7,7 +7,8 @@ class MongoRubyDriverHook < Appsignal::Hooks::Hook
       register :mongo_ruby_driver
 
       def dependencies_present?
-        defined?(::Mongo::Monitoring::Global)
+        defined?(::Mongo::Monitoring::Global) && Appsignal.config &&
+          Appsignal.config[:instrument_mongo]
       end
 
       def install

lib/appsignal/hooks/que.rb

@@ -7,7 +7,7 @@ class QueHook < Appsignal::Hooks::Hook
       register :que
 
       def dependencies_present?
-        defined?(::Que::Job)
+        defined?(::Que::Job) && Appsignal.config && Appsignal.config[:instrument_que]
       end
 
       def install

lib/appsignal/hooks/resque.rb

@@ -7,7 +7,7 @@ class ResqueHook < Appsignal::Hooks::Hook
       register :resque
 
       def dependencies_present?
-        defined?(::Resque)
+        defined?(::Resque) && Appsignal.config && Appsignal.config[:instrument_resque]
       end
 
       def install

lib/appsignal/hooks/shoryuken.rb

@@ -7,7 +7,7 @@ class ShoryukenHook < Appsignal::Hooks::Hook
       register :shoryuken
 
       def dependencies_present?
-        defined?(::Shoryuken)
+        defined?(::Shoryuken) && Appsignal.config && Appsignal.config[:instrument_shoryuken]
       end
 
       def install

lib/appsignal/hooks/sidekiq.rb

@@ -20,7 +20,8 @@ def self.dependencies_present?
       end
 
       def dependencies_present?
-        self.class.dependencies_present?
+        self.class.dependencies_present? && Appsignal.config &&
+          Appsignal.config[:instrument_sidekiq]
       end
 
       def install