Add sentry middleware #89

andrzejbisewski · 2025-08-18T14:09:59Z

This PR introduces Sentry for Eventboss with performance monitoring, distributed tracing, and enhanced error reporting.

The new Eventboss::Sentry::ServerMiddleware creates transactions for message processing witg context (queue names, message IDs, latency, retry counts)

Simple one-line setup via require 'eventboss/sentry/configure' automatically configures both client and server components. The old Eventboss::ErrorHandlers::Sentry is deprecated

To see it working please see: https://airhelp.sentry.io/insights/backend/queues/?environment=staging&project=4506716776693760&statsPeriod=1h

This branch is currently on staging & production. The staging has newest version deployed ~1h ago

This middleware is based on sidekiq integration

Later i saw this we have in Airhelp already a custome one :D But it is lacking features

seban · 2025-08-18T15:46:31Z

Will it interfere with https://github.com/AirHelp/eventboss/blob/master/lib/eventboss/error_handlers/sentry.rb?

andrzejbisewski · 2025-08-19T08:06:58Z

lib/eventboss/long_poller.rb

        max_number_of_messages: 10,
-        wait_time_seconds: TIME_WAIT
+        wait_time_seconds: TIME_WAIT,
+        attribute_names: ['SentTimestamp', 'ApproximateReceiveCount']


This is to make the SQS return the SentTimestamp and ApproximateReceiveCount

andrzejbisewski · 2025-08-19T08:09:20Z

Will it interfere with https://github.com/AirHelp/eventboss/blob/master/lib/eventboss/error_handlers/sentry.rb?

@seban yes. That one will needed to be deleted. I see no point in keeping it

Copilot

Pull Request Overview

This PR integrates Sentry monitoring and error tracking into the Eventboss gem to provide better observability for message queue processing. The implementation includes distributed tracing support, automatic error capture, and performance monitoring.

Key changes:

Adds Sentry server middleware for automatic transaction tracking and error handling
Implements distributed tracing by propagating Sentry trace headers through message attributes
Updates message polling to fetch necessary attributes for latency and retry count metrics

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
lib/eventboss/sentry/server_middleware.rb	Core middleware that handles Sentry transaction creation, error tracking, and span management for message processing
lib/eventboss/sentry/integration.rb	Sentry integration registration module
lib/eventboss/sentry/error_handler.rb	Custom error handler for capturing exceptions in Sentry
lib/eventboss/sentry/configure.rb	Auto-configuration for adding Sentry middleware and error handlers
lib/eventboss/publisher.rb	Adds trace propagation headers to published messages for distributed tracing
lib/eventboss/long_poller.rb	Updates message fetching to include Sentry trace attributes and timing metadata
spec/eventboss/long_poller_spec.rb	Updates test expectations to include new message attributes
eventboss.gemspec	Adds sentry-ruby as development dependency

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-20T06:24:29Z

lib/eventboss/sentry/error_handler.rb

+
+        Eventboss::Sentry::Integration.capture_exception(
+          exception,
+          contexts: { eventboss: { } },


The empty hash in the eventboss context provides no useful information. Consider adding relevant context data like queue name, message ID, or listener information to help with debugging.

Suggested change

contexts: { eventboss: { } },

eventboss_context = {}

eventboss_context[:queue_name] = _context[:queue_name] if _context.key?(:queue_name)

eventboss_context[:message_id] = _context[:message_id] if _context.key?(:message_id)

eventboss_context[:listener] = _context[:listener] if _context.key?(:listener)

Eventboss::Sentry::Integration.capture_exception(

exception,

contexts: { eventboss: eventboss_context },

We already have that in the middleware

Copilot · 2025-08-20T06:24:30Z

lib/eventboss/sentry/server_middleware.rb

+
+      def extract_sentry_user(work)
+        if (value = work.message.message_attributes["sentry_user"]&.string_value)
+          JSON.parse(value)


JSON parsing can raise JSON::ParserError for malformed data. Consider wrapping this in a rescue block to handle invalid JSON gracefully and prevent crashes during message processing.

Suggested change

JSON.parse(value)

begin

JSON.parse(value)

rescue JSON::ParserError

nil

end

Copilot · 2025-08-20T06:24:30Z

lib/eventboss/publisher.rb

+        { string_value: header_value, data_type: 'String' }
+      end
+      user = ::Sentry.get_current_scope.user
+      if user && !user.empty?


The empty? method may not be available on all user objects returned by Sentry. Consider using a more specific check like user.respond_to?(:empty?) && !user.empty? or checking for specific user attributes.

Suggested change

if user && !user.empty?

if user && user.respond_to?(:empty?) && !user.empty?

Copilot · 2025-08-20T06:24:31Z

eventboss.gemspec

  spec.add_development_dependency "bundler", ">= 1"
  spec.add_development_dependency 'rake', '>= 10.0'
  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sentry-ruby"


Development dependency should specify a version constraint to ensure consistent builds. Consider adding a version requirement like "sentry-ruby", "~> 5.0" or similar.

Suggested change

spec.add_development_dependency "sentry-ruby"

spec.add_development_dependency "sentry-ruby", "~> 5.0"

andrzejbisewski · 2025-08-20T07:00:01Z

lib/eventboss/publisher.rb

+      else
+        publish_without_sentry(payload)
+      end
+    end


We would need to implement client middleware to support it cleanly. But that was never needed and never requested. That can be refactored then to support the current and old needs. Right now i don't want to crystal ball a future use-case

cinkonaap · 2025-08-20T08:55:33Z

lib/eventboss/publisher.rb

+      if sentry_enabled?
+        with_sentry_span(&publisher_action)
+      else
+        publisher_action.call
+      end


Nitpick, but maybe with_sentry_span could just yield return if sentry is not enabled, so there won't be a need for if condition, and would be easier later on to wrap into multiple procs

cinkonaap · 2025-08-20T08:57:09Z

lib/eventboss/publisher.rb

    end
+
+    # Constructs SNS message attributes for Sentry trace propagation.
+    def build_sentry_message_attributes


This sounds like a good candidate to be moved to a separate class

cinkonaap · 2025-08-20T08:57:40Z

lib/eventboss/publisher.rb

+      end
+
+      user = ::Sentry.get_current_scope&.user
+      if user && !user.empty?


What is the scenario that the user could be empty?

For example a cron job can publish a eventboss event. The cronjob doesnt have to be per user

They have a similar for #empty? in the sidekiq middleware, so i kept it https://github.com/getsentry/sentry-ruby/blob/master/sentry-sidekiq/lib/sentry/sidekiq/sentry_context_middleware.rb#L112

cinkonaap · 2025-08-20T09:02:19Z

lib/eventboss/sentry/server_middleware.rb

+      SPAN_ORIGIN = 'auto.queue.eventboss'
+
+      # since sentry has env selector, we can remove it from queue names
+      QUEUES_WITHOUT_ENV = Hash.new do |hash, key|


Wouldn't it be better to just populate it with proper keys, instead of setting the default value? This is prone to an error, where someone would provide an non existing queue to this hash, and still get the value back

For the publisher: send name of events are defined in the publisher class and are fist time seen when we they try to publish the event. I don't think it's possible to do that without changing the interface of eventboss itself

This is prone to an error, where someone would provide an non existing queue to this hash, and still get the value back

I think that's the error of the user of eventboss. This constant only replaces the environment with placeholder ENV in the queue name for visualisation purpose. If the user wants to publish to not-existing queue, then i don't think the creation of Span metadata should be the one reporting that, but maybe eventboss itself

rapsad

Super nice work!

andrzejbisewski self-assigned this Aug 18, 2025

cinkonaap requested a review from Copilot August 19, 2025 07:50

This comment was marked as outdated.

Sign in to view

Add sentry middleware

ff83f00

andrzejbisewski force-pushed the ROMEO-457_sentry branch from c1c87df to ff83f00 Compare August 19, 2025 08:06

andrzejbisewski commented Aug 19, 2025

View reviewed changes

Update long_poller_spec.rb

084e0a1

andrzejbisewski added 6 commits August 19, 2025 12:50

Prefix transaction name with Eventboss

4bf972d

remove env from queue name

ca09ee0

remove env from queue name

35867d6

add distributed tracing

9345072

Update long_poller_spec.rb

ff672d1

fix sentry_user

393a1fc

andrzejbisewski requested a review from Copilot August 20, 2025 06:23

Copilot AI reviewed Aug 20, 2025

View reviewed changes

andrzejbisewski added 3 commits August 20, 2025 08:29

♻️

3138f40

documentation

803af4d

♻️

2c66a27

andrzejbisewski commented Aug 20, 2025

View reviewed changes

andrzejbisewski added 5 commits August 20, 2025 09:01

Update README.md

c8ec62a

update version

0bafb08

Update publisher.rb

9e25652

Update publisher_spec.rb

531b8ca

Update publisher.rb

e725c0d

andrzejbisewski marked this pull request as ready for review August 20, 2025 07:38

cinkonaap reviewed Aug 20, 2025

View reviewed changes

rapsad previously approved these changes Aug 20, 2025

View reviewed changes

Apply review remarks

f89edb5

andrzejbisewski dismissed rapsad’s stale review via f89edb5 August 20, 2025 12:21

andrzejbisewski requested a review from cinkonaap August 20, 2025 12:22

cinkonaap approved these changes Aug 20, 2025

View reviewed changes

rapsad approved these changes Aug 20, 2025

View reviewed changes

rapsad merged commit c3ecd55 into master Aug 20, 2025
7 checks passed

rapsad deleted the ROMEO-457_sentry branch August 20, 2025 12:58

-          contexts: { eventboss: { } },
+        eventboss_context = {}
+        eventboss_context[:queue_name] = _context[:queue_name] if _context.key?(:queue_name)
+        eventboss_context[:message_id] = _context[:message_id] if _context.key?(:message_id)
+        eventboss_context[:listener] = _context[:listener] if _context.key?(:listener)
+        Eventboss::Sentry::Integration.capture_exception(
+          exception,
+          contexts: { eventboss: eventboss_context },

	if user && !user.empty?
	if user && user.respond_to?(:empty?) && !user.empty?

	spec.add_development_dependency "sentry-ruby"
	spec.add_development_dependency "sentry-ruby", "~> 5.0"

Add sentry middleware #89

Add sentry middleware #89

Uh oh!

Conversation

andrzejbisewski commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

seban commented Aug 18, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrzejbisewski commented Aug 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrzejbisewski Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rapsad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

andrzejbisewski commented Aug 18, 2025 •

edited

Loading

andrzejbisewski Aug 20, 2025 •

edited

Loading