eventboss 1.9.5 → 1.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00edb1f9a676e16224c4914f8411c073bd9f29658d1b878b4b6bb5e4639d8126
-  data.tar.gz: 42f8f5f0d71c515203e9601ec327717b026d43855cea1d0915901f8de38aafd7
+  metadata.gz: 32c271ea01136f0e14f98ae6163f543f58edd8d45dd7cc0aa30c7facfda6fb44
+  data.tar.gz: 7c45094a9e1e205f90759bcf3f11a261cafcef2b9e1e51e65c3948bad9b3ae50
 SHA512:
-  metadata.gz: 83eb1f2faa512f4147e4a3b4f523b3a0d60f4429bd27932da4f811ab8c7a006457abc15b7f5ef4f7fea734dd4c736d6e35e5d598c292097020156ca94cde42ac
-  data.tar.gz: e623aa96514dd1c4be6c97c64d24c4b3a5d0fe54740636437b02bbd31d821cae1fd607b28009b6fb6337819cdb0f992464860c39a5336dcd8ac650e1daaa3df5
+  metadata.gz: a2e07d2f3c12b4e3f5c5c5c319b9f6663c498b8e398e6da7e955fcec98372601d3f0365d60d9dd32f7ae891d79bc5c6d824fb574f1a85e6d710013106516f434
+  data.tar.gz: 12884bb40cfd6ee48b294e10c4b92ab2cb230ee32274dc3d271a4f348c9bbf174d7a72ed455f314034af8e9579ae97e9e88d67b44a82b47c526b4bfb7b2da52e

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.9.7]
+
+- Fix undefined method 'set_data' for nil span in Sentry integration
+
+## [1.9.6]
+
+### Added
+- Enhanced Sentry integration
+
+### Deprecated
+- `Eventboss::ErrorHandlers::Sentry` is now deprecated in favor of `Eventboss::Sentry::ErrorHandler`
+
 ## [1.9.2] - 2025-01-21
 
 - Fix typo in instance var during shut down

data/README.md

@@ -157,6 +157,17 @@ Eventboss.configure do |config|
 end
 ```
 
+### Sentry Integration
+
+Eventboss provides built-in integration with [Sentry](https://sentry.io/) for error monitoring and performance tracking. The simplest way to enable Sentry integration is to require the configuration module:
+
+```ruby
+require 'eventboss/sentry/configure'
+```
+
+For more advanced configuration options, you can manually configure the integration. Please inspect [lib/eventboss/sentry/configure.rb](lib/eventboss/sentry/configure.rb) to see options.
+```
+
 ### Middlewares
 
 Server middlewares intercept the execution of your `Listeners`. You can use to extract and run common functions on every message received.

data/lib/eventboss/error_handlers/sentry.rb

@@ -1,6 +1,14 @@
 module Eventboss
   module ErrorHandlers
     class Sentry
+      def initialize
+        warn "[DEPRECATED] Eventboss::ErrorHandlers::Sentry is deprecated. " \
+             "Use Eventboss::Sentry::ErrorHandler instead. " \
+             "For automatic configuration, require 'eventboss/sentry/configure'. " \
+             "This class will be removed in a future version."
+        super
+      end
+
       def call(exception, context = {})
         eventboss_context = { component: 'eventboss' }
         eventboss_context[:action] = context[:processor].class.to_s if context[:processor]

data/lib/eventboss/long_poller.rb

@@ -73,7 +73,9 @@ module Eventboss
       @client.receive_message(
         queue_url: queue.url,
         max_number_of_messages: 10,
-        wait_time_seconds: TIME_WAIT
+        wait_time_seconds: TIME_WAIT,
+        attribute_names: ['SentTimestamp', 'ApproximateReceiveCount'],
+        message_attribute_names: ['sentry-trace', 'baggage', 'sentry_user']
       ).messages
     end
   end

data/lib/eventboss/publisher.rb

@@ -10,19 +10,48 @@ module Eventboss
     end
 
     def publish(payload)
-      topic_arn = Topic.build_arn(event_name: event_name, source_app: source)
-      sns_client.publish(
-        topic_arn: topic_arn,
-        message: json_payload(payload)
-      )
+      with_sentry_span do
+        sns_client.publish(**build_sns_params(payload))
+      end
     end
 
     private
 
     attr_reader :event_name, :sns_client, :configuration, :source
 
+    def sentry_enabled?
+      defined?(::Eventboss::Sentry::Integration) && ::Sentry.initialized?
+    end
+
+    def build_sns_params(payload)
+      {
+        topic_arn: Topic.build_arn(event_name: event_name, source_app: source),
+        message: json_payload(payload),
+        message_attributes: sentry_enabled? ? build_sns_message_attributes : {}
+      }
+    end
+
+    def with_sentry_span
+      return yield unless sentry_enabled?
+
+      queue_name = Queue.build_name(destination: source, event_name: event_name, env: Eventboss.env, source_app: source)
+
+      ::Sentry.with_child_span(op: 'queue.publish', description: "Eventboss push #{source}/#{event_name}") do |span|
+        span.set_data(::Sentry::Span::DataConventions::MESSAGING_DESTINATION_NAME, ::Eventboss::Sentry::Context.queue_name_for_sentry(queue_name)) if span
+
+        message = yield
+
+        span.set_data(::Sentry::Span::DataConventions::MESSAGING_MESSAGE_ID, message.message_id) if span
+        message
+      end
+    end
+
     def json_payload(payload)
       payload.is_a?(String) ? payload : payload.to_json
     end
+
+    def build_sns_message_attributes
+      ::Eventboss::Sentry::Context.build_sns_message_attributes
+    end
   end
-end
+end

data/lib/eventboss/sentry/configure.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'integration'
+
+# Auto configure eventboss to use sentry
+
+Eventboss.configure do |config|
+  config.server_middleware.add Eventboss::Sentry::ServerMiddleware
+  config.error_handlers << Eventboss::Sentry::ErrorHandler.new
+end
+

data/lib/eventboss/sentry/context.rb

@@ -0,0 +1,35 @@
+module Eventboss
+  module Sentry
+    class Context
+      # since sentry has env selector, we can remove it from queue names
+      QUEUES_WITHOUT_ENV = Hash.new do |hash, key|
+        hash[key] = key
+                      .gsub(/-#{Eventboss.env}-deadletter$/, '-ENV-deadletter')
+                      .gsub(/-#{Eventboss.env}$/, '-ENV')
+      end
+
+      def self.queue_name_for_sentry(queue_name)
+        QUEUES_WITHOUT_ENV[queue_name]
+      end
+
+      # Constructs SNS message attributes for Sentry trace propagation.
+      def self.build_sns_message_attributes
+        attributes = ::Sentry.get_trace_propagation_headers
+                             .slice('sentry-trace', 'baggage')
+                             .transform_values do |header_value|
+          { string_value: header_value, data_type: 'String' }
+        end
+
+        user = ::Sentry.get_current_scope&.user
+        if user && !user.empty?
+          attributes['sentry_user'] = {
+            string_value: user.to_json,
+            data_type: 'String'
+          }
+        end
+
+        attributes
+      end
+    end
+  end
+end

data/lib/eventboss/sentry/error_handler.rb

@@ -0,0 +1,15 @@
+module Eventboss
+  module Sentry
+    class ErrorHandler
+      def call(exception, _context = {})
+        return unless ::Sentry.initialized?
+
+        Eventboss::Sentry::Integration.capture_exception(
+          exception,
+          contexts: { eventboss: { } },
+          hint: { background: false }
+        )
+      end
+    end
+  end
+end

data/lib/eventboss/sentry/integration.rb

@@ -0,0 +1,15 @@
+require 'sentry-ruby'
+require 'sentry/integrable'
+require_relative 'error_handler'
+require_relative 'context'
+require_relative 'server_middleware'
+
+module Eventboss
+  module Sentry
+    class Integration
+      extend ::Sentry::Integrable
+
+      register_integration name: "eventboss", version: Eventboss::VERSION
+    end
+  end
+end

data/lib/eventboss/sentry/server_middleware.rb

@@ -0,0 +1,95 @@
+module Eventboss
+  module Sentry
+    class ServerMiddleware < Eventboss::Middleware::Base
+      OP_NAME = 'queue.process'
+      SPAN_ORIGIN = 'auto.queue.eventboss'
+
+      def call(work)
+        return yield unless ::Sentry.initialized?
+
+        ::Sentry.clone_hub_to_current_thread
+        scope = ::Sentry.get_current_scope
+        scope.clear
+        if (user = extract_sentry_user(work))
+          scope.set_user(user)
+        end
+        scope.set_tags(queue: extract_queue_name(work), message_id: work.message.message_id)
+        scope.set_transaction_name(extract_transaction_name(work), source: :task)
+        transaction = start_transaction(scope, work)
+
+        if transaction
+          scope.set_span(transaction)
+          transaction.set_data(::Sentry::Span::DataConventions::MESSAGING_MESSAGE_ID, work.message.message_id)
+          transaction.set_data(::Sentry::Span::DataConventions::MESSAGING_DESTINATION_NAME, extract_queue_name(work))
+
+          if (latency = extract_latency(work.message))
+            transaction.set_data(::Sentry::Span::DataConventions::MESSAGING_MESSAGE_RECEIVE_LATENCY, latency)
+          end
+
+          if (retry_count = extract_receive_count(work.message))
+            transaction.set_data(::Sentry::Span::DataConventions::MESSAGING_MESSAGE_RETRY_COUNT, retry_count)
+          end
+        end
+
+        begin
+          yield
+        rescue StandardError
+          finish_transaction(transaction, 500)
+          raise
+        end
+
+        finish_transaction(transaction, 200)
+      end
+
+      def start_transaction(scope, work)
+        options = {
+          name: scope.transaction_name,
+          source: scope.transaction_source,
+          op: OP_NAME,
+          origin: SPAN_ORIGIN
+        }
+
+        env = {
+          'sentry-trace' => work.message.message_attributes['sentry-trace']&.string_value,
+          'baggage' => work.message.message_attributes['baggage']&.string_value
+        }
+
+        transaction = ::Sentry.continue_trace(env, **options)
+        ::Sentry.start_transaction(transaction: transaction, **options)
+      end
+
+      def finish_transaction(transaction, status)
+        return unless transaction
+
+        transaction.set_http_status(status)
+        transaction.finish
+      end
+
+      def extract_sentry_user(work)
+        if (value = work.message.message_attributes["sentry_user"]&.string_value)
+          JSON.parse(value)
+        end
+      end
+
+      def extract_transaction_name(work)
+        "Eventboss/#{work.listener.to_s}"
+      end
+
+      def extract_queue_name(work)
+        ::Eventboss::Sentry::Context.queue_name_for_sentry(work.queue.name)
+      end
+
+      def extract_latency(message)
+        if sent_timestamp = message.attributes.fetch('SentTimestamp', nil)
+          Time.now - Time.at(sent_timestamp.to_i / 1000.0)
+        end
+      end
+
+      def extract_receive_count(message)
+        if receive_count = message.attributes.fetch('ApproximateReceiveCount', nil)
+          receive_count.to_i - 1
+        end
+      end
+    end
+  end
+end

data/lib/eventboss/version.rb

@@ -1,3 +1,3 @@
 module Eventboss
-  VERSION = "1.9.5"
+  VERSION = "1.9.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eventboss
 version: !ruby/object:Gem::Version
-  version: 1.9.5
+  version: 1.9.7
 platform: ruby
 authors:
 - AirHelp
@@ -157,6 +157,11 @@ files:
 - lib/eventboss/safe_thread.rb
 - lib/eventboss/scripts.rb
 - lib/eventboss/sender.rb
+- lib/eventboss/sentry/configure.rb
+- lib/eventboss/sentry/context.rb
+- lib/eventboss/sentry/error_handler.rb
+- lib/eventboss/sentry/integration.rb
+- lib/eventboss/sentry/server_middleware.rb
 - lib/eventboss/sns_client.rb
 - lib/eventboss/topic.rb
 - lib/eventboss/unit_of_work.rb