⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Conversation

@dingsdax
Copy link
Contributor

@dingsdax dingsdax commented Jan 16, 2026

testing out /sdk-docs Claude Skill

Summary

Adds comprehensive user-facing documentation for the new sentry-good_job integration, which adds support for GoodJob (a Postgres-based ActiveJob backend for Ruby on Rails).

Features Documented

  • Installation: Gem installation for Rails and non-Rails applications
  • Configuration: Automatic Rails setup and manual configuration options
  • Error Capture: Automatic exception capture with enriched context (job name, queue, ID)
    • Configurable retry behavior (report_after_job_retries, report_only_dead_jobs)
    • Optional job arguments in error context (with PII warnings)
  • Performance Monitoring: Automatic instrumentation with execution time and queue latency tracking
  • Cron Monitoring:
    • Automatic setup by reading GoodJob cron configuration
    • Manual setup via sentry_cron_monitor method
    • Timezone support

Configuration Options

Documents 5 configuration options:

  • report_after_job_retries (default: false)
  • report_only_dead_jobs (default: false)
  • include_job_arguments (default: false, with security considerations)
  • auto_setup_cron_monitoring (default: true)
  • logging_enabled (default: false)

Related SDK PR

Based on: getsentry/sentry-ruby#2751

Documentation Structure

  • Location: docs/platforms/ruby/guides/good_job/index.mdx
  • Follows existing Ruby guide patterns (similar to Sidekiq, DelayedJob, Resque)
  • Uses proper MDX components (<Alert>, <SdkOption>)
  • Includes verification steps and example code

Supported Versions

  • Ruby: 2.4+
  • Rails: 5.2+
  • GoodJob: 3.0+
  • Sentry Ruby SDK: 5.28.0+

🤖 Generated with Claude Code

@vercel
Copy link

vercel bot commented Jan 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jan 16, 2026 11:53pm
1 Skipped Deployment
Project Deployment Review Updated (UTC)
develop-docs Ignored Ignored Jan 16, 2026 11:53pm

Request Review

@dingsdax dingsdax changed the title docs(ruby): Add GoodJob integration documentation DO NOT MERGE docs(ruby): Add GoodJob integration documentation Jan 16, 2026
@dingsdax dingsdax marked this pull request as draft January 16, 2026 23:47
@dingsdax dingsdax closed this Jan 17, 2026
@dingsdax dingsdax deleted the docs/ruby/good-job-integration branch January 17, 2026 16:08
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.

2 participants