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 2 commits into
Conversation
…rences (browser/server)
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| <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) 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. | ||
|
|
||
| </PlatformSection> |
There was a problem hiding this comment.
Bug: The notSupported list for the HTTP Headers section is missing javascript.deno and javascript.cloudflare, incorrectly showing it for those platforms.
Severity: LOW
Suggested Fix
Add javascript.deno and javascript.cloudflare to the notSupported array in the component on line 34. This will align its behavior with the "Cookies" and "Request Body" sections and correctly hide the content for platforms where the Http Integration is not supported.
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#L34-L41
Potential issue: The documentation for server-side HTTP header collection is incorrectly
displayed for `javascript.deno` and `javascript.cloudflare` users. The `notSupported`
list for the HTTP Headers section is missing these platforms, causing the documentation
to claim the Http Integration captures headers by default. However, the Http
Integration's own documentation does not list Deno or Cloudflare as supported platforms.
This creates an inconsistency with other sections like "Cookies" and "Request Body"
which correctly hide this content for Deno and Cloudflare, leading to user confusion
about feature availability.
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
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: