Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrap ActiveJob::Enqueue in evented ActiveSupport::Notification #33171

Merged
merged 1 commit into from
Jul 20, 2018

Conversation

zvkemp
Copy link
Contributor

@zvkemp zvkemp commented Jun 20, 2018

Summary

Instead of firing an event after enqueuing a job, wrap the enqueue in an ActiveSupport::Notifications instrumentation block.

Other Information

Enables more accurate timing, as it includes time spent writing jobs to the adapter's IO implementation.

@rails-bot
Copy link

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @sgrif (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

Copy link
Contributor

@kaspth kaspth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks! Needs a rebase because of the changelog, then I'll merge.

around_enqueue do |job, block|
key = job.scheduled_at ? "enqueue_at" : "enqueue"
ActiveSupport::Notifications.instrument "#{key}.active_job",
adapter: job.class.queue_adapter, job: job, &block
end
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep the old flow? Don't think this needs to be super-DRY.

@zvkemp zvkemp force-pushed the active-job-asn-wrap-enqueue branch from c250b94 to 2a1884b Compare July 17, 2018 22:05
@zvkemp
Copy link
Contributor Author

zvkemp commented Jul 17, 2018

@kaspth I rebased and reverted the flow as you suggested. Thanks!

@kaspth kaspth merged commit 3a76ead into rails:master Jul 20, 2018
@kaspth
Copy link
Contributor

kaspth commented Jul 20, 2018

Thanks!

@zvkemp zvkemp deleted the active-job-asn-wrap-enqueue branch July 20, 2018 21:16
@Edouard-chin
Copy link
Member

Sorry for digging up this PR, but can we revisit this decision? The main problem with an around_callbacks and passing the block to the instrumenter is that if the enqueuing fails (i.e. redis is down), we still get the regular log message from Rails "Enqueued BlablaJob..."

That's because the instrumenter will always dispatch the notification no matter if the block raised

finish_with_state listeners_state, name, payload

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants