Skip to content

Conversation

@philipphofmann
Copy link
Member

@philipphofmann philipphofmann commented Dec 3, 2024

DESCRIBE YOUR PR

Explain that most SDKs will add the HTTP query string and fragment as a data attribute to breadcrumbs, which is recommended in the develop docs.

This section is duplicated for all SDKs, so I updated it for all that have the following section:

Breadcrumbs → Some SDKs (JavaScript and the Java logging integrations, for example) will pick up previously executed log statements. Do not log PII if using this feature and including log statements as breadcrumbs in the event. Some backend SDKs will also record database queries, which may need to be scrubbed.

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

Explain that most SDKs will add the HTTP query string and fragment as a
data attribute to breadcrumbs.
@philipphofmann philipphofmann requested a review from a team December 3, 2024 13:27
@vercel
Copy link

vercel bot commented Dec 3, 2024

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

@codecov
Copy link

codecov bot commented Dec 3, 2024

Bundle Report

Changes will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.2MB 9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.11MB 6 bytes (-0.0%) ⬇️

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for updating, LGTM! 💪

@philipphofmann philipphofmann merged commit 2084fa5 into master Dec 5, 2024
11 checks passed
@philipphofmann philipphofmann deleted the feat/crumb-http-data-scrubbing branch December 5, 2024 13:16
Lms24 pushed a commit that referenced this pull request Dec 13, 2024
Explain that most SDKs will add the HTTP query string and fragment as a
data attribute to breadcrumbs.
@github-actions github-actions bot locked and limited conversation to collaborators Dec 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants