Skip to content

feat(ruby): Add Integrations section to logs docs #14413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025

Conversation

solnic
Copy link
Collaborator

@solnic solnic commented Jul 21, 2025

DESCRIBE YOUR PR

Follow up after getsentry/sentry-ruby#2644 (comment) documenting how to set up logs support for Ruby's built-in stdlib Logger.

Preview

👀 https://sentry-docs-git-ruby-stdlib-logger-docs.sentry.dev/platforms/ruby/logs/#integrations

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Jul 21, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 21, 2025 1:36pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 21, 2025 1:36pm

Copy link

codecov bot commented Jul 21, 2025

Bundle Report

Changes will increase total bundle size by 1.14kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-client-array-push 9.84MB -6 bytes (-0.0%) ⬇️
sentry-docs-server-cjs 11.98MB 1.14kB (0.01%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 881.08kB -0.0%
static/chunks/1831-*.js -3 bytes 423.46kB -0.0%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.55kB 1.0kB -84.74%
static/ZI_GBM9HNBl40YGW1npah/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/ZI_GBM9HNBl40YGW1npah/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/-*.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.67MB -0.0%
../instrumentation.js -3 bytes 999.78kB -0.0%
9523.js -3 bytes 975.72kB -0.0%
../app/[[...path]]/page.js.nft.json 384 bytes 722.95kB 0.05%
../app/platform-redirect/page.js.nft.json 384 bytes 722.86kB 0.05%
../app/sitemap.xml/route.js.nft.json 384 bytes 720.83kB 0.05%

@solnic solnic force-pushed the ruby-stdlib-logger-docs branch from 527d9af to e94785e Compare July 21, 2025 13:10
@solnic solnic marked this pull request as ready for review July 21, 2025 13:12
@solnic solnic requested a review from Copilot July 21, 2025 13:12
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation for Ruby logging integrations to the Sentry docs, specifically covering how to set up logs support for Ruby's built-in stdlib Logger and Rails logger. The documentation includes configuration examples and explains the behavior when enabling the :logger patch.

  • Adds comprehensive documentation for Ruby's stdlib Logger integration
  • Includes specific guidance for Ruby on Rails logger integration
  • Provides configuration examples and usage patterns

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
platform-includes/logs/integrations/ruby.mdx New file containing detailed documentation for Ruby logger integrations with code examples and Rails-specific guidance
docs/platforms/ruby/logs/index.mdx Adds new "Integrations" section to include the Ruby logger integration documentation

@solnic solnic merged commit df21655 into master Jul 21, 2025
13 checks passed
@solnic solnic deleted the ruby-stdlib-logger-docs branch July 21, 2025 13:42
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.

3 participants