Add more detailed explanation on beforeBreadcrumb function #1050
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.
I was stuck on why my Sentry breadcrumbs were just described as
generic
with a timestamp attached to it. I could not clearly find out where the issue was, I thought it would be because I was adding the breadcrumb incorrectly.Instead, I found that in the
beforeBreadcrumb
function you had to return the actual (modified) breadcrumb instead oftrue
orfalse
, which I could not clearly find in the docs.Hence this PR! If you have a different idea on how it should be worded, let me know!