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

Add sidekiq-cron patch for automatic monitoring of jobs listed in the schedule #2170

Merged
merged 1 commit into from
Nov 17, 2023

Conversation

sl0thentr0py
Copy link
Member

@sl0thentr0py sl0thentr0py commented Nov 14, 2023

  • optional patch under sidekiq_cron
  • patch the Sidekiq::Cron::Job#save method and auto inject the Sentry::MonitorCheckIns module and turn monitoring on

part of #2134

Copy link

codecov bot commented Nov 14, 2023

Codecov Report

Merging #2170 (0699b8c) into master (a418b54) will increase coverage by 5.13%.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2170      +/-   ##
==========================================
+ Coverage   92.24%   97.37%   +5.13%     
==========================================
  Files          88       98      +10     
  Lines        3468     3655     +187     
==========================================
+ Hits         3199     3559     +360     
+ Misses        269       96     -173     
Components Coverage Δ
sentry-ruby 98.02% <ø> (ø)
sentry-rails 94.98% <ø> (+49.22%) ⬆️
sentry-sidekiq 95.54% <100.00%> (+1.83%) ⬆️
sentry-resque 92.06% <ø> (ø)
sentry-delayed_job 94.36% <ø> (ø)
sentry-opentelemetry 100.00% <ø> (ø)
Files Coverage Δ
sentry-sidekiq/lib/sentry-sidekiq.rb 84.61% <100.00%> (+8.61%) ⬆️
sentry-sidekiq/lib/sentry/sidekiq/cron/job.rb 100.00% <100.00%> (ø)

... and 22 files with indirect coverage changes

@sl0thentr0py sl0thentr0py force-pushed the neel/crons/sidekiq-cron branch from aaf2454 to 26c4a5d Compare November 15, 2023 13:28
@sl0thentr0py sl0thentr0py changed the title sidekiq-cron WIP Add sidekiq-cron patch for automatic monitoring of jobs listed in the schedule Nov 15, 2023
@sl0thentr0py sl0thentr0py force-pushed the neel/crons/sidekiq-cron branch from 26c4a5d to 1938d61 Compare November 16, 2023 13:59
@sl0thentr0py sl0thentr0py marked this pull request as ready for review November 16, 2023 14:00
@sl0thentr0py sl0thentr0py force-pushed the neel/crons/sidekiq-cron branch 3 times, most recently from 1ff8687 to 9c3ddc5 Compare November 16, 2023 14:22
schedule

* optional patch under `sidekiq_cron`
* patch the `Sidekiq::Cron::Job#save` method and auto inject the
  Sentry::MonitorCheckIns module and turn monitoring on

part of #2134
@sl0thentr0py sl0thentr0py force-pushed the neel/crons/sidekiq-cron branch from 9c3ddc5 to 0699b8c Compare November 16, 2023 14:23
@sl0thentr0py sl0thentr0py requested a review from st0012 November 16, 2023 15:42
@cleptric cleptric self-requested a review November 17, 2023 00:31
Copy link
Member

@adinauer adinauer left a comment

Choose a reason for hiding this comment

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

LGTM if perform is actually being called for sidekiq which I assume you tested.

@sl0thentr0py sl0thentr0py merged commit c7c8e5b into master Nov 17, 2023
98 checks passed
@sl0thentr0py sl0thentr0py deleted the neel/crons/sidekiq-cron branch November 17, 2023 12:07
Copy link
Contributor

@natikgadzhi natikgadzhi left a comment

Choose a reason for hiding this comment

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

Don't mind me, I was just catching up.


# only patch if not explicitly included in job by user
unless klass_const.send(:ancestors).include?(Sentry::Cron::MonitorCheckIns)
klass_const.send(:include, Sentry::Cron::MonitorCheckIns)
Copy link
Contributor

Choose a reason for hiding this comment

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

Would this make it so any invocation of the related Job class, including invocations triggered by sidekiq-cron, and invocations that the user did manually, with just HappyWorkerJob.perform_async? It looks like it would, right?

I wonder if there are situations when users want to kick the same job for a one-off thing that they don't want to be reported to Sentry. I, personally, think that since the defined sidekiq-cron job just wraps a Sidekiq job, than whenever that job was triggered, it should be reported.

Do we want to add this to docs? Is this behavior consistent with other languages and frameworks Sentry supports?

/cc @sl0thentr0py

Copy link
Member Author

Choose a reason for hiding this comment

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

I will add docs for all of this around releasing.

Would this make it so any invocation of the related Job class, including invocations triggered by sidekiq-cron, and invocations that the user did manually, with just HappyWorkerJob.perform_async? It looks like it would, right?

yes

I wonder if there are situations when users want to kick the same job for a one-off thing that they don't want to be reported to Sentry. I, personally, think that since the defined sidekiq-cron job just wraps a Sidekiq job, than whenever that job was triggered, it should be reported.

This is a new feature, we will add special config once people use it and request it. This is fine as a first version, it's an opt-in patch either way.

Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like there could be multiple ways to invoke save in addition to the initial creation. Although the current implementation doesn't seem to have obvious performance impact, I feel a better place to inject such one-off activation logic is load_from_array instead.
I understand that it's an experimental feature for now, so I'm not suggesting an immediate refactor. Just want to point it out for future improvements.

Copy link
Member Author

Choose a reason for hiding this comment

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

if people are scheduling cron jobs with Sidekiq::Cron::Job.create, we patch those too automatically, either way shouldn't matter, we can react to feedback from users later depending on usage.

Copy link
Contributor

Choose a reason for hiding this comment

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

Honest question so I can draft the docs PR:

  • to enable sidekiq-cron and/or sidekiq-scheduler monitoring, the users will have to manually add config.enabled_patches += [:sidekiq_cron], right?
  • When this patch is applied, and as long as sidekiq-cron is indeed available, we aim to instrument all jobs that it runs, all the time. The current logic that hooks into save does that. Correct?
  • One side-iffect is that we're instrumenting the job class itself, so whether it was the sidekiq-cron schedule that invoked the job on a timer, or the user's code invoked perform_* on that job, we will monitor that too. That's by design for now, but we'll keep an eye out for feedback. Right?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes to all

natikgadzhi added a commit to natikgadzhi/sentry-ruby that referenced this pull request Nov 20, 2023
- Adds support for `sidekiq-scheduler` instrumentation without any
  configuration from the user.
- Based on getsentry#2170.
natikgadzhi added a commit to natikgadzhi/sentry-ruby that referenced this pull request Nov 20, 2023
- Adds support for `sidekiq-scheduler` instrumentation without any
  configuration from the user.
- Based on getsentry#2170.
Copy link
Collaborator

@st0012 st0012 left a comment

Choose a reason for hiding this comment

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

Sorry for the long delay. I was preparing for and attending RubyConf in the US.

sentry-sidekiq/lib/sentry/sidekiq/cron/job.rb Show resolved Hide resolved

# only patch if not explicitly included in job by user
unless klass_const.send(:ancestors).include?(Sentry::Cron::MonitorCheckIns)
klass_const.send(:include, Sentry::Cron::MonitorCheckIns)
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like there could be multiple ways to invoke save in addition to the initial creation. Although the current implementation doesn't seem to have obvious performance impact, I feel a better place to inject such one-off activation logic is load_from_array instead.
I understand that it's an experimental feature for now, so I'm not suggesting an immediate refactor. Just want to point it out for future improvements.

sentry-sidekiq/lib/sentry/sidekiq/cron/job.rb Show resolved Hide resolved
sl0thentr0py added a commit that referenced this pull request Nov 23, 2023
* Crons: add sidekiq-scheduler zero config support.

- Adds support for `sidekiq-scheduler` instrumentation without any
  configuration from the user.
- Based on #2170.

* Crons: support intervals for sidekiq-scheduler jobs

- AppliesApply review feedback.
- Adds support for interval and every interval_types for
  sidekiq-scheduler-schedule
- Adds specs for the above.

* Crons: changelog for sidekiq-scheduler support.

* Crons: fix tests on Sidekiq 6

* Require sidekiq-scheduler to ensure it's there

* sidekiq-scheduler mock config without delegation

* Make version checks consistent

* Fix some stuff

* need int for interval
* constantize doesn't exist outside rails
* cleanup specs

---------

Co-authored-by: Neel Shah <neelshah.sa@gmail.com>
@lloydwatkin
Copy link

We use a different file (i.e. not schedule.yml) for our sidekiq-cron setup, will this patch pull in the appropriate file.

@natikgadzhi
Copy link
Contributor

natikgadzhi commented Dec 4, 2023 via email

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.

5 participants