This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625

Merged
Lms24 merged 4 commits into from
Jul 1, 2022
Merged

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled #625

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
543c15a
ref(DSC): Only include user_id if send-default-pii option is enabled
Lms24 Jun 30, 2022
efbc5a1
Address user_id handling in head vs. downstream SDKs
Lms24 Jul 1, 2022
8679a0d
rename send-default-pii to send_default_pii
Lms24 Jul 1, 2022
e818094
change structure and add alert with subject to change notice
Lms24 Jul 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions src/docs/sdk/performance/dynamic-sampling-context.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.

@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?

@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.

@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.

@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.

@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.

@lforstlforstJul 1, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.

This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.

- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.

Expand Down
, '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

This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625
 Merged

Lms24
merged 4 commits into

from

Jul 1, 2022
 Merged


ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled
#625
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
543c15a

ref(DSC): Only include user_id if send-default-pii option is enabled


Lms24 Jun 30, 2022
efbc5a1

Address user_id handling in head vs. downstream SDKs


Lms24 Jul 1, 2022
8679a0d

rename send-default-pii to send_default_pii


Lms24 Jul 1, 2022
e818094

change structure and add alert with subject to change notice


Lms24 Jul 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 24 additions & 2 deletions
src/docs/sdk/performance/dynamic-sampling-context.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.
@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?
@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.
@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.
@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.
@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.
@lforstlforstJul 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.
This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.


Expand Down

, '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

This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625
 Merged

Lms24
merged 4 commits into

from

Jul 1, 2022
 Merged


ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled
#625
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
543c15a

ref(DSC): Only include user_id if send-default-pii option is enabled


Lms24 Jun 30, 2022
efbc5a1

Address user_id handling in head vs. downstream SDKs


Lms24 Jul 1, 2022
8679a0d

rename send-default-pii to send_default_pii


Lms24 Jul 1, 2022
e818094

change structure and add alert with subject to change notice


Lms24 Jul 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 24 additions & 2 deletions
src/docs/sdk/performance/dynamic-sampling-context.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.
@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?
@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.
@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.
@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.
@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.
@lforstlforstJul 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.
This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.


Expand Down

, '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

This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625
 Merged

Lms24
merged 4 commits into

from

Jul 1, 2022
 Merged


ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled
#625
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
543c15a

ref(DSC): Only include user_id if send-default-pii option is enabled


Lms24 Jun 30, 2022
efbc5a1

Address user_id handling in head vs. downstream SDKs


Lms24 Jul 1, 2022
8679a0d

rename send-default-pii to send_default_pii


Lms24 Jul 1, 2022
e818094

change structure and add alert with subject to change notice


Lms24 Jul 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 24 additions & 2 deletions
src/docs/sdk/performance/dynamic-sampling-context.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.
@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?
@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.
@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.
@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.
@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.
@lforstlforstJul 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.
This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.


Expand Down

, '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

This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625
 Merged

Lms24
merged 4 commits into

from

Jul 1, 2022
 Merged


ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled
#625
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
543c15a

ref(DSC): Only include user_id if send-default-pii option is enabled


Lms24 Jun 30, 2022
efbc5a1

Address user_id handling in head vs. downstream SDKs


Lms24 Jul 1, 2022
8679a0d

rename send-default-pii to send_default_pii


Lms24 Jul 1, 2022
e818094

change structure and add alert with subject to change notice


Lms24 Jul 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 24 additions & 2 deletions
src/docs/sdk/performance/dynamic-sampling-context.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.
@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?
@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.
@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.
@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.
@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.
@lforstlforstJul 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.
This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.


Expand Down

, '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

This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625
 Merged

Lms24
merged 4 commits into

from

Jul 1, 2022
 Merged


ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled
#625
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
543c15a

ref(DSC): Only include user_id if send-default-pii option is enabled


Lms24 Jun 30, 2022
efbc5a1

Address user_id handling in head vs. downstream SDKs


Lms24 Jul 1, 2022
8679a0d

rename send-default-pii to send_default_pii


Lms24 Jul 1, 2022
e818094

change structure and add alert with subject to change notice


Lms24 Jul 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 24 additions & 2 deletions
src/docs/sdk/performance/dynamic-sampling-context.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.
@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?
@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.
@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.
@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.
@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.
@lforstlforstJul 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.
This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.


Expand Down

, '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

This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625
 Merged

Lms24
merged 4 commits into

from

Jul 1, 2022
 Merged


ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled
#625
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
543c15a

ref(DSC): Only include user_id if send-default-pii option is enabled


Lms24 Jun 30, 2022
efbc5a1

Address user_id handling in head vs. downstream SDKs


Lms24 Jul 1, 2022
8679a0d

rename send-default-pii to send_default_pii


Lms24 Jul 1, 2022
e818094

change structure and add alert with subject to change notice


Lms24 Jul 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 24 additions & 2 deletions
src/docs/sdk/performance/dynamic-sampling-context.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.
@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?
@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.
@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.
@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.
@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.
@lforstlforstJul 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.
This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.


Expand Down

, '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

This repository was archived by the owner on Aug 14, 2024. It is now read-only.

ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled#625
 Merged

Lms24
merged 4 commits into

from

Jul 1, 2022
 Merged


ref(DSC): Only include user_id in DSC if the send-default-pii option is enabled
#625
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
543c15a

ref(DSC): Only include user_id if send-default-pii option is enabled


Lms24 Jun 30, 2022
efbc5a1

Address user_id handling in head vs. downstream SDKs


Lms24 Jul 1, 2022
8679a0d

rename send-default-pii to send_default_pii


Lms24 Jul 1, 2022
e818094

change structure and add alert with subject to change notice


Lms24 Jul 1, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


26 changes: 24 additions & 2 deletions
src/docs/sdk/performance/dynamic-sampling-context.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,6 +106,28 @@ After the DSC of a particular trace has been frozen, API calls like `set_user` o
Dynamic Sampling Context is sent to Sentry via the `trace` envelope header and is propagated to downstream SDKs via a baggage header.

All of the values in the payloads below are required (non-optional) in a sense, that when they are known to an SDK at the time a transaction envelope is sent to Sentry, or at the time a baggage header is propagated, they must also be included in said envelope or baggage.

### Handling Sensitive Data and PII

<Alert level="info">

The currently specified solution is subject to change and will be revisited, once all SDKs implemented a mechanism of controlling where DSC and tracing data should be propagated to.
This mechanism is still up for discussion and implementation but it will be similar to the `tracingOrigins` property that is already used in some SDKs right now.
In the meantime, the solution below should be adopted from all SDKs to handle PII concerns.

</Alert>

It should be noted that DSC holds potentially sensitive data, such as PII, which needs to be handled carefully.

Therefore, the **only exception** to the rule that all available DSC values must be collected at DSC
population time, is the `user_id` field.
To avoid this sensitive information being leaked to third parties, `user_id` should only be added to the DSC, if the <Link to="/sdk/data-handling/#sensitive-data">`send_default_pii`</Link> option was enabled in the SDK's init options.
Note that this only applies for the head-of-trace SDK that populates the DSC content.
In case downstream SDKs receive a `user_id` in incoming DSC, they should continue to propagate it.
The rationale behind this is that incoming DSC [must be frozen](#freezing-dynamic-sampling-context) and users must make DS rules based on the head SDK's DSC data anyway.

#### Strictly required values

In any case, `trace_id`, `public_key`, and `sample_rate` should always be known to an SDK, so these values are strictly required.

### Envelope Header
Expand All@@ -118,7 +140,7 @@ The value of this envelope header is a JSON object with the following fields:
- `sample_rate` (string) - The sample rate as defined by the user on the SDK. This string should always be a number between (and including) 0 and 1 in basic float notation (`0.04242`) - no funky business like exponents or anything similar. If a `tracesSampler` callback was used for the sampling decision, its result should be used for `sample_rate` instead of the `tracesSampleRate` from `SentryOptions`. In case `tracesSampler` returns `True` it should be sent as `1.0`, `False` should be sent as `0.0`.
- `release` (string) - The release name as specified in client options`.
- `environment` (string) - The environment name as specified in client options.
@adinaueradinauerJun 30, 2022

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.

So only sending this in the envelope header if tracingOrigins allows would mean we have to check tracingOrigins against the DSN or proxy to see if we're allowed to send it, correct?
@Lms24Lms24Jun 30, 2022

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.

Are you referring to user_id? Could you elaborate what you mean here? Generally, in the context of this PR we're not including tracingOrigins in any way or condition. Just wanted to mention in the description that discussions around it are in the works.
@adinaueradinauerJun 30, 2022

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.

Yes, this referred to user_id. Once discussed we could add something to clarify whether we need to check tracingOrigins against DSN / proxy.
@Lms24Lms24Jul 1, 2022

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.

So currently, the JS SDK's BrowserTracing integration does not check for the DSN (or a proxy) but it only determines if the URL of the outgoing request matches a string or regex specified in tracingOrigins. So far, we haven't considered changing this but sincetracingOrigins is gonna be standardized, we can certainly discuss this. I would suggest though, discussing this in a separate issue about the tracingOrigins spec/changes.
@adinaueradinauerJul 1, 2022

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.

For Java we have our own transport(s) for communication with Sentry so we'd have to separately add the check there if we so choose.
@lforstlforstJul 1, 2022

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

tracingOrigins doesn't really matter when determining what is sent to Sentry. tracingOrigins should simply control which targets should receive a) a sentry-trace header b) DSC in a baggage header.
This shouldn't concern transports but rather request instrumentation. I might be wrong though since I don't know specifics on the Java SDK.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `user_id` (string) - User ID as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>. **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `user_segment` (string) - User segment as set by the user with <Link to="/sdk/unified-api/#scope">`scope.set_user`</Link>.
- `transaction` (string) - The transaction name set on the scope.

Expand All@@ -133,7 +155,7 @@ SDKs may use the following keys to set entries on `baggage` HTTP headers:
- `sentry-sample_rate`
- `sentry-release`
- `sentry-environment`
- `sentry-user_id`
- `sentry-user_id` - **Only included, if [`send_default_pii`](#handling-sensitive-data-and-pii) is enabled.**
- `sentry-user_segment`
- `sentry-transaction`
Comment thread
Lms24 marked this conversation as resolved.


Expand Down