appsignal 3.13.0 → 4.0.0.beta.1

data/lib/appsignal/helpers/metrics.rb

@@ -14,22 +14,6 @@ module Appsignal
           .warn("Gauge value #{value} for key '#{key}' is too big")
       end
 
-      def set_host_gauge(_key, _value)
-        Appsignal::Utils::StdoutAndLoggerMessage.warning \
-          "The `set_host_gauge` method has been deprecated. " \
-            "Calling this method has no effect. " \
-            "Please remove method call in the following file to remove " \
-            "this message.\n#{caller.first}"
-      end
-
-      def set_process_gauge(_key, _value)
-        Appsignal::Utils::StdoutAndLoggerMessage.warning \
-          "The `set_process_gauge` method has been deprecated. " \
-            "Calling this method has no effect. " \
-            "Please remove method call in the following file to remove " \
-            "this message.\n#{caller.first}"
-      end
-
       def increment_counter(key, value = 1.0, tags = {})
         Appsignal::Extension.increment_counter(
           key.to_s,

data/lib/appsignal/hooks/action_cable.rb

@@ -50,10 +50,10 @@ module Appsignal
             transaction.set_action_if_nil("#{channel.class}#subscribed")
             transaction.set_metadata("path", request.path)
             transaction.set_metadata("method", "websocket")
-            transaction.set_params_if_nil { request.params }
-            transaction.set_headers_if_nil { request.env }
-            transaction.set_session_data { request.session if request.respond_to? :session }
-            transaction.set_tags(:request_id => request_id) if request_id
+            transaction.add_params_if_nil { request.params }
+            transaction.add_headers_if_nil { request.env }
+            transaction.add_session_data { request.session if request.respond_to? :session }
+            transaction.add_tags(:request_id => request_id) if request_id
             Appsignal::Transaction.complete_current!
           end
         end
@@ -86,10 +86,10 @@ module Appsignal
             transaction.set_action_if_nil("#{channel.class}#unsubscribed")
             transaction.set_metadata("path", request.path)
             transaction.set_metadata("method", "websocket")
-            transaction.set_params_if_nil { request.params }
-            transaction.set_headers_if_nil { request.env }
-            transaction.set_session_data { request.session if request.respond_to? :session }
-            transaction.set_tags(:request_id => request_id) if request_id
+            transaction.add_params_if_nil { request.params }
+            transaction.add_headers_if_nil { request.env }
+            transaction.add_session_data { request.session if request.respond_to? :session }
+            transaction.add_tags(:request_id => request_id) if request_id
             Appsignal::Transaction.complete_current!
           end
         end

data/lib/appsignal/hooks/active_job.rb

@@ -58,10 +58,10 @@ module Appsignal
             end
 
           if transaction
-            transaction.set_params_if_nil(job["arguments"])
+            transaction.add_params_if_nil(job["arguments"])
 
             transaction_tags = ActiveJobHelpers.transaction_tags_for(job)
-            transaction.set_tags(transaction_tags)
+            transaction.add_tags(transaction_tags)
 
             transaction.set_action(ActiveJobHelpers.action_name(job))
           end

data/lib/appsignal/hooks/at_exit.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class AtExit < Appsignal::Hooks::Hook
+      register :at_exit
+
+      def dependencies_present?
+        true
+      end
+
+      def install
+        return unless Appsignal.config[:enable_at_exit_reporter]
+
+        Kernel.at_exit(&AtExitCallback.method(:call))
+      end
+
+      # Report any unhandled errors and will crash the Ruby process.
+      #
+      # If this error was previously reported by any of our instrumentation,
+      # the error will not also be reported here. This way we don't report an
+      # error from a Rake task or instrumented script twice.
+      class AtExitCallback
+        def self.call
+          error = $! # rubocop:disable Style/SpecialGlobalVars
+          return if Appsignal::Transaction.last_errors.include?(error)
+
+          Appsignal.report_error(error) do |transaction|
+            transaction.set_namespace("unhandled")
+          end
+          Appsignal.stop("at_exit")
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks.rb

@@ -69,25 +69,10 @@ module Appsignal
         text.size > 200 ? "#{text[0...197]}..." : text
       end
     end
-
-    # Alias integration constants that have moved to their own module.
-    def self.const_missing(name)
-      case name
-      when :SidekiqPlugin
-        require "appsignal/integrations/sidekiq"
-        callers = caller
-        Appsignal::Utils::StdoutAndLoggerMessage.warning \
-          "The constant Appsignal::Hooks::SidekiqPlugin has been deprecated. " \
-            "Please update the constant name to Appsignal::Integrations::SidekiqMiddleware " \
-            "in the following file to remove this message.\n#{callers.first}"
-        Appsignal::Integrations::SidekiqMiddleware
-      else
-        super
-      end
-    end
   end
 end
 
+require "appsignal/hooks/at_exit"
 require "appsignal/hooks/action_cable"
 require "appsignal/hooks/action_mailer"
 require "appsignal/hooks/active_job"

data/lib/appsignal/integrations/action_cable.rb

@@ -19,11 +19,11 @@ module Appsignal
           transaction.set_error(exception)
           raise exception
         ensure
-          transaction.set_params_if_nil(args.first)
           transaction.set_action_if_nil("#{self.class}##{args.first["action"]}")
+          transaction.add_params_if_nil(args.first)
           transaction.set_metadata("path", request.path)
           transaction.set_metadata("method", "websocket")
-          transaction.set_tags(:request_id => request_id) if request_id
+          transaction.add_tags(:request_id => request_id) if request_id
           Appsignal::Transaction.complete_current!
         end
       end

data/lib/appsignal/integrations/capistrano/appsignal.cap

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Capistrano 3 integration
 namespace :appsignal do
   task :deploy do
     appsignal_env = fetch(:appsignal_env,
@@ -10,12 +11,9 @@ namespace :appsignal do
     appsignal_config = Appsignal::Config.new(
       Dir.pwd,
       appsignal_env,
-      {},
       Logger.new(StringIO.new)
     ).tap do |c|
-      fetch(:appsignal_config, {}).each do |key, value|
-        c[key] = value
-      end
+      c.merge_dsl_options(fetch(:appsignal_config, {}))
       c.validate
     end
 

data/lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb

@@ -19,12 +19,9 @@ module Appsignal
               appsignal_config = Appsignal::Config.new(
                 ENV.fetch("PWD", nil),
                 env,
-                {},
                 Appsignal::Utils::IntegrationLogger.new(StringIO.new)
               ).tap do |c|
-                fetch(:appsignal_config, {}).each do |key, value|
-                  c[key] = value
-                end
+                c.merge_dsl_options(fetch(:appsignal_config, {}))
                 c.validate
               end
 

data/lib/appsignal/integrations/delayed_job_plugin.rb

@@ -32,14 +32,14 @@ module Appsignal
           # ActiveJob
           job_data = payload.job_data
           transaction.set_action_if_nil("#{job_data["job_class"]}#perform")
-          transaction.set_params_if_nil(job_data.fetch("arguments", {}))
+          transaction.add_params_if_nil(job_data.fetch("arguments", {}))
         else
           # Delayed Job
           transaction.set_action_if_nil(action_name_from_payload(payload, job.name))
-          transaction.set_params_if_nil(extract_value(payload, :args, {}))
+          transaction.add_params_if_nil(extract_value(payload, :args, {}))
         end
 
-        transaction.set_tags(
+        transaction.add_tags(
           :id => extract_value(job, :id, nil, true),
           :queue => extract_value(job, :queue),
           :priority => extract_value(job, :priority, 0),

data/lib/appsignal/integrations/que.rb

@@ -16,8 +16,8 @@ module Appsignal
         ensure
           local_attrs = respond_to?(:que_attrs) ? que_attrs : attrs
           transaction.set_action_if_nil("#{local_attrs[:job_class]}#run")
-          transaction.set_params_if_nil(local_attrs[:args])
-          transaction.set_tags(
+          transaction.add_params_if_nil(local_attrs[:args])
+          transaction.add_tags(
             "id" => local_attrs[:job_id] || local_attrs[:id],
             "queue" => local_attrs[:queue],
             "run_at" => local_attrs[:run_at].to_s,

data/lib/appsignal/integrations/railtie.rb

@@ -27,6 +27,7 @@ module Appsignal
       end
 
       def self.on_load(app)
+        load_default_config
         Appsignal::Integrations::Railtie.add_instrumentation_middleware(app)
 
         return unless app.config.appsignal.start_at == :on_load
@@ -38,17 +39,19 @@ module Appsignal
         Appsignal::Integrations::Railtie.start if app.config.appsignal.start_at == :after_initialize
       end
 
+      def self.load_default_config
+        Appsignal::Config.add_loader_defaults(
+          :rails,
+          :root_path => Rails.root,
+          :env => Rails.env,
+          :name => Appsignal::Utils::RailsHelper.detected_rails_app_name,
+          :log_path => Rails.root.join("log")
+        )
+      end
+
       def self.start
-        unless Appsignal.config
-          Appsignal._config = Appsignal::Config.new(
-            Rails.root,
-            Rails.env,
-            :name => Appsignal::Utils::RailsHelper.detected_rails_app_name,
-            :log_path => Rails.root.join("log")
-          )
-        end
         Appsignal.start
-        initialize_error_reporter
+        initialize_error_reporter if Appsignal.started?
       end
 
       def self.add_instrumentation_middleware(app)
@@ -71,31 +74,27 @@ module Appsignal
       end
     end
 
-    # Report errors reported by the Rails error reporter.
+    # Report errors reported by the Rails error reporter using {Appsignal.report_error}.
     #
-    # We only report that are not reraised by the error reporter, using
-    # `Rails.error.handle`.
     # @api private
     class RailsErrorReporterSubscriber
       class << self
-        def report(error, handled:, severity:, context: {}, source: nil)
-          # Ignore not handled errors. They are reraised by the error reporter
-          # and are caught and recorded by our Rails middleware.
-          return unless handled
-
-          Appsignal.send_error(error) do |transaction|
-            namespace, action_name, path, method, params, tags, custom_data =
-              context_for(context.dup)
-            transaction.set_namespace(namespace) if namespace
+        def report(error, handled:, severity:, context: {}, source: nil) # rubocop:disable Lint/UnusedMethodArgument
+          is_rails_runner = source == "application.runner.railties"
+          namespace, action_name, tags, custom_data = context_for(context.dup)
+
+          Appsignal.report_error(error) do |transaction|
+            if namespace
+              transaction.set_namespace(namespace)
+            elsif is_rails_runner
+              transaction.set_namespace("runner")
+            end
             transaction.set_action(action_name) if action_name
-            transaction.set_metadata("path", path)
-            transaction.set_metadata("method", method)
-            transaction.set_params_if_nil(params)
-            transaction.set_custom_data(custom_data) if custom_data
+            transaction.add_custom_data(custom_data) if custom_data
 
             tags[:severity] = severity
             tags[:source] = source.to_s if source
-            transaction.set_tags(tags)
+            transaction.add_tags(tags)
           end
         end
 
@@ -103,40 +102,8 @@ module Appsignal
 
         def context_for(context)
           tags = {}
-          custom_data = nil
 
           appsignal_context = context.delete(:appsignal)
-          # Fetch the namespace and action name based on the Rails execution
-          # context.
-          controller = context.delete(:controller)
-          path = nil
-          method = nil
-          params = nil
-          if controller
-            namespace = Appsignal::Transaction::HTTP_REQUEST
-            action_name = "#{controller.class.name}##{controller.action_name}"
-            unless controller.request.nil?
-              path = controller.request.path
-              method = controller.request.method
-              params = controller.request.filtered_parameters
-            end
-          end
-          # ActiveJob transaction naming relies on the current AppSignal
-          # transaction namespace and action name copying done after this.
-          context.delete(:job)
-
-          # Copy the transaction action name, namespace and other data from
-          # the currently active transaction, if not already set.
-          if Appsignal::Transaction.current?
-            current_transaction = Appsignal::Transaction.current
-            namespace = current_transaction.namespace
-
-            transaction_action = current_transaction.action
-            action_name = current_transaction.action if transaction_action
-
-            current_tags = current_transaction.tags
-            tags.merge!(current_tags) if current_tags
-          end
 
           # Use the user override set in the context
           if appsignal_context
@@ -151,7 +118,7 @@ module Appsignal
           end
           tags.merge!(context)
 
-          [namespace, action_name, path, method, params, tags, custom_data]
+          [namespace, action_name, tags, custom_data]
         end
       end
     end

data/lib/appsignal/integrations/rake.rb

@@ -24,8 +24,8 @@ module Appsignal
           # Format given arguments and cast to hash if possible
           params, _ = args
           params = params.to_hash if params.respond_to?(:to_hash)
-          transaction.set_params_if_nil(params)
           transaction.set_action(name)
+          transaction.add_params_if_nil(params)
           transaction.complete
         end
       end
@@ -33,7 +33,7 @@ module Appsignal
       private
 
       def _appsignal_create_transaction
-        Appsignal::Transaction.create(Appsignal::Transaction::BACKGROUND_JOB)
+        Appsignal::Transaction.create("rake")
       end
     end
 

data/lib/appsignal/integrations/resque.rb

@@ -21,8 +21,8 @@ module Appsignal
               ResqueHelpers.arguments(payload),
               Appsignal.config[:filter_parameters]
             )
-          transaction.set_params_if_nil(args)
-          transaction.set_tags("queue" => queue)
+          transaction.add_params_if_nil(args)
+          transaction.add_tags("queue" => queue)
 
           Appsignal::Transaction.complete_current!
         end

data/lib/appsignal/integrations/shoryuken.rb

@@ -15,10 +15,10 @@ module Appsignal
         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
+        transaction.add_params_if_nil { fetch_args(batch, sqs_msg, body) }
+        transaction.add_tags(attributes)
+        transaction.add_tags("queue" => queue)
+        transaction.add_tags("batch" => true) if batch
 
         if attributes.key?("SentTimestamp")
           transaction.set_queue_start(Time.at(attributes["SentTimestamp"].to_i).to_i)

data/lib/appsignal/integrations/sidekiq.rb

@@ -41,7 +41,7 @@ module Appsignal
           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])
+          transaction.add_params_if_nil(:jobstr => sidekiq_context[:jobstr])
           transaction.set_error(exception)
         end
 
@@ -73,10 +73,10 @@ module Appsignal
         raise exception
       ensure
         if transaction
-          transaction.set_params_if_nil { parse_arguments(item) }
+          transaction.add_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"])
+          transaction.add_tags(:request_id => item["jid"])
           Appsignal::Transaction.complete_current! unless exception
 
           queue = item["queue"] || "unknown"

data/lib/appsignal/integrations/webmachine.rb

@@ -12,14 +12,14 @@ module Appsignal
           else
             Appsignal::Transaction.create(Appsignal::Transaction::HTTP_REQUEST)
           end
+        transaction.add_params_if_nil { request.query }
+        transaction.add_headers_if_nil { request.headers if request.respond_to?(:headers) }
 
         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! unless has_parent_transaction
       end

data/lib/appsignal/loaders.rb

@@ -85,7 +85,7 @@ module Appsignal
       end
 
       def register_config_defaults(options)
-        Appsignal::Config.add_loader_defaults(self.class.loader_name, options)
+        Appsignal::Config.add_loader_defaults(self.class.loader_name, **options)
       end
     end
   end

data/lib/appsignal/probes.rb

@@ -29,15 +29,6 @@ module Appsignal
         probes[key]
       end
 
-      # @deprecated Use {Appsignal::Probes.register} instead.
-      def register(name, probe)
-        Appsignal::Utils::StdoutAndLoggerMessage.warning(
-          "The method 'Appsignal::Probes.probes.register' is deprecated. " \
-            "Use 'Appsignal::Probes.register' instead."
-        )
-        Appsignal::Probes.register(name, probe)
-      end
-
       # @api private
       def internal_register(name, probe)
         if probes.key?(name)

data/lib/appsignal/rack/abstract_middleware.rb

@@ -136,21 +136,19 @@ module Appsignal
       # Override this method to set metadata after the app is called.
       # Call `super` to also include the default set metadata.
       def add_transaction_metadata_after(transaction, request)
-        default_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_session_data_if_nil do
+        transaction.add_params { params_for(request) }
+        transaction.add_session_data do
           request.session if request.respond_to?(:session)
         end
-        transaction.set_headers_if_nil do
+        transaction.add_headers 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
@@ -179,26 +177,6 @@ module Appsignal
       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/event_handler.rb

@@ -110,9 +110,9 @@ module Appsignal
 
         self.class.safe_execution("Appsignal::Rack::EventHandler#on_finish") do
           transaction.finish_event("process_request.rack", "", "")
-          transaction.set_params_if_nil { request.params }
-          transaction.set_headers_if_nil { request.env }
-          transaction.set_session_data_if_nil do
+          transaction.add_params_if_nil { request.params }
+          transaction.add_headers_if_nil { request.env }
+          transaction.add_session_data_if_nil do
             request.session if request.respond_to?(:session)
           end
           queue_start = Appsignal::Rack::Utils.queue_start_from(request.env)
@@ -124,7 +124,7 @@ module Appsignal
               500
             end
           if response_status
-            transaction.set_tags(:response_status => response_status)
+            transaction.add_tags(:response_status => response_status)
             Appsignal.increment_counter(
               :response_status,
               1,

data/lib/appsignal/rack/rails_instrumentation.rb

@@ -19,7 +19,7 @@ module Appsignal
         transaction.set_action_if_nil("#{controller.class}##{controller.action_name}") if controller
 
         request_id = request.env["action_dispatch.request_id"]
-        transaction.set_tags(:request_id => request_id) if request_id
+        transaction.add_tags(:request_id => request_id) if request_id
 
         super
       end

data/lib/appsignal/rack.rb

@@ -37,30 +37,5 @@ module Appsignal
         end
       end
     end
-
-    # Alias constants that have moved with a warning message that points to the
-    # place to update the reference.
-    def self.const_missing(name)
-      case name
-      when :GenericInstrumentation
-        require "appsignal/rack/generic_instrumentation"
-
-        callers = caller
-        Appsignal::Utils::StdoutAndLoggerMessage.warning \
-          "The constant Appsignal::Rack::GenericInstrumentation has been deprecated. " \
-            "Please use the new Appsignal::Rack::InstrumentationMiddleware middleware. " \
-            "This new middleware does not default the action name to 'unknown'. " \
-            "Set the action name for the endpoint using the Appsignal.set_action helper. " \
-            "Read our Rack docs for more information " \
-            "https://docs.appsignal.com/ruby/integrations/rack.html " \
-            "Update the constant name to " \
-            "Appsignal::Rack::InstrumentationMiddleware in the following file to " \
-            "remove this message.\n#{callers.first}"
-        # Return the alias so it can't ever get stuck in a recursive loop
-        Appsignal::Rack::GenericInstrumentationAlias
-      else
-        super
-      end
-    end
   end
 end