Report Rails runner errors (#1205)

appsignal · Jul 24, 2024 · 4d6add1 · 4d6add1
1 parent 46f23f1
commit 4d6add1
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/.changesets/report-errors-from-rails-runners.md b/.changesets/report-errors-from-rails-runners.md
@@ -0,0 +1,6 @@
+---
+bump: minor
+type: add
+---
+
+Report errors from Rails runners. When a Rails runner reports an unhandled error, it will now report the error in the "runner" namespace.
diff --git a/lib/appsignal/integrations/railtie.rb b/lib/appsignal/integrations/railtie.rb
@@ -79,14 +79,19 @@ def self.initialize_error_reporter
     class RailsErrorReporterSubscriber
       class << self
         def report(error, handled:, severity:, context: {}, source: nil)
+          is_rails_runner = source == "application.runner.railties"
           # Ignore not handled errors. They are reraised by the error reporter
           # and are caught and recorded by our Rails middleware.
-          return unless handled
+          return if !handled && !is_rails_runner
 
           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
+            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)

diff --git a/spec/lib/appsignal/integrations/railtie_spec.rb b/spec/lib/appsignal/integrations/railtie_spec.rb
@@ -225,6 +225,26 @@ def subscribe(subscriber)
 
             expect(created_transactions).to be_empty
           end
+
+          if DependencyHelper.rails7_1_present?
+            it "reports the error if the source is the Rails runner" do
+              expect do
+                with_rails_error_reporter do
+                  expect do
+                    Rails.error.record(:source => "application.runner.railties") do
+                      raise ExampleStandardError, "error message"
+                    end
+                  end.to raise_error(ExampleStandardError, "error message")
+                end
+              end.to change { created_transactions.count }.by(1)
+
+              transaction = last_transaction
+              expect(transaction).to have_namespace("runner")
+              expect(transaction).to_not have_action
+              expect(transaction).to have_error("ExampleStandardError", "error message")
+              expect(transaction).to include_tags("source" => "application.runner.railties")
+            end
+          end
         end
 
         context "when error is handled (not reraised)" do

diff --git a/spec/support/helpers/dependency_helper.rb b/spec/support/helpers/dependency_helper.rb
@@ -41,6 +41,10 @@ def rails7_present?
     rails_present? && rails_version >= Gem::Version.new("7.0.0")
   end
 
+  def rails7_1_present?
+    rails_present? && rails_version >= Gem::Version.new("7.1.0")
+  end
+
   def active_job_wraps_args?
     rails7_present? || (ruby_3_1_or_newer? && rails6_1_present? && !rails6_1_5_present?)
   end