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

sl0thentr0py · 2023-11-14T14:35:47Z

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

codecov · 2023-11-14T14:37:07Z

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

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

adinauer

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

sentry-sidekiq/Gemfile

natikgadzhi

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

natikgadzhi · 2023-11-19T18:58:18Z

sentry-sidekiq/lib/sentry/sidekiq/cron/job.rb

+
+          # 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)


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

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.

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.

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.

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?

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

st0012

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

sentry-sidekiq/lib/sentry/sidekiq/cron/job.rb

st0012 · 2023-11-21T22:42:36Z

sentry-sidekiq/lib/sentry/sidekiq/cron/job.rb

+
+          # 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)


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

* 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 · 2023-12-04T08:51:57Z

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

natikgadzhi · 2023-12-04T15:19:25Z

Yep. It doesn’t care where the schedule comes from.

sl0thentr0py force-pushed the neel/crons/sidekiq-cron branch from aaf2454 to 26c4a5d Compare November 15, 2023 13:28

sl0thentr0py changed the title ~~sidekiq-cron WIP~~ Add sidekiq-cron patch for automatic monitoring of jobs listed in the schedule Nov 15, 2023

sl0thentr0py force-pushed the neel/crons/sidekiq-cron branch from 26c4a5d to 1938d61 Compare November 16, 2023 13:59

sl0thentr0py marked this pull request as ready for review November 16, 2023 14:00

sl0thentr0py force-pushed the neel/crons/sidekiq-cron branch 3 times, most recently from 1ff8687 to 9c3ddc5 Compare November 16, 2023 14:22

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

0699b8c

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 force-pushed the neel/crons/sidekiq-cron branch from 9c3ddc5 to 0699b8c Compare November 16, 2023 14:23

sl0thentr0py requested a review from st0012 November 16, 2023 15:42

cleptric self-requested a review November 17, 2023 00:31

adinauer approved these changes Nov 17, 2023

View reviewed changes

sl0thentr0py merged commit c7c8e5b into master Nov 17, 2023
98 checks passed

sl0thentr0py deleted the neel/crons/sidekiq-cron branch November 17, 2023 12:07

natikgadzhi reviewed Nov 19, 2023

View reviewed changes

sentry-sidekiq/Gemfile Show resolved Hide resolved

natikgadzhi reviewed Nov 19, 2023

View reviewed changes

natikgadzhi mentioned this pull request Nov 19, 2023

Crons automatic support for gems #2134

Closed

natikgadzhi added a commit to natikgadzhi/sentry-ruby that referenced this pull request Nov 20, 2023

Crons: add sidekiq-scheduler zero config support.

0b49536

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

natikgadzhi mentioned this pull request Nov 20, 2023

Crons: add sidekiq-scheduler zero-config monitor check-ins #2172

Merged

2 tasks

natikgadzhi added a commit to natikgadzhi/sentry-ruby that referenced this pull request Nov 20, 2023

Crons: add sidekiq-scheduler zero config support.

0794804

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

st0012 reviewed Nov 21, 2023

View reviewed changes

This was referenced Nov 22, 2023

(fix) crons: require sidekiq-cron early #2173

Merged

feat(crons): Ruby docs for auto-instrumentation getsentry/sentry-docs#8550

Merged

natikgadzhi mentioned this pull request Nov 25, 2023

Add sidekiq-cron and sidekiq-scheduler auto-instrumentation options to Crons onboarding getsentry/sentry#60567

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

sl0thentr0py commented Nov 14, 2023 •

edited

Loading

codecov bot commented Nov 14, 2023 •

edited

Loading

adinauer left a comment

natikgadzhi left a comment

natikgadzhi Nov 19, 2023

sl0thentr0py Nov 20, 2023

st0012 Nov 21, 2023

sl0thentr0py Nov 21, 2023

natikgadzhi Nov 21, 2023

sl0thentr0py Nov 23, 2023

st0012 left a comment

st0012 Nov 21, 2023

lloydwatkin commented Dec 4, 2023

natikgadzhi commented Dec 4, 2023 via email

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

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

Conversation

sl0thentr0py commented Nov 14, 2023 • edited Loading

codecov bot commented Nov 14, 2023 • edited Loading

Codecov Report

adinauer left a comment

Choose a reason for hiding this comment

natikgadzhi left a comment

Choose a reason for hiding this comment

natikgadzhi Nov 19, 2023

Choose a reason for hiding this comment

sl0thentr0py Nov 20, 2023

Choose a reason for hiding this comment

st0012 Nov 21, 2023

Choose a reason for hiding this comment

sl0thentr0py Nov 21, 2023

Choose a reason for hiding this comment

natikgadzhi Nov 21, 2023

Choose a reason for hiding this comment

sl0thentr0py Nov 23, 2023

Choose a reason for hiding this comment

st0012 left a comment

Choose a reason for hiding this comment

st0012 Nov 21, 2023

Choose a reason for hiding this comment

lloydwatkin commented Dec 4, 2023

natikgadzhi commented Dec 4, 2023 via email

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

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

sl0thentr0py commented Nov 14, 2023 •

edited

Loading

codecov bot commented Nov 14, 2023 •

edited

Loading