Project: Cron Monitoring

[stephanie-anderson]

Project Board

See our project board to track this initiative across all SDKs

Description

This project is to track that each SDK which can support, and has reasonable demand for Cron Monitors at Sentry, has initial support.

Client Reports

We've recently added support for client reports for Crons using the monitor data category. Adding support to all of our SDKs would be helpful to troubleshoot customers if their check-ins are getting discarded for some reason (network issues, rate limits, etc). The envelope item type for monitor check-ins is check_in and the data category for client reports should be monitor.

Thresholds in Monitor Config (Failure & Recovery)

We've just added two additional fields to Relay (getsentry/relay#2842) allowing customers to provide the following properties in their monitor config:

• failure_issue_threshold: how many consecutive failures we should wait for to create an issue
• recovery_threshold: how many consecutive failures we should keep track to resolve an issue

This is a especially helpful feature for orgs that have lots of monitors and want to configure their monitors programmatically.

Attachments

In Q1, we are planning on implementing the ability to attach files to a check-in and potentially context as well. On attachments, it's likely we'll update the attachment envelope to support a check-in ID or a new envelope dedicated for check-in attachments. We'll discuss with ingest and update with requirements here. The idea is to enable customers to attach log files and other relevant metadata for each job run.

Implementation Overview

Tasks

Preview Give feedback

1. feat(crons): Add thresholds to monitor config payload relay#2842
   +0
2. feat(crons): Add issue thresholds to MonitorConfig develop#1108
   +0

SDK Overview

Support for Cron Monitoring

Preview Give feedback

1. PHP
2. Laravel
3. Symfony
4. Python
5. Python: Celery
6. Node.js
7. Next.js
8. SvelteKit
9. Remix
10. Golang
11. Java
12. Java: Spring boot
13. Ruby
14. .NET

Thresholds in Monitor Config

Preview Give feedback

1. CRONS new monitor config options sentry-java#3131
   Platform: Java +1
   
2. Python SDK
3. Go SDK
4. Java: CRONS new monitor config options sentry-java#3131
5. Sentry CLI: Cron monitor: Failure and recovery thresholds config sentry-cli#1919

Node SDK

Preview Give feedback

1. Support Check-ins
2. Wrapper Support
3. Client Reports
4. feat(types): Add support for new monitor config thresholds sentry-javascript#10225
   +0
   

Python SDK

Preview Give feedback

1. [Python] Client Reports
2. [Python] Support Check-ins
3. [Python] Wrapper Support

PHP SDK

Preview Give feedback

1. [PHP] Support Check-ins
2. [PHP] Wrapper Support
3. [PHP] Client Reports
4. Add failure_issue_threshold & recovery_threshold to MonitorConfig sentry-php#1685
   Type: Feature +1
   
5. Add support for failure_issue_threshold & recovery_threshold sentry-laravel#838
   Type: Improvement +1
   

Laravel SDK

Preview Give feedback

1. [Laravel] Support Check-ins
2. [Laravel] Wrapper Support
3. [Laravel] Client Reports
4. Add support for failure_issue_threshold & recovery_threshold sentry-laravel#838
   Type: Improvement +1
   

Symfony SDK

Preview Give feedback

1. [Symfony] Support Check-ins
2. [Symfony] Wrapper Support
3. [Symfony] Client Reports

Ruby SDK

Preview Give feedback

1. [Ruby] Support Check-ins
2. [Ruby] Upsert
3. [Ruby] Heartbeat
4. [Ruby] Wrapper Support
5. [Ruby] Client Reports
6. [Ruby] Instrument sidekiq-cron
7. [Ruby] Instrument sidekiq-scheduler

Java SDK

Preview Give feedback

1. [Java] Support Check-ins
2. [Java] Client Reports
3. [Java] Wrapper Support
4. Crons support for Java sentry-java#2875
   Platform: Java +1
   
5. CRONS new monitor config options sentry-java#3131
   Platform: Java +1
   
6. Crons - allow configuring defaults for monitor config sentry-java#3122
   CRONS Platform: Java +2
   
7. Crons lead to unusual 10% load increase sentry-java#3165
   Platform: Java Sync: Jira Type: Bug +3
   
8. Improve Upsert support for check-ins sentry-java#2963
   Platform: Java +1

.NET SDK

Preview Give feedback

1. [.NET] Support Check-ins
2. [.NET] Wrapper Support
3. [.NET] Client Reports
4. Support for Crons on Hangfire sentry-dotnet#2239
   Feature Platform: .NET +2
   
5. Support for Crons on Quartz sentry-dotnet#3150
   Feature Product: Crons +2

Go SDK

Preview Give feedback

1. [Go] Support Check-ins
2. [Go] Upsert
3. [Go] Heartbeat
4. [Go] Wrapper Support
5. [Go] Client Reports

Elixir SDK

Preview Give feedback

1. [Elixir] Support Check-ins
2. [Elixir] Upsert
3. [Elixir] Heartbeat
4. [Elixir] Wrapper Support
5. [Elixir] Client Reports

Sentry CLI

Preview Give feedback

1. [CLI] Support Check-ins
2. [CLI] Wrapper Support
3. [CLI] Client Reports
4. Cron monitor: Failure and recovery thresholds config sentry-cli#1919
   +0
   

[smeubank]

I think it is fair to set this project to done @stephanie-anderson . What do you think?

All relevant platforms are covered for the crons GA, and there are different issues to cover rollout of more specific things

[stephanie-anderson]

Let's merge all the Crons projects into this one, @smeubank. I will go ahead and integrate them

[gaprl]

Should we add Airflow support here as well?