Docs/logs refresh kyle #15595
Merged
Docs/logs refresh kyle #15595
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the overview to clarify the benefits of structured logs, including their searchability and trace connection. Improved the list of log tracking examples and added links to relevant search syntax and filtering documentation. Adjusted wording for clarity in sections about log entry expansion and auto-refresh conditions.
…tions Enhanced the logs documentation by introducing log drains, which allow users to forward logs from various platforms directly to Sentry. Updated the "Getting Started" and "Log Drains" sections to include supported platforms like Vercel, Cloudflare, Heroku, and Supabase, along with relevant links for further information.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Bundle ReportChanges will increase total bundle size by 176.09kB (0.75%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
App Routes Affected:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
Updated the structured logs documentation to enhance the clarity of log tracking examples. Reworded sections to provide more specific descriptions of debugging information, user behavior, application state, and business events. Added a link to the "Getting Started" guide for sending structured logs with custom attributes.
Enhanced the drains documentation by providing a comprehensive overview of how to set up log and trace drains for various platforms. Added sections detailing supported platforms, data types, and prerequisites for configuration. Included an alert regarding the current limitation of error event support through drains, directing users to utilize Sentry SDKs for error capturing.
…d debugging flow Expanded the structured logs documentation to include a detailed explanation of trace-connected logs, emphasizing their role in debugging. Added practical search examples for log queries and clarified the seamless workflow from log entry to trace analysis. Improved overall clarity and context for users investigating issues through logs.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR significantly enhances the documentation for Sentry's Structured Logs feature by adding more detailed explanations, practical examples, and improved navigation. The changes focus on clarifying the "trace-connected" concept and expanding documentation for log drains across different platforms.
- Added comprehensive explanation of trace-connected logs and their debugging workflow
- Expanded search examples and filtering documentation with practical use cases
- Reorganized and enhanced the log drains documentation with a detailed platform support table
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/product/explore/logs/index.mdx | Enhanced overview with trace-connected explanation, added search examples, debugging flow section, and improved cross-linking to related documentation |
| docs/product/explore/logs/getting-started/index.mdx | Reorganized log drains section with clearer platform integration listings and OTLP endpoint information |
| docs/product/drains/index.mdx | Complete rewrite with structured overview, platform support table, prerequisites, and getting started guide for better clarity |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sfanahata
reviewed
Nov 24, 2025
sfanahata
reviewed
Nov 24, 2025
sfanahata
approved these changes
Nov 24, 2025
Contributor
sfanahata
left a comment
There was a problem hiding this comment.
A couple of suggestions, but looks good! Much more detailed <3
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
Co-authored-by: Shannon Anahata <shannon.anahata@gmail.com>
AbhiPrasad
added a commit
that referenced
this pull request
Dec 1, 2025
After doing a read through of #15595, I realized we could probably better incorporate details on forwarders, which I added as part of #15623. This hopefully makes this section a bit easier to grok, which is important as I'm going to link to this doc from onboarding within a couple of days, so it's going to get a lot more traffic. Thank you @KyleTryon for kick starting the work on this, made it much easier for me to conceptualize the needed sections on this. https://sentry-docs-git-abhi-refactor-drains-index.sentry.dev/product/drains/
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates Sentry's documentation for logs and drains to provide clearer explanations, improved onboarding, and better guidance for users integrating platform-native logs and traces. The changes introduce new overview sections, clarify the benefits of trace-connected logs, and enhance instructions for setting up log drains across supported platforms.
Documentation improvements and onboarding clarity:
docs/product/drains/index.mdx. This helps users understand when and how to use drains for platform-level telemetry.Feature explanation and search enhancements:
Usability and search improvements: