Adds transaction outcomes to Racecar transactions

Author: ErvalhouS

lib/elastic_apm/spies/racecar.rb

@@ -33,14 +33,24 @@ class ConsumerSubscriber < ActiveSupport::Subscriber
           def start_process_message(event)
             start_process_transaction(event: event, kind: 'process_message')
           end
-          def process_message(_event)
+          def process_message(event)
+            transaction = ElasticAPM.current_transaction
+            error_present = !event.payload[:unrecoverable_delivery_error].nil?
+            transaction.outcome = error_present ? Transaction::Outcome::FAILURE : Transaction::Outcome::SUCCESS
+            transaction.done(error_present ? :error : :success)
+
             ElasticAPM.end_transaction
           end
 
           def start_process_batch(event)
             start_process_transaction(event: event, kind: 'process_batch')
           end
-          def process_batch(_event)
+          def process_batch(event)
+            transaction = ElasticAPM.current_transaction
+            error_present = !event.payload[:unrecoverable_delivery_error].nil?
+            transaction.outcome = error_present ? Transaction::Outcome::FAILURE : Transaction::Outcome::SUCCESS
+            transaction.done(error_present ? :error : :success)
+
             ElasticAPM.end_transaction
           end
 

spec/elastic_apm/spies/racecar_spec.rb

@@ -24,18 +24,18 @@
   require 'racecar'
   module ElasticAPM
     RSpec.describe 'Spy: Racecar', :intercept do
+      let(:instrumentation_payload) {
+        { consumer_class: 'SpecConsumer',
+          topic:          'spec_topic',
+          partition:      '0',
+          offset:         '1',
+          create_time:    Time.now,
+          key:            '1',
+          value:          {key: 'value'},
+          headers:        {key: 'value'} }
+      }
       it 'captures the instrumentation' do
         with_agent do
-          instrumentation_payload = {
-            consumer_class: 'SpecConsumer',
-            topic:          'spec_topic',
-            partition:      '0',
-            offset:         '1',
-            create_time:    Time.now,
-            key:            '1',
-            value:          {key: 'value'},
-            headers:        {key: 'value'}
-          }
           ActiveSupport::Notifications.instrument('start_process_message.racecar', instrumentation_payload)
           ActiveSupport::Notifications.instrument('process_message.racecar', instrumentation_payload) do
             # this is the body of the racecar consumer #process method
@@ -47,6 +47,41 @@ module ElasticAPM
           expect(first_transaction.context.service.framework.name).to eq('racecar')
         end
       end
+
+      describe 'transaction outcome' do
+        it 'records success when no delivery error happen' do
+          with_agent do
+            ActiveSupport::Notifications.instrument('start_process_message.racecar', instrumentation_payload)
+            ActiveSupport::Notifications.instrument('process_message.racecar', instrumentation_payload) do
+              # this is the body of the racecar consumer #process method
+            end
+            first_transaction = @intercepted.transactions.first
+            expect(first_transaction.outcome).to eq(Transaction::Outcome::SUCCESS)
+          end
+        end
+        it 'records failure when with a unrecoverable delivery error' do
+          instrumentation_payload[:unrecoverable_delivery_error] = true
+          with_agent do
+            ActiveSupport::Notifications.instrument('start_process_message.racecar', instrumentation_payload)
+            ActiveSupport::Notifications.instrument('process_message.racecar', instrumentation_payload) do
+              # this is the body of the racecar consumer #process method
+            end
+            first_transaction = @intercepted.transactions.first
+            expect(first_transaction.outcome).to eq(Transaction::Outcome::FAILURE)
+          end
+        end
+        it 'records failure when with a recoverable delivery error' do
+          instrumentation_payload[:unrecoverable_delivery_error] = false
+          with_agent do
+            ActiveSupport::Notifications.instrument('start_process_message.racecar', instrumentation_payload)
+            ActiveSupport::Notifications.instrument('process_message.racecar', instrumentation_payload) do
+              # this is the body of the racecar consumer #process method
+            end
+            first_transaction = @intercepted.transactions.first
+            expect(first_transaction.outcome).to eq(Transaction::Outcome::FAILURE)
+          end
+        end
+      end
     end
   end