Update sentry breadcrumbs documentation #14742
Draft
+1
−1
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
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
…parison Co-authored-by: sasha.blumenfeld <sasha.blumenfeld@sentry.io>
|
Cursor Agent can help with this pull request. Just |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Bundle ReportChanges will decrease total bundle size by 9.3kB (-0.04%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
AbhiPrasad
reviewed
Aug 27, 2025
| @@ -4,7 +4,7 @@ description: "Learn about using breadcrumbs on the Issue Details page to help de | |||
| sidebar_order: 60 | |||
| --- | |||
|
|
|||
| Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an issue. These events are very similar to traditional logs, but can record more rich structured data. | |||
| Sentry uses breadcrumbs to capture a trail of events leading up to an error. They provide context about what happened just before an issue occurred. Breadcrumbs are lightweight by design, attached to errors and transactions, and subject to the error's size limit. For a searchable, unsampled trail of events, Sentry recommends using [logs](https://docs.sentry.io/product/explore/logs/). Logs capture a continuous stream of activity across your application. They are structured, searchable, and connected to spans and traces. Unlike breadcrumbs, correlated logs have no size limits and provide a broader view of everything happening in your system—not just the context before an error. | |||
There was a problem hiding this comment.
Suggested change
| Sentry uses breadcrumbs to capture a trail of events leading up to an error. They provide context about what happened just before an issue occurred. Breadcrumbs are lightweight by design, attached to errors and transactions, and subject to the error's size limit. For a searchable, unsampled trail of events, Sentry recommends using [logs](https://docs.sentry.io/product/explore/logs/). Logs capture a continuous stream of activity across your application. They are structured, searchable, and connected to spans and traces. Unlike breadcrumbs, correlated logs have no size limits and provide a broader view of everything happening in your system—not just the context before an error. | |
| Sentry uses breadcrumbs to capture a trail of events leading up to an error. They provide context about what happened just before an issue occurred. Breadcrumbs are lightweight by design, attached to errors and transactions, and subject to the error's size limit. For a searchable, unsampled trail of events, Sentry recommends using [logs](/product/explore/logs/). Logs capture a continuous stream of activity across your application. They are structured, searchable, and connected to spans and traces. Unlike breadcrumbs, correlated logs have no size limits and provide a broader view of everything happening in your system—not just the context before an error. |
There was a problem hiding this comment.
correlated logs have no size limits
this is not correct, there's still an upper bound. Maybe we just remove
Logs capture a continuous stream of activity across your application. They are structured, searchable, and connected to spans and traces. Unlike breadcrumbs, correlated logs have no size limits and provide a broader view of everything happening in your system—not just the context before an error.
as we do mention the size limit in subject to the error's size limit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
DESCRIBE YOUR PR
Updated the first paragraph of the breadcrumbs documentation (
docs/product/issues/issue-details/breadcrumbs/index.mdx).This change clarifies the purpose and limitations of breadcrumbs, distinguishing them from logs. It emphasizes that breadcrumbs are lightweight and context-specific to errors, while recommending logs for a broader, searchable, and unsampled event stream. This provides a more accurate and comprehensive understanding of when to use each feature.
IS YOUR CHANGE URGENT?
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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
Slack Thread