Add CakeSentry.Queue.* events for Sentry integration #452
+220
−1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds events compatible with lordsimal/cakephp-sentry for queue monitoring and tracing, as proposed in LordSimal/cakephp-sentry#43.
Instead of including Sentry-specific code directly in the queue plugin (as in #449), this approach dispatches generic events that the Sentry plugin can listen to:
CakeSentry.Queue.enqueue: Fired when a job is added to the queue (producer side)CakeSentry.Queue.beforeExecute: Fired when a worker begins processing a job (consumer side)CakeSentry.Queue.afterExecute: Fired when a job finishes (success or failure)This enables integration with Sentry's queue monitoring without requiring the queue plugin to depend on the Sentry SDK.
Trace Propagation
For distributed tracing, users can add Sentry trace headers to job data when creating jobs:
The queue plugin will pass these headers to the
beforeExecuteevent for trace continuation.Related Issues
Test plan
CakeSentry.Queue.enqueueeventCakeSentry.Queue.beforeExecuteeventCakeSentry.Queue.afterExecutesuccess eventCakeSentry.Queue.afterExecutefailure event