feat(javascript): Add "Data Collected" - #13527

Merged
s1gr1d merged 7 commits into
masterfrom
sig/js-data-collected
Apr 30, 2025
Merged

feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom
sig/js-data-collected

Conversation

@s1gr1d

@s1gr1ds1gr1d commented Apr 28, 2025•
edited
Loading

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Adds a "Data Collected" page to JavaScript-based SDKs

Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/

closes#13407

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

@vercel

vercelBot commented Apr 28, 2025•
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am

@codecov

codecovBot commented Apr 28, 2025•
edited
Loading

Copy link
Copy Markdown

Bundle Report

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

Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%

timfish
timfish approved these changes Apr 28, 2025
View reviewed changes

@timfishtimfish left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...

Lms24
Lms24 reviewed Apr 29, 2025
View reviewed changes

@Lms24Lms24 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated

## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.

@Lms24Lms24Apr 29, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?

@s1gr1ds1gr1dApr 29, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D

But since we don't filter sending the HTTP headers I'll rewrite this

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated

## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

@Lms24Lms24Apr 29, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

even if enabled

if what is enabled -- sendDefaultPii?

Some will only set the user ID

I'm curious myself now, which ones? 😅

@s1gr1ds1gr1dApr 29, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

That's bad wording 🙈
It basically depends on what the user provides in the object. I'm going to re-write this all 😅

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.

@Lms24Lms24Apr 29, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Comment on lines +43 to +46
## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

two things:

l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to

m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body

@Lms24Lms24Apr 29, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?

I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated

By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>

@Lms24Lms24Apr 29, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated
chargome
chargome reviewed Apr 30, 2025
View reviewed changes

@chargomechargome left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice summary!

Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx Outdated
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d requested review from Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d merged commit 0144eed into masterApr 30, 2025
@s1gr1d
s1gr1d deleted the sig/js-data-collected branch April 30, 2025 14:57
codyde added a commit that referenced this pull request May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot locked and limited conversation to collaborators May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs

4 participants

@s1gr1d@timfish@Lms24@chargome
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(javascript): Add "Data Collected" - #13527
Merged
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Apr 30, 2025
Merged
feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Member
DESCRIBE YOUR PR
Adds a "Data Collected" page to JavaScript-based SDKs
Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/
closes#13407
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
@vercel
vercelBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
@codecov
codecovBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Bundle Report
Changes will increase total bundle size by 249 bytes (0.0%) ⬆️. This is within the configured threshold ✅
Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%
timfish
timfish
approved these changes
Apr 28, 2025
View reviewed changes
@timfishtimfish
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...
Lms24
Lms24
reviewed
Apr 29, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D
But since we don't filter sending the HTTP headers I'll rewrite this
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

even if enabled
if what is enabled -- sendDefaultPii?
Some will only set the user ID
I'm curious myself now, which ones? 😅
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That's bad wording 🙈

It basically depends on what the user provides in the object. I'm going to re-write this all 😅
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

Comment on lines

+43
 to 
+46

## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

two things:
l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to
m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?
I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

chargome
chargome
reviewed
Apr 30, 2025
View reviewed changes
@chargomechargome
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice summary!
Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d
requested review from
Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d
merged commit 0144eed
into
masterApr 30, 2025
@s1gr1d
s1gr1d
deleted the

sig/js-data-collected

branch
April 30, 2025 14:57
codyde added a commit
that referenced
this pull request
May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs


4 participants

@s1gr1d@timfish@Lms24@chargome

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(javascript): Add "Data Collected" - #13527
Merged
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Apr 30, 2025
Merged
feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Member
DESCRIBE YOUR PR
Adds a "Data Collected" page to JavaScript-based SDKs
Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/
closes#13407
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
@vercel
vercelBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
@codecov
codecovBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Bundle Report
Changes will increase total bundle size by 249 bytes (0.0%) ⬆️. This is within the configured threshold ✅
Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%
timfish
timfish
approved these changes
Apr 28, 2025
View reviewed changes
@timfishtimfish
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...
Lms24
Lms24
reviewed
Apr 29, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D
But since we don't filter sending the HTTP headers I'll rewrite this
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

even if enabled
if what is enabled -- sendDefaultPii?
Some will only set the user ID
I'm curious myself now, which ones? 😅
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That's bad wording 🙈

It basically depends on what the user provides in the object. I'm going to re-write this all 😅
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

Comment on lines

+43
 to 
+46

## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

two things:
l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to
m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?
I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

chargome
chargome
reviewed
Apr 30, 2025
View reviewed changes
@chargomechargome
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice summary!
Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d
requested review from
Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d
merged commit 0144eed
into
masterApr 30, 2025
@s1gr1d
s1gr1d
deleted the

sig/js-data-collected

branch
April 30, 2025 14:57
codyde added a commit
that referenced
this pull request
May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs


4 participants

@s1gr1d@timfish@Lms24@chargome

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(javascript): Add "Data Collected" - #13527
Merged
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Apr 30, 2025
Merged
feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Member
DESCRIBE YOUR PR
Adds a "Data Collected" page to JavaScript-based SDKs
Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/
closes#13407
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
@vercel
vercelBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
@codecov
codecovBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Bundle Report
Changes will increase total bundle size by 249 bytes (0.0%) ⬆️. This is within the configured threshold ✅
Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%
timfish
timfish
approved these changes
Apr 28, 2025
View reviewed changes
@timfishtimfish
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...
Lms24
Lms24
reviewed
Apr 29, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D
But since we don't filter sending the HTTP headers I'll rewrite this
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

even if enabled
if what is enabled -- sendDefaultPii?
Some will only set the user ID
I'm curious myself now, which ones? 😅
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That's bad wording 🙈

It basically depends on what the user provides in the object. I'm going to re-write this all 😅
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

Comment on lines

+43
 to 
+46

## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

two things:
l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to
m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?
I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

chargome
chargome
reviewed
Apr 30, 2025
View reviewed changes
@chargomechargome
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice summary!
Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d
requested review from
Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d
merged commit 0144eed
into
masterApr 30, 2025
@s1gr1d
s1gr1d
deleted the

sig/js-data-collected

branch
April 30, 2025 14:57
codyde added a commit
that referenced
this pull request
May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs


4 participants

@s1gr1d@timfish@Lms24@chargome

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(javascript): Add "Data Collected" - #13527
Merged
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Apr 30, 2025
Merged
feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Member
DESCRIBE YOUR PR
Adds a "Data Collected" page to JavaScript-based SDKs
Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/
closes#13407
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
@vercel
vercelBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
@codecov
codecovBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Bundle Report
Changes will increase total bundle size by 249 bytes (0.0%) ⬆️. This is within the configured threshold ✅
Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%
timfish
timfish
approved these changes
Apr 28, 2025
View reviewed changes
@timfishtimfish
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...
Lms24
Lms24
reviewed
Apr 29, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D
But since we don't filter sending the HTTP headers I'll rewrite this
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

even if enabled
if what is enabled -- sendDefaultPii?
Some will only set the user ID
I'm curious myself now, which ones? 😅
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That's bad wording 🙈

It basically depends on what the user provides in the object. I'm going to re-write this all 😅
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

Comment on lines

+43
 to 
+46

## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

two things:
l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to
m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?
I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

chargome
chargome
reviewed
Apr 30, 2025
View reviewed changes
@chargomechargome
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice summary!
Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d
requested review from
Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d
merged commit 0144eed
into
masterApr 30, 2025
@s1gr1d
s1gr1d
deleted the

sig/js-data-collected

branch
April 30, 2025 14:57
codyde added a commit
that referenced
this pull request
May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs


4 participants

@s1gr1d@timfish@Lms24@chargome

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(javascript): Add "Data Collected" - #13527
Merged
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Apr 30, 2025
Merged
feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Member
DESCRIBE YOUR PR
Adds a "Data Collected" page to JavaScript-based SDKs
Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/
closes#13407
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
@vercel
vercelBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
@codecov
codecovBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Bundle Report
Changes will increase total bundle size by 249 bytes (0.0%) ⬆️. This is within the configured threshold ✅
Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%
timfish
timfish
approved these changes
Apr 28, 2025
View reviewed changes
@timfishtimfish
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...
Lms24
Lms24
reviewed
Apr 29, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D
But since we don't filter sending the HTTP headers I'll rewrite this
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

even if enabled
if what is enabled -- sendDefaultPii?
Some will only set the user ID
I'm curious myself now, which ones? 😅
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That's bad wording 🙈

It basically depends on what the user provides in the object. I'm going to re-write this all 😅
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

Comment on lines

+43
 to 
+46

## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

two things:
l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to
m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?
I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

chargome
chargome
reviewed
Apr 30, 2025
View reviewed changes
@chargomechargome
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice summary!
Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d
requested review from
Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d
merged commit 0144eed
into
masterApr 30, 2025
@s1gr1d
s1gr1d
deleted the

sig/js-data-collected

branch
April 30, 2025 14:57
codyde added a commit
that referenced
this pull request
May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs


4 participants

@s1gr1d@timfish@Lms24@chargome

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(javascript): Add "Data Collected" - #13527
Merged
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Apr 30, 2025
Merged
feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Member
DESCRIBE YOUR PR
Adds a "Data Collected" page to JavaScript-based SDKs
Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/
closes#13407
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
@vercel
vercelBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
@codecov
codecovBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Bundle Report
Changes will increase total bundle size by 249 bytes (0.0%) ⬆️. This is within the configured threshold ✅
Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%
timfish
timfish
approved these changes
Apr 28, 2025
View reviewed changes
@timfishtimfish
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...
Lms24
Lms24
reviewed
Apr 29, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D
But since we don't filter sending the HTTP headers I'll rewrite this
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

even if enabled
if what is enabled -- sendDefaultPii?
Some will only set the user ID
I'm curious myself now, which ones? 😅
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That's bad wording 🙈

It basically depends on what the user provides in the object. I'm going to re-write this all 😅
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

Comment on lines

+43
 to 
+46

## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

two things:
l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to
m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?
I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

chargome
chargome
reviewed
Apr 30, 2025
View reviewed changes
@chargomechargome
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice summary!
Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d
requested review from
Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d
merged commit 0144eed
into
masterApr 30, 2025
@s1gr1d
s1gr1d
deleted the

sig/js-data-collected

branch
April 30, 2025 14:57
codyde added a commit
that referenced
this pull request
May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs


4 participants

@s1gr1d@timfish@Lms24@chargome

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(javascript): Add "Data Collected" - #13527
Merged
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Apr 30, 2025
Merged
feat(javascript): Add "Data Collected"#13527
s1gr1d merged 7 commits into
masterfrom 
sig/js-data-collected
Conversation
@s1gr1d
@s1gr1ds1gr1d
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Member
DESCRIBE YOUR PR
Adds a "Data Collected" page to JavaScript-based SDKs
Preview: https://sentry-docs-k1k33l012.sentry.dev/platforms/javascript/data-management/data-collected/
closes#13407
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
@vercel
vercelBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎
NameStatusPreviewCommentsUpdated (UTC)
sentry-docs✅ Ready (Inspect)Visit Preview💬 Add feedbackApr 30, 2025 10:56am
2 Skipped Deployments
NameStatusPreviewCommentsUpdated (UTC)
changelog⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
develop-docs⬜️ Ignored (Inspect)Visit PreviewApr 30, 2025 10:56am
@codecov
codecovBot
commented
Apr 28, 2025•

edited

Loading

Copy link


Copy Markdown

Bundle Report
Changes will increase total bundle size by 249 bytes (0.0%) ⬆️. This is within the configured threshold ✅
Detailed changes
Bundle nameSizeChange
sentry-docs-server-cjs11.14MB255 bytes (0.0%) ⬆️
sentry-docs-client-array-push9.47MB-6 bytes (-0.0%) ⬇️
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
static/chunks/pages/_app-*.js-3 bytes868.7kB-0.0%
static/chunks/8165-*.js-3 bytes410.1kB-0.0%
server/middleware-*.js-5.55kB1.0kB-84.74%
server/middleware-*.js5.55kB6.55kB555.3% ⚠️
static/Nam-*.js(New)77 bytes77 bytes100.0% 🚀
static/Nam-*.js(New)578 bytes578 bytes100.0% 🚀
static/3XbmzHxbCCVy-*.js(Deleted)-578 bytes0 bytes-100.0% 🗑️
static/3XbmzHxbCCVy-*.js(Deleted)-77 bytes0 bytes-100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
Asset NameSize ChangeTotal SizeChange (%)
1729.js-3 bytes1.75MB-0.0%
../instrumentation.js-3 bytes1.08MB-0.0%
9523.js-3 bytes1.05MB-0.0%
../app/[[...path]]/page.js.nft.json88 bytes388.52kB0.02%
../app/platform-redirect/page.js.nft.json88 bytes388.43kB0.02%
../app/sitemap.xml/route.js.nft.json88 bytes386.4kB0.02%
timfish
timfish
approved these changes
Apr 28, 2025
View reviewed changes
@timfishtimfish
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

I think the Electron SDK is going to require its own page for this so I think this can be merged and that can come in another PR...
Lms24
Lms24
reviewed
Apr 29, 2025
View reviewed changes
@Lms24Lms24
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

This great, thanks for taking the time to collect all of this information. I had a couple of questions and suggestions but I think this is already in a good place :)
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## HTTP Headers

By default, the Sentry SDK doesn't send any HTTP response or request headers.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

this isn't entirely true, right? IIRC from your PR, it's true for browser but in Node we always send headers? If so, let's maybe only show this for browser JS?
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

yeah this is currently not true but I was already writing the optimistic version of the docs for after my PR is merged :D
But since we don't filter sending the HTTP headers I'll rewrite this
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


## Information About Logged-in User

By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

even if enabled
if what is enabled -- sendDefaultPii?
Some will only set the user ID
I'm curious myself now, which ones? 😅
@s1gr1ds1gr1dApr 29, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

That's bad wording 🙈

It basically depends on what the user provides in the object. I'm going to re-write this all 😅
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few (e.g. <PlatformLink to="/user-feedback/">User Feedback</PlatformLink>) that will set the user ID, username, and email address.

To start sending logged-in user information, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii: true`</PlatformLink> in your `Sentry.init({})` config.
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hmm maybe I'm missing something but wouldn't I have to use setUser to actually set user data? Other than that, there's IP inferral and stuff but this is explained in the section below
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

Comment on lines

+43
 to 
+46

## Request Query String

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

two things:
l: let's add an example for a query param (and maybe also fragment?), just so that everyone understands what we're referring to
m: AFAIK we apply server-side PII scrubbing to the URL query and fragment fields. This doesn't change the fact that we send the data but maybe it's worth mentioning? I guess we do this on a lot of fields mentioned on this page in general, so instead of mentioning it here specifically, we could write a short section about it and link to the docs.
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx

The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data.

## Request Body
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Does this apply to all requests we collect (everywhere)?
I'd specifically mention if this applies to incoming or outgoing requests because I think there's different behaviour, right?
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated


By default, the Sentry SDK will not send local variables in the error stack trace in client-side JavaScript SDKs.

<PlatformSection notSupported={["javascript", "javascript.angular", "javascript.ember", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue"]}>
@Lms24Lms24Apr 29, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

l: I think you can use PlatformCategorySection to disable client-side SDKs here
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

chargome
chargome
reviewed
Apr 30, 2025
View reviewed changes
@chargomechargome
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Nice summary!
Comment threaddocs/platforms/javascript/common/configuration/integrations/vercelai.mdx
Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
Outdated

Comment threaddocs/platforms/javascript/common/data-management/data-collected/index.mdx
@s1gr1d
s1gr1d
requested review from
Lms24 and chargomeApril 30, 2025 10:19
@s1gr1d
s1gr1d
merged commit 0144eed
into
masterApr 30, 2025
@s1gr1d
s1gr1d
deleted the

sig/js-data-collected

branch
April 30, 2025 14:57
codyde added a commit
that referenced
this pull request
May 1, 2025
@codyde
Merge branch 'master' ofhttps://github.com/getsentry/sentry-docs
c6a3061
* 'master' of https://github.com/getsentry/sentry-docs:
Add "Data Collected" page for Godot SDK (and more) (#13533)
Clarify FK docs (#13562)
Clarify db index docs (#13561)
Remove non-functioning video embed (#13557)
Masinette integrations elba (#13503)
Incorporate Uptime Monitors Into The Crons Management Page (#13507)
feat(javascript): Add "Data Collected" (#13527)
docs(relay): remove entries that are not scrubbed by default (#13555)
flutter: Add note to app start integration (#13479)
ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
docs(python): add uv option to python install instructions (#13510)
add docs for supabase integration (#13545)
feat(native): add view hierarchy to develop docs (#13544)
feat(autofix): Update autofix images (#13540)
Ad alerts and dashboard page to new quickstart guide (#13522)
Add data enrichment page to new onboarding guide (#13508)
Add first onboarding guide to docs (#13462)
(feat) Sentry MCP Documentation (#13524)
feat(Capacitor): Migration guides for version 2 (#13022)
docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
May 16, 2025
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@timfishtimfishtimfish approved these changes
@mydeamydeaAwaiting requested review from mydea
@sfanahatasfanahataAwaiting requested review from sfanahata
@lucas-zimermanlucas-zimermanAwaiting requested review from lucas-zimerman
@chargomechargomeAwaiting requested review from chargome
@Lms24Lms24Awaiting requested review from Lms24

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Document "Data Collected" for JS SDKs


4 participants

@s1gr1d@timfish@Lms24@chargome