getsentry/sentry-for-ai

sentry-ruby-sdk

Full Sentry SDK setup for Ruby.

소스 보기

사용 방법

  1. 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
  2. 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
  3. 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/getsentry/sentry-for-ai --skill sentry-ruby-sdk

시작 전 확인

  • 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
  • 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 Skill 문서

원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.

All Skills > SDK Setup > Ruby SDK

Sentry Ruby SDK

Opinionated wizard that scans the project and guides through complete Sentry setup.

Invoke This Skill When

  • User asks to "add Sentry to Ruby" or "set up Sentry" in a Ruby app
  • User wants error monitoring, tracing, logging, metrics, profiling, or crons in Ruby
  • User mentions sentry-ruby, sentry-rails, or the Ruby Sentry SDK
  • User is migrating from AppSignal, Honeybadger, Bugsnag, Rollbar, or Airbrake to Sentry
  • User wants to monitor exceptions, HTTP requests, or background jobs in Rails/Sinatra
Note: SDK APIs below reflect sentry-ruby v6.6.2. Always verify against docs.sentry.io/platforms/ruby/ before implementing.

Phase 1: Detect

bash
# Existing Sentry gems
grep -i sentry Gemfile 2>/dev/null

# Framework
grep -iE '\brails\b|\bsinatra\b' Gemfile 2>/dev/null

# Web server — Puma triggers queue time guidance
grep -iE '\bpuma\b' Gemfile 2>/dev/null

# Background jobs
grep -iE '\bsidekiq\b|\bresque\b|\bdelayed_job\b' Gemfile 2>/dev/null

# Yabeda metrics framework
grep -iE '\byabeda\b' Gemfile 2>/dev/null

# Competitor monitoring tools — triggers migration path if found
grep -iE '\bappsignal\b|\bhoneybadger\b|\bbugsnag\b|\brollbar\b|\bairbrake\b' Gemfile 2>/dev/null

# Scheduled jobs — triggers Crons recommendation
grep -iE '\bsidekiq-cron\b|\bclockwork\b|\bwhenever\b|\brufus-scheduler\b' Gemfile 2>/dev/null
grep -rn "Sidekiq::Cron\|Clockwork\|every.*do" config/ lib/ --include="*.rb" 2>/dev/null | head -10

# OpenTelemetry tracing — check for SDK + instrumentations
grep -iE '\bopentelemetry-sdk\b|\bopentelemetry-instrumentation\b' Gemfile 2>/dev/null
grep -rn "OpenTelemetry::SDK\.configure\|\.use_all\|\.in_span" config/ lib/ app/ --include="*.rb" 2>/dev/null | head -5

# Existing metric patterns (StatsD, Datadog, Prometheus)
grep -rE "(statsd|dogstatsd|prometheus|\.gauge|\.histogram|\.increment|\.timing)" \
  app/ lib/ --include="*.rb" 2>/dev/null | grep -v "_spec\|_test" | head -20

# Companion frontend
cat package.json frontend/package.json web/package.json 2>/dev/null | grep -E '"@sentry|"sentry-'

Route from what you find:

  • Competitor detected (appsignal, honeybadger, bugsnag, rollbar, airbrake) → load ${SKILL_ROOT}/references/migration.md first; delete the competitor initializer as part of migration
  • Sentry already present → skip to Phase 2 to configure features
  • Rails → use sentry-rails + config/initializers/sentry.rb
  • Rack/Sinatra → sentry-ruby + Sentry::Rack::CaptureExceptions middleware
  • Sidekiq → add sentry-sidekiq; recommend Metrics if existing metric patterns found
  • Yabeda detected → add sentry-yabeda; routes Yabeda metrics to Sentry metrics
  • Puma detected → queue time capture is automatic (v6.4.0+), but the reverse proxy must set X-Request-Start header; see ${SKILL_ROOT}/references/tracing.md → "Request Queue Time"
  • OTel tracing detected (opentelemetry-sdk + instrumentations in Gemfile, or OpenTelemetry::SDK.configure in source) → use OTLP path: config.otlp.enabled = true; do not set traces_sample_rate; Sentry links errors to OTel traces automatically

Phase 2: Recommend

Lead with a concrete proposal — don't ask open-ended questions:

FeatureRecommend when...
Error MonitoringAlways
OTLP IntegrationOTel tracing detected — replaces native Tracing
TracingRails / Sinatra / Rack / any HTTP framework; skip if OTel tracing detected
LoggingAlways — enable_logs: true costs nothing
MetricsSidekiq present; existing metric lib (StatsD, Prometheus) detected
Profiling⚠️ Beta — performance profiling requested; requires stackprof or vernier gem; skip if OTel tracing detected (requires traces_sample_rate, incompatible with OTLP)
CronsScheduled jobs detected (ActiveJob, Sidekiq-Cron, Clockwork, Whenever)

OTel tracing detected: "I see OpenTelemetry tracing in the project. I recommend Sentry's OTLP integration for tracing (via your existing OTel setup) + Error Monitoring + Sentry Logging [+ Metrics/Crons if applicable]. Shall I proceed?"

No OTel: "I recommend Error Monitoring + Tracing + Logging [+ Metrics if applicable]. Shall I proceed?"


Phase 3: Guide

Install

Rails:

ruby
# Gemfile
gem "sentry-ruby"
gem "sentry-rails"
gem "sentry-sidekiq"      # if using Sidekiq
gem "sentry-resque"       # if using Resque
gem "sentry-delayed_job"  # if using DelayedJob
gem "sentry-yabeda"       # if using Yabeda metrics framework

Rack / Sinatra / plain Ruby:

ruby
gem "sentry-ruby"

Run bundle install.

Framework Integration

Framework / RuntimeGemInit locationAuto-instruments
Railssentry-railsconfig/initializers/sentry.rbControllers, ActiveRecord, ActiveJob, ActionMailer
Rack / Sinatrasentry-rubyTop of config.ruRequests (via Sentry::Rack::CaptureExceptions middleware)
Sidekiqsentry-sidekiqSentry initializer or Sidekiq configWorker execution → transactions
Resquesentry-resqueSentry initializerWorker execution → transactions
DelayedJobsentry-delayed_jobSentry initializerJob execution → transactions
Yabeda metricssentry-yabedaSentry initializerYabeda metric events → Sentry metrics

Init — Rails (config/initializers/sentry.rb)

ruby
Sentry.init do |config|
  config.dsn = ENV["SENTRY_DSN"]
  config.spotlight = Rails.env.development?  # local Spotlight UI; no DSN needed in dev
  config.breadcrumbs_logger = [:active_support_logger, :http_logger]
  config.send_default_pii = true
  config.traces_sample_rate = 1.0  # lower to 0.05–0.2 in production
  config.enable_logs = true
  # Metrics on by default; disable with: config.enable_metrics = false
end

sentry-rails auto-instruments ActionController, ActiveRecord, ActiveJob, ActionMailer.

Init — Rack / Sinatra

ruby
require "sentry-ruby"

Sentry.init do |config|
  config.dsn = ENV["SENTRY_DSN"]
  config.spotlight = ENV["RACK_ENV"] == "development"
  config.breadcrumbs_logger = [:sentry_logger, :http_logger]
  config.send_default_pii = true
  config.traces_sample_rate = 1.0
  config.enable_logs = true
end

use Sentry::Rack::CaptureExceptions  # in config.ru, before app middleware

Init — Sidekiq standalone

ruby
require "sentry-ruby"
require "sentry-sidekiq"

Sentry.init do |config|
  config.dsn = ENV["SENTRY_DSN"]
  config.spotlight = ENV.fetch("RAILS_ENV", "development") == "development"
  config.breadcrumbs_logger = [:sentry_logger]
  config.traces_sample_rate = 1.0
  config.enable_logs = true
end

Environment variables

bash
SENTRY_DSN=https://xxx@oYYY.ingest.sentry.io/ZZZ
SENTRY_ENVIRONMENT=production   # overrides RAILS_ENV / RACK_ENV
SENTRY_RELEASE=my-app@1.0.0

Feature reference files

Walk through features one at a time. Load the reference file for each, follow its steps, and verify before moving to the next:

FeatureReference fileLoad when...
Migration${SKILL_ROOT}/references/migration.mdCompetitor gem found — load before installing Sentry
Error Monitoring${SKILL_ROOT}/references/error-monitoring.mdAlways
Tracing${SKILL_ROOT}/references/tracing.mdHTTP handlers / distributed tracing
Logging${SKILL_ROOT}/references/logging.mdStructured log capture
Metrics${SKILL_ROOT}/references/metrics.mdSidekiq present; existing metric patterns
Profiling${SKILL_ROOT}/references/profiling.mdPerformance profiling requested (beta)
Crons${SKILL_ROOT}/references/crons.mdScheduled jobs detected or requested

For each feature: Read ${SKILL_ROOT}/references/<feature>.md, follow steps exactly, verify it works.


Configuration Reference

Key Sentry.init Options

OptionTypeDefaultPurpose
dsnStringnilSDK disabled if empty; env: SENTRY_DSN
environmentStringnile.g., "production"; env: SENTRY_ENVIRONMENT
releaseStringnile.g., "myapp@1.0.0"; env: SENTRY_RELEASE
spotlightBooleanfalseSend events to Spotlight sidecar (local dev, no DSN needed)
send_default_piiBooleanfalseInclude IP addresses and request headers
sample_rateFloat1.0Error event sample rate (0.0–1.0)
traces_sample_rateFloatnilTransaction sample rate; nil disables tracing
profiles_sample_rateFloatnilProfiling rate relative to traces_sample_rate; requires stackprof or vernier
enable_logsBooleanfalseEnable Sentry structured Logs
enable_metricsBooleantrueEnable custom metrics (on by default)
breadcrumbs_loggerArray[]Loggers for automatic breadcrumbs (see logging reference)
max_breadcrumbsInteger100Max breadcrumbs per event
debugBooleanfalseVerbose SDK output to stdout
capture_queue_timeBooleantrueRecord request queue time from X-Request-Start header (v6.4.0+, Rails fixed in v6.4.1)
otlp.enabledBooleanfalseRoute OTel spans to Sentry via OTLP; do not combine with traces_sample_rate
otlp.collector_urlStringnilOTLP HTTP endpoint of an OTel Collector (e.g., http://localhost:4318/v1/traces); when set, spans are sent to the collector instead of directly to Sentry
org_idStringnilExplicit org ID; overrides DSN-extracted value; useful for self-hosted/Relay setups (v6.5.0+)
strict_trace_continuationBooleanfalseOnly continue incoming traces when sentry-org_id baggage matches SDK's org ID; prevents trace stitching from third-party services (v6.5.0+)
before_sendLambdanilMutate or drop error events before sending
before_send_transactionLambdanilMutate or drop transaction events before sending
before_send_logLambdanilMutate or drop log events before sending

Environment Variables

VariableMaps toPurpose
SENTRY_DSNdsnData Source Name
SENTRY_RELEASEreleaseApp version (e.g., my-app@1.0.0)
SENTRY_ENVIRONMENTenvironmentDeployment environment

Options set in Sentry.init override environment variables.


Verification

Local dev (no DSN needed) — Spotlight:

bash
npx @spotlightjs/spotlight          # browser UI at http://localhost:8969
# or stream events to terminal:
npx @spotlightjs/spotlight tail traces --format json

config.spotlight = Rails.env.development? (already in the init block above) routes events to the local sidecar automatically.

With a real DSN:

ruby
Sentry.capture_message("Sentry Ruby SDK test")

Nothing appears? Set config.debug = true and check stdout. Verify DSN format: https://<key>@o<org>.ingest.sentry.io/<project>.


Phase 4: Cross-Link

bash
cat package.json frontend/package.json web/package.json 2>/dev/null | grep -E '"@sentry|"sentry-'
Frontend detectedSuggest
React / Next.jssentry-react-sdk
Svelte / SvelteKitsentry-svelte-sdk
Vue@sentry/vue — docs.sentry.io/platforms/javascript/guides/vue/

For trace stitching between Ruby backend and JS frontend, see references/tracing.md → "Frontend trace stitching".


Troubleshooting

IssueSolution
Events not appearingconfig.debug = true; verify DSN; ensure Sentry.init before first request
Rails exceptions missingMust use sentry-rails — sentry-ruby alone doesn't hook Rails error handlers
No traces (native)Set traces_sample_rate > 0; ensure sentry-rails or Sentry::Rack::CaptureExceptions
No traces (OTLP)Verify opentelemetry-exporter-otlp gem is installed; do not set traces_sample_rate when using otlp.enabled = true
Sidekiq jobs not tracedAdd sentry-sidekiq gem
Missing request contextSet config.send_default_pii = true
Logs not appearingSet config.enable_logs = true; sentry-ruby ≥ 5.27.0 required
Metrics not appearingCheck enable_metrics is not false; verify DSN
Events lost on shutdownProcess.exit! skips at_exit hooks — call Sentry.flush explicitly before forced exits
Forking server loses eventsPuma/Unicorn fork workers — re-initialize in on_worker_boot or after_fork; without this, the background worker thread dies in child processes
DSN rejected / events not deliveredVerify DSN format: https://<key>@o<org>.ingest.sentry.io/<project>; set config.debug = true to see transport errors

관련 작업

같은 저장소의 Skills

더 많은 Skills

모든 Skills
getsentry
공식

sentry-fix-issues

Find and fix issues from Sentry using MCP. Use when asked to fix Sentry errors, debug production issues, investigate exceptions, or resolve bugs reported in Sentry. Methodically analyzes stack traces, breadcrumbs, traces, and context to identify root causes.

설치 수
4
GitHub Stars
271
업데이트
10월 20일
getsentry
공식

sentry-debug-issue

Debug and fix a Sentry issue — find it (by link, ID, or search), pull full context (stack trace, breadcrumbs, trace, logs), optionally run Seer root-cause / autofix, apply the code fix, and resolve it via a Fixes PROJECT-NAME-12A commit/PR. Use when working a known error or hunting one down to fix.

설치 수
3
GitHub Stars
271
업데이트
10월 20일
getsentry
공식

sentry-python-sdk

Full Sentry SDK setup for Python. Use when asked to "add Sentry to Python", "install sentry-sdk", "setup Sentry in Python", or configure error monitoring, tracing, profiling, logging, metrics, crons, or AI monitoring for Python applications. Supports Django, Flask, FastAPI, Celery, Starlette, AIOHTTP, Tornado, and more.

설치 수
3
GitHub Stars
271
업데이트
10월 20일
getsentry
공식

sentry-android-sdk

Full Sentry SDK setup for Android. Use when asked to "add Sentry to Android", "install sentry-android", "setup Sentry in Android", or configure error monitoring, tracing, profiling, session replay, or logging for Android applications. Supports Kotlin and Java codebases.

설치 수
2
GitHub Stars
271
업데이트
10월 20일