eventboss 1.9.4 → 1.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7539971f5531148328e2fb1c5f49f356c72bd011ac041c5bb4be7ae60042c9c
-  data.tar.gz: 61bcde73bc9d682981548d3d3ca461fca6299a76a5eb257a30bc1755d2769453
+  metadata.gz: 8cfeed8d922fa6e1c2c54dc1a102cac91cf9aab04eaa09a47cf05f4c54ff494b
+  data.tar.gz: 80c0347ab204fb98721dd119725a74de48d0d5e8b0273690cb792d9f6b14a9ea
 SHA512:
-  metadata.gz: d977ac2326358fcb9aa49167046c95e1e65dc31c9f23cf3af091b35c04b25dd857b8f6c1c7c4c43d70ea8ceb0311d6d7e24e8e7017191e4714648b7ae26da43a
-  data.tar.gz: 5b3a6450ad0ae267fd3222e818a85836bbec8bc3825b7a45fe8d20f4968032877102f799958b14c2a2e2c0e6401457a07b76ed0d348dea898e582b18b63a3c87
+  metadata.gz: 2dcce6ecb9afd37faa61e31f992e69abebfa68ed31e3c794b9854bfa978dfdae29da330ace493c4b995dac1359941ad9369bd647e61546c71ace9a3fead74dc3
+  data.tar.gz: e6e56a441f86bd989a2aa6b6640ded041dfc1d7380b79364718138f34bc3af14677f687cef103e76f57053a989d462cf40dec8129f985796f39eaffff21946a9

data/.github/workflows/publish_gem.yml

@@ -0,0 +1,51 @@
+name: Publish Gem
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          # runs 'bundle install' and caches installed gems automatically
+          bundler-cache: true
+
+      - name: "Publish gem eventboss"
+        shell: bash
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.EVENTBOSS_RUBYGEMS_TOKEN }}
+
+        run: |
+          set -euo pipefail
+          # make this path safe so git commands work on a root-owned mount
+          git config --global --add safe.directory /usr/src/app
+
+          echo "📦 Building & publishing eventboss"
+          # Build the gem
+          gem build eventboss.gemspec
+
+          set +e
+          push_output=$(gem push *.gem 2>&1)
+          push_exit_code=$?
+          set -e
+
+          if [[ $push_exit_code -eq 0 ]]; then
+            echo "✅ Successfully published eventboss!"
+          elif grep -q "already been pushed" <<< "$push_output"; then
+            echo "::warning title=Gem already pushed::Gem eventboss version already published. Skipping this step."
+            echo "::notice title=Skipped publishing::Gem eventboss version already exists."
+            exit 0
+          else
+            echo "::error title=Gem Push Failed::$push_output"
+            exit 1
+          fi

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 .ruby-version
+.idea/

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.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

@@ -108,6 +108,12 @@ Use fixed account ID for localstack setup:
 EVENTBUS_ACCOUNT_ID=000000000000
 ```
 
+### AWS Credentials Validation
+
+When running in container environments with IAM roles (indicated by the presence of `AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE`, which is set automatically by AWS when IAM role is used), Eventboss validates that the AWS client is using the correct credentials provider (`Aws::ECSCredentials`). If the wrong credentials provider is detected, Eventboss will log an error and exit with code 1 to prevent running with invalid credentials.
+
+This feature is particularly useful in Kubernetes environments where pods should be using ECS credentials for IAM role authentication.
+
 Be aware that `eventbus:deadletter:reload` rake task won't load your configuration if you are not using ENVs
  in non Rails app, although to make it work you can extend your `Rakefile` with:
 
@@ -151,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/configuration.rb

@@ -20,6 +20,7 @@ module Eventboss
       :eventboss_account_id,
       :eventboss_use_default_credentials,
       :aws_access_key_id,
+      :aws_container_authorization_token_file,
       :aws_secret_access_key,
       :aws_session_token,
       :aws_sns_endpoint,
@@ -81,7 +82,7 @@ module Eventboss
 
     def credentials
       return Aws::Credentials.new(aws_access_key_id, aws_secret_access_key, aws_session_token) if development_mode?
-        
+
       Aws::Credentials.new(
         aws_access_key_id,
         aws_secret_access_key
@@ -104,6 +105,10 @@ module Eventboss
       defined_or_default('eventboss_use_default_credentials') { ENV['EVENTBOSS_USE_DEFAULT_CREDENTIALS'] == 'true' }
     end
 
+    def aws_container_authorization_token_file
+      defined_or_default('aws_container_authorization_token_file') { ENV['AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE'] }
+    end
+
     def aws_access_key_id
       defined_or_default('aws_access_key_id') { ENV['AWS_ACCESS_KEY_ID'] }
     end

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))
+
+        message = yield
+
+        span.set_data(::Sentry::Span::DataConventions::MESSAGING_MESSAGE_ID, message.message_id)
+        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/runner.rb

@@ -25,6 +25,7 @@ module Eventboss
         Eventboss::DevelopmentMode.setup_infrastructure(queues) if config.development_mode?
 
         begin
+          validate_client!(client, config)
           launcher.start
           handle_signals(self_read, launcher)
         rescue Interrupt
@@ -35,6 +36,18 @@ module Eventboss
 
       private
 
+      def validate_client!(client, config)
+        provider = client.config.credentials.class
+
+        if config.aws_container_authorization_token_file && provider != Aws::ECSCredentials
+          logger.error('runner') do
+            "AWS client was initiated with wrong credentials provider: #{provider}. " \
+            "Expected: Aws::ECSCredentials. Shutting down."
+          end
+          exit 1
+        end
+      end
+
       def setup_signals(signals)
         self_read, self_write = IO.pipe
 

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.4"
+  VERSION = "1.9.6"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: eventboss
 version: !ruby/object:Gem::Version
-  version: 1.9.4
+  version: 1.9.6
 platform: ruby
 authors:
 - AirHelp
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -117,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/bundler_audit.yml"
+- ".github/workflows/publish_gem.yml"
 - ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
@@ -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
@@ -169,7 +174,6 @@ homepage: https://github.com/AirHelp/eventboss
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Eventboss Ruby Client.
 test_files: []