docs(dev-docs): Bump dataCollection spec to candidate#18017
Open
chargome wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
chargome
force-pushed
the
cg/datacollection-specs-candidate
branch
from
c05fb1f to
73c69e2
Compare
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+518
to
+525
| | `userInfo` | Boolean | `true` | 1.0.0 | Automatically populate `user.*` fields (`user.id`, `user.email`, `user.username`, `user.ip_address`) from auto-instrumentation (e.g., inferring `user.ip_address` from an incoming HTTP request, or deriving user identity from framework session/auth context). Does **not** gate data explicitly set via `Sentry.setUser()`, which is always attached (see [User-Set Data and Scrubbing](#user-set-data-scrubbing)). Does not affect any other data category. | | ||
| | `cookies` | Key-value collection | `{ mode: "denyList" }` | 1.0.0 | Collect cookies. All key names are always included; the SDK scrubs values for keys matching the sensitive denylist or custom allow/deny terms. | | ||
| | `httpHeaders` | `{ request?, response? }` | Both `{ mode: "denyList" }` | 1.0.0 | Collect HTTP headers. Configure request and response independently using key-value collection modes. All key names are always included. | | ||
| | `httpBodies` | `string[]` (body types) | all valid body types | 1.0.0 | List of body types to collect. Omitted = all body types valid for the platform; empty array (`[]`) = off. Valid values: `"incomingRequest"`, `"outgoingRequest"`, `"incomingResponse"`, `"outgoingResponse"`. | | ||
| | `queryParams` | Key-value collection | `{ mode: "denyList" }` | 1.0.0 | Collect URL query parameters. All key names are always included; the SDK scrubs values for keys matching the sensitive denylist or custom allow/deny terms. | | ||
| | `genAI` | `{ inputs?, outputs? }` | Both `true` | 1.0.0 | For `inputs`: Include the content of generative AI inputs (e.g. prompt text, tool call arguments). <br /><br /> For `outputs`: Include the content of generative AI outputs (e.g. completion text, tool call results). Metadata such as model name and token counts is always collected regardless of these settings. | | ||
| | `stackFrameVariables` | Boolean | `true` | 1.0.0 | Include local variable values captured within stack frames. | | ||
| | `frameContextLines` | Integer (`Boolean` fallback) | `5` (`true`) | 1.0.0 | Number of source code lines to include above and below each stack frame. <br/> **`Boolean` fallback:** Not all platforms support integer configuration values. SDKs **MAY** accept a boolean, where `true` is equivalent to the platform default (typically `5`) and `false` is equivalent to `0` (no context lines). SDKs **SHOULD** prefer accepting an integer when their platform supports it. | |
Contributor
There was a problem hiding this comment.
Bug: The since version for several data collection options is incorrectly set to 1.0.0. It should reflect their original introduction version, 0.1.0, to maintain accurate historical context.
Severity: LOW
Suggested Fix
Revert the since values for the affected options to their original introduction versions as documented in the changelog (e.g., 0.1.0). Restore any removed historical context from the descriptions, such as the note about the userInfo default changing in 0.2.0.
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: develop-docs/sdk/foundations/client/data-collection/index.mdx#L518-L525
Potential issue: The `since` field for several data collection options, including
`userInfo`, `cookies`, and `httpHeaders`, has been updated to `1.0.0`. However, the
changelog confirms these options were introduced in version `0.1.0`. The established
convention in other specifications is that the `since` field denotes the version in
which a feature first appeared. This change misrepresents the history of these options,
which can mislead SDK implementors and affect compatibility decisions. Additionally,
historical context, such as the `userInfo` default changing in version `0.2.0`, has been
removed, further erasing the spec's evolution.
Also affects:
develop-docs/sdk/foundations/client/data-collection/index.mdx:44~44develop-docs/sdk/foundations/client/data-collection/index.mdx:89~89develop-docs/sdk/foundations/client/data-collection/index.mdx:99~99develop-docs/sdk/foundations/client/data-collection/index.mdx:111~111develop-docs/sdk/foundations/client/data-collection/index.mdx:202~202develop-docs/sdk/foundations/client/data-collection/index.mdx:220~220develop-docs/sdk/foundations/client/data-collection/index.mdx:248~248develop-docs/sdk/foundations/client/data-collection/index.mdx:484~484
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As we're about to finsh the implementation in JS, this spec should be moved to candidate.
closes getsentry/sentry-javascript#20940