docs(data-collected): Clarify HTTP header and cookie collection differences (browser/server)#17945
docs(data-collected): Clarify HTTP header and cookie collection differences (browser/server)#17945s1gr1d wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
inventarSarah
left a comment
There was a problem hiding this comment.
Looks good to me 🙌
| On the server-side, incoming request headers (and outgoing response headers) are added as span attributes by the <PlatformLink to="/configuration/integrations/http/">Http Integration</PlatformLink> **by default**. | ||
| Sensitive values (such as auth tokens and secrets) and PII headers (such as forwarding and IP headers) are automatically filtered. | ||
| Setting `sendDefaultPii: true` relaxes the PII-header filtering so those headers are captured too. Sensitive keys remain filtered regardless. | ||
| You can configure request headers, response headers, and cookies independently using the `dataCollection` option. |
There was a problem hiding this comment.
I did not find dataCollection documented on the Options page -- do you know if documenting it is already planned? If not, we should create an issue for it and then also link to it from here -- wdyt?
There was a problem hiding this comment.
+1 on waiting with this until documented
…rences (browser/server)
2fa5a2a to
d7bfe16
Compare
| <PlatformSection notSupported={["javascript", "javascript.angular", "javascript.capacitor", "javascript.cordova", "javascript.ember", "javascript.gatsby", "javascript.react", "javascript.solid", "javascript.svelte", "javascript.vue", "javascript.wasm"]}> | ||
|
|
||
| On the server-side, incoming request headers (and outgoing response headers) are added as span attributes by the <PlatformLink to="/configuration/integrations/http/">Http Integration</PlatformLink> **by default**. | ||
| Sensitive values (such as auth tokens and secrets) are automatically scrubbed, while the header keys are kept. PII headers (such as forwarding and IP headers) are also filtered by default. | ||
|
|
||
| </PlatformSection> |
There was a problem hiding this comment.
Bug: The documentation incorrectly shows the server-side HTTP Headers section for Cloudflare and Deno, where the required Http Integration is unsupported.
Severity: LOW
Suggested Fix
Update the documentation component to conditionally hide the server-side HTTP Headers section for platforms where the Http Integration is not supported, such as javascript.cloudflare and javascript.deno, to align with the behavior of the server-side Cookies section.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location:
docs/platforms/javascript/common/data-management/data-collected/index.mdx#L44-L49
Potential issue: The documentation for server-side HTTP Headers is incorrectly displayed
for Cloudflare and Deno users. It states that the `Http Integration` captures headers by
default, but this integration is not supported on those platforms. This is inconsistent
with other parts of the documentation, such as the server-side Cookies section, which
correctly hides itself for unsupported platforms, leading to potential confusion for
developers using Cloudflare or Deno.
DESCRIBE YOUR PR
Clarifies header collection. Mentioned in this PR:
sendDefaultPiiis enabled. sentry-javascript#20706closes getsentry/sentry-javascript#20706
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: