rails: add optional Good Job labels and concurrency key to ActiveJob error context
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 54/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- ruby
- Domain
- backend, observability
Research direction
Start by reading the current ActiveJobExtension context and error-data path; the issue explicitly says to use it rather than the removed SentryReporter.sentry_context. Check how that path builds contexts and handles optional job methods, then compare the result with the Good Job identity APIs in the specification. Done means the documented good_job context includes labels and any present legacy concurrency key, with neither field added as a tag.
Written by the indexing model from the issue text.
Description
Summary
When an ActiveJob instance exposes Good Job identity APIs, attach labels and legacy concurrency_key under a good_job context on error (and optionally on the job scope).
Motivation
Official ActiveJob / job-extension reporting already records queue, executions, latency, and messaging fields. It does not record Good Job's concurrency identity (good_job_labels, and on older 4.x good_job_concurrency_key). Those fields help explain why a job was limited or which concurrency cohort it belonged to.
Specification
- Duck-type only:
- if
job.respond_to?(:good_job_labels)->contexts.good_job.labels = Array(job.good_job_labels) - if
job.respond_to?(:good_job_concurrency_key)and value present ->contexts.good_job.concurrency_key
- if
- Do not set these as tags (label cardinality).
- Hook current
ActiveJobExtensioncontext / error-data path (not removedSentryReporter.sentry_context). - No-op when methods are absent.
Guide-level
A failing job that uses Good Job concurrency labels shows contexts.good_job.labels on the event. Hosts on Good Job 5+ without concurrency_key simply omit that field.
Drawbacks / alternatives
- Adopt: small adapter-specific branch in a shared ActiveJob path.
- Do nothing: lose concurrency cohort signal on errors.
- Rejected: tags for labels.
- Rejected: nest only under
extraifcontexts.good_jobis unacceptable; prefer contexts for structured identity.
Prior art
- Official Good Job cron / ActiveJob work: #3199, #3200
- Community
sentry-good_jobContextHelpers (prior art only)
Unresolved questions
- Apply on successful transactions too, or only on captured exceptions?
- Name the context key
good_jobvs extendactive_job?
References
- Dominant language
- Ruby
- Stars
- 990
- Forks
- 553
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 31
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getsentry/sentry-ruby
-
Bug Ruby Waiting for: Product Owner
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
getsentry/sentry-ruby#3228 · 1 comment ·
Maintainers usually reply within 1 day
-
Shorter rate limit in the same header replaces a longer onePossibly taken @sentry-junior claimed this 5 days ago. OpenBug Ruby
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
getsentry/sentry-ruby#3211 · 1 comment ·
Maintainers usually reply within 1 day
-
Events dropped client-side for size are only logged at debug level and not recorded as lostPossibly taken @sentry-junior claimed this 5 days ago. OpenBug Junior: repro Ruby
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
getsentry/sentry-ruby#3209 · 2 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
Ship fewer files with the gemsPossibly taken @solnic claimed this 1 day ago. OpenImprovement Ruby Waiting for: Product Owner
getsentry/sentry-ruby#3223 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
active_job breaking change Next Major sentry-delayed_job sentry-rails sentry-resque sentry-sidekiq
Difficulty 4/5 3-5 days Newbie friendliness 48/100
getsentry/sentry-ruby#3222 · 1 comment ·
Maintainers usually reply within 1 day
All issues in getsentry/sentry-ruby
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
開発用DockerイメージにPlaywrightのシステム依存を追加するPossibly taken @momocus claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
sakazuki-org/sakazuki#1453 ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
jenkins-infra/jenkins.io#9615 · 1 comment ·
Maintainers usually reply within 1 day
-
fix(ocr): compile the Tesseract-free pipeline with Tokio runtimePossibly taken @Goldziher claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day