appsignal 3.4.16 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82900f113d16dc43d6fb02e6f2dfd0f2f49c3aefef69f7c7e4d1987762f119d9
-  data.tar.gz: 9e88ecb0449d0ce64b0e9bbe325834542f08016f31519005a65f077dd34c7979
+  metadata.gz: fc20e180510d89079b968f752fe4378590ef2edc3c881af7390e4eca883829c3
+  data.tar.gz: e475459d746362fe4a1d66ea260596dd376dd78de5ce0c6192784a61afcaa17b
 SHA512:
-  metadata.gz: 0c616cd08fc97b3619267546bb35bc3933831a7bf45478283cd4a0510f79e78b735fb4de3ccc0400618f7495aa01c5f2a5177bd39bb12362f7de462b3e75268d
-  data.tar.gz: 84f42f07b0ca6611326d8f3fd868221432bd81323837d2586be7b4245559ec94881275a3cf2c4b6899881098bffca72e1a82974bdc8b8e7448b4e04b71fbc781
+  metadata.gz: e794952ff70e7b8170bb173ee594cfa609a28cc713e04959a3bc97d274e7c547519f54404dfa2a1ac9d71c0ee47cb999bbbc21f19a66e2cef3d39d88f0ac30f7
+  data.tar.gz: 62c66a4814ee5663d7db3a1c2c1e844e5024c152425998685c12cd48e52fad3d6a63027457c3f599d2e506ca5b924734d1d48ca7c7d2b348ab80d2d831260ec3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.5.0
+
+### Added
+
+- [cee1676f](https://github.com/appsignal/appsignal-ruby/commit/cee1676fc5539e380c58e8a824b5c59c3c927119) minor - Nested errors are now supported. The error causes are stored as sample data on the transaction so they can be displayed in the UI.
+
 ## 3.4.16
 
 ### Changed

data/lib/appsignal/transaction.rb

@@ -12,6 +12,7 @@ module Appsignal
     ALLOWED_TAG_KEY_TYPES = [Symbol, String].freeze
     ALLOWED_TAG_VALUE_TYPES = [Symbol, String, Integer].freeze
     BREADCRUMB_LIMIT = 20
+    ERROR_CAUSES_LIMIT = 10
 
     class << self
       def create(id, namespace, request, options = {})
@@ -374,6 +375,41 @@ module Appsignal
         cleaned_error_message(error),
         backtrace ? Appsignal::Utils::Data.generate(backtrace) : Appsignal::Extension.data_array_new
       )
+
+      root_cause_missing = false
+
+      causes = []
+      while error
+        error = error.cause
+
+        break unless error
+
+        if causes.length >= ERROR_CAUSES_LIMIT
+          Appsignal.logger.debug "Appsignal::Transaction#set_error: Error has more " \
+            "than #{ERROR_CAUSES_LIMIT} error causes. Only the first #{ERROR_CAUSES_LIMIT} " \
+            "will be reported."
+          root_cause_missing = true
+          break
+        end
+
+        causes << error
+      end
+
+      return if causes.empty?
+
+      causes_sample_data = causes.map do |e|
+        {
+          :name => e.class.name,
+          :message => cleaned_error_message(e)
+        }
+      end
+
+      causes_sample_data.last[:is_root_cause] = false if root_cause_missing
+
+      set_sample_data(
+        "error_causes",
+        causes_sample_data
+      )
     end
     alias_method :add_exception, :set_error
 

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.4.16"
+  VERSION = "3.5.0"
 end

data/spec/lib/appsignal/transaction_spec.rb

@@ -788,6 +788,99 @@ describe Appsignal::Transaction do
         end
       end
 
+      context "when the error has no causes" do
+        it "should not send the causes information as sample data" do
+          expect(transaction.ext).to_not receive(:set_sample_data)
+
+          transaction.set_error(error)
+        end
+      end
+
+      context "when the error has multiple causes" do
+        let(:error) do
+          e = ExampleStandardError.new("test message")
+          e2 = RuntimeError.new("cause message")
+          e3 = StandardError.new("cause message 2")
+          allow(e).to receive(:backtrace).and_return(["line 1"])
+          allow(e).to receive(:cause).and_return(e2)
+          allow(e2).to receive(:cause).and_return(e3)
+          e
+        end
+
+        it "sends the causes information as sample data" do
+          expect(transaction.ext).to receive(:set_error).with(
+            "ExampleStandardError",
+            "test message",
+            Appsignal::Utils::Data.generate(["line 1"])
+          )
+
+          expect(transaction.ext).to receive(:set_sample_data).with(
+            "error_causes",
+            Appsignal::Utils::Data.generate(
+              [
+                {
+                  :name => "RuntimeError",
+                  :message => "cause message"
+                },
+                {
+                  :name => "StandardError",
+                  :message => "cause message 2"
+                }
+              ]
+            )
+          )
+
+          expect(Appsignal.logger).to_not receive(:debug)
+
+          transaction.set_error(error)
+        end
+      end
+
+      context "when the error has too many causes" do
+        let(:error) do
+          e = ExampleStandardError.new("root cause error")
+
+          11.times do |i|
+            next_e = ExampleStandardError.new("wrapper error #{i}")
+            allow(next_e).to receive(:cause).and_return(e)
+            e = next_e
+          end
+
+          allow(e).to receive(:backtrace).and_return(["line 1"])
+          e
+        end
+
+        it "sends only the first causes as sample data" do
+          expect(transaction.ext).to receive(:set_error).with(
+            "ExampleStandardError",
+            "wrapper error 10",
+            Appsignal::Utils::Data.generate(["line 1"])
+          )
+
+          expected_error_causes = Array.new(10) do |i|
+            {
+              :name => "ExampleStandardError",
+              :message => "wrapper error #{9 - i}"
+            }
+          end
+
+          expected_error_causes.last[:is_root_cause] = false
+
+          expect(transaction.ext).to receive(:set_sample_data).with(
+            "error_causes",
+            Appsignal::Utils::Data.generate(expected_error_causes)
+          )
+
+          expect(Appsignal.logger).to receive(:debug).with(
+            "Appsignal::Transaction#set_error: Error has more " \
+              "than 10 error causes. Only the first 10 " \
+              "will be reported."
+          )
+
+          transaction.set_error(error)
+        end
+      end
+
       context "when error message is nil" do
         let(:error) do
           e = ExampleStandardError.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.4.16
+  version: 3.5.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack