Skip to content

ref(replay): add docs about custom breadcrumbs #12180

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Dec 18, 2024
Merged

ref(replay): add docs about custom breadcrumbs #12180

merged 3 commits into from
Dec 18, 2024

Conversation

@michellewzhang
Copy link
Member

@michellewzhang michellewzhang commented Dec 18, 2024

closes #12178

@vercel
Copy link

vercel bot commented Dec 18, 2024 •
edited
Loading

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 Dec 18, 2024 8:28pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Dec 18, 2024 8:28pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Dec 18, 2024 8:28pm

@michellewzhang michellewzhang marked this pull request as ready for review December 18, 2024 17:50
@michellewzhang michellewzhang requested review from a team and billyvg December 18, 2024 17:51
@codecov
Copy link

codecov bot commented Dec 18, 2024

Bundle Report

Changes will increase total bundle size by 552 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.35MB 558 bytes (0.01%) ⬆️
sentry-docs-client-array-push 9.28MB 6 bytes (-0.0%) ⬇️

billyvg
billyvg reviewed Dec 18, 2024
View reviewed changes
Copy link
Member

@billyvg billyvg left a comment

Choose a reason for hiding this comment

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

LGTM -- should we talk about the title as well?

https://github.com/getsentry/sentry/blob/master/static/app/utils/replays/getFrameDetails.tsx#L458-L471

@michellewzhang
Copy link
Member Author

michellewzhang commented Dec 18, 2024

LGTM -- should we talk about the title as well?

https://github.com/getsentry/sentry/blob/master/static/app/utils/replays/getFrameDetails.tsx#L458-L471

the title will always be "custom" since the category is set to be custom in hydrateBreadcrumbs.tsx:

https://github.com/getsentry/sentry/blob/20d585fc120c3c0d086c353ad04d04c8bf3d4917/static/app/utils/replays/hydrateBreadcrumbs.tsx#L28-L39

@billyvg
Copy link
Member

billyvg commented Dec 18, 2024

getsentry/sentry@master/static/app/utils/replays/getFrameDetails.tsx#L458-L471

@michellewzhang Isn't it category -> defaultTitle() -> 'custom'? (And then defaultTitle() again in <BreadcrumbItem>?

@michellewzhang
Copy link
Member Author

michellewzhang commented Dec 18, 2024

getsentry/sentry@master/static/app/utils/replays/getFrameDetails.tsx#L458-L471

@michellewzhang Isn't it category -> defaultTitle() -> 'custom'? (And then defaultTitle() again in <BreadcrumbItem>?

ohh, you're totally right. i'll update the docs

billyvg
billyvg approved these changes Dec 18, 2024
View reviewed changes
docs/platforms/javascript/common/session-replay/configuration.mdx

![Custom breadcrumb example with data](./img/data-custom-breadcrumb.png)

The title of the breadcrumb will be the breadcrumb `category` that you set. If no `category` is set, then we will use the breadcrumb `message`. If that doesn't exist, we'll use the `description`. The last fallback with be a default title of "Custom".
Copy link
Member

@billyvg billyvg Dec 18, 2024

Choose a reason for hiding this comment

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

😭

Copy link
Member Author

@michellewzhang michellewzhang Dec 18, 2024

Choose a reason for hiding this comment

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

💀

@michellewzhang michellewzhang merged commit 3bd09b3 into master Dec 18, 2024
11 checks passed
@michellewzhang michellewzhang deleted the mz/custom-breadcrumbs branch December 18, 2024 20:32
@github-actions github-actions bot locked and limited conversation to collaborators Jan 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@billyvg billyvg billyvg approved these changes

@aliu39 aliu39 aliu39 approved these changes

+1 more reviewer

@c298lee c298lee c298lee approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add some documentation regarding custom breadcrumbs in Replay

5 participants

@michellewzhang @billyvg @c298lee @aliu39