Sentry Cron MonitorCheckIns ability to skip and resume checkin process

[amkisko]

Problem Statement

Hey!

This is very specific problem related to very frequent or jobs which split progress within runs e.g. pagination, cursor-based parameters for the same job.

Due to large volume Sentry starts rate-limiting and also since progress determined by job parameters it should not be so that check-in happens on each and every run.

References:

• https://github.com/getsentry/sentry-ruby/blob/master/sentry-ruby/lib/sentry/cron/monitor_check_ins.rb

Solution Brainstorm

• Add skip_sentry_check_in! method to job class instance, without additional arguments
• Add send_sentry_check_in! method to job class instance, default to :ok checkin type (error should be attached to actual error? in_progress does not make sense to send in this case?)

[linear]

RUBY-106

[sl0thentr0py]

hey @amkisko, this is a custom use case, I would advice you to a build a helper for those specific jobs that calls Sentry.capture_check_in before the job starts and after the job completes as per your parameters.

You can take inspiration from our patch for job classes here.

sentry-ruby/sentry-ruby/lib/sentry/cron/monitor_check_ins.rb

Lines 9 to 28 in c6d98f1

	def perform(*args, **opts)
	slug = self.class.sentry_monitor_slug
	monitor_config = self.class.sentry_monitor_config
	check_in_id = Sentry.capture_check_in(slug,
	:in_progress,
	monitor_config: monitor_config)
	start = Metrics::Timing.duration_start
	begin
	# need to do this on ruby <= 2.6 sadly
	ret = method(:perform).super_method.arity == 0 ? super() : super
	duration = Metrics::Timing.duration_end(start)
	Sentry.capture_check_in(slug,
	:ok,
	check_in_id: check_in_id,
	duration: duration,
	monitor_config: monitor_config)

I will close this as not planned because this use case isn't general enough but if you want help with your solution, feel free to continue the discussion and I will help you!

[amkisko]

@sl0thentr0py Hey!

this is a custom use case

I don't agree with this as check-ins happen automatically when integration turned on. Also I would want automation to be in place, but for only some exact jobs to have full control within the code.

At least skip_sentry_check_ins! method on the job level definition could be already a solution and then doing custom thing as you mentioned, which for sure I already considered, but there is no way to disable automation per job.