Skip to content

[skill-drift] update(sentry-react-sdk): document urlQueryParams rename and new graphQL/databaseQueryData options#293

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
skill-drift/react-skill-drift-update-sentry-react-sdk-docu-1784554127
Open

[skill-drift] update(sentry-react-sdk): document urlQueryParams rename and new graphQL/databaseQueryData options#293
github-actions[bot] wants to merge 1 commit into
mainfrom
skill-drift/react-skill-drift-update-sentry-react-sdk-docu-1784554127

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Warning

Auto-generated from external SDK content. Review all links and code suggestions before acting on them.

What changed upstream

@sentry/react (via @sentry/core) shipped three related changes to the dataCollection init option, now released in 10.66.0/10.67.0:

  • queryParams renamed to urlQueryParams (#22217, released 10.67.0). queryParams still works but is now marked @deprecated in favor of the new name; same shape (boolean | { allow: string[] } | { deny: string[] }) and default (true).
  • New dataCollection.graphQL option (#22221, released 10.66.0) — { document?: boolean; variables?: boolean }, both default true. Controls whether the GraphQL document text and operation variables are attached when a GraphQL integration is enabled. Does not add instrumentation on its own.
  • New dataCollection.databaseQueryData option (#22219, released 10.66.0) — boolean, default true. Controls collection of DB query parameters, inline literal values, mutation/request bodies, and returned result data (e.g. for Supabase). Sanitized db.query.text and structural metadata are always collected regardless of this flag.

What was out of date

src/references/sdks/react/index.md's dataCollection Options table still listed only the deprecated queryParams field and had no rows for graphQL.document, graphQL.variables, or databaseQueryData.

Fix

Updated the table in src/references/sdks/react/index.md:

  • Replaced the queryParams row with urlQueryParams (noting the deprecation and version) and added a deprecation callout below the table.
  • Added graphQL.document, graphQL.variables, and databaseQueryData rows with their defaults and minimum SDK version.

No other file in the react reference tree mentions queryParams/urlQueryParams/graphQL/databaseQueryData, so no other edits were needed.

Other PRs reviewed but not actioned

  • #22225 fix(react): Preserve parent path prefix for descendant route names in react-router — internal bug fix, no public-surface change to document.
  • #22356 ref: Use base keys from conventions for dynamic suffix attribute keys (touches packages/react/src/tanstackrouter.ts) — internal attribute-key refactor, no user-facing config/API change.
  • #22246 fix(browser): Propagate trace data from active span if http.client span is non-recording — bug fix, no reference update needed.

Note: @sentry/browser's own reference tree (src/references/sdks/browser/) has the same queryParams/urlQueryParams drift and will need the analogous fix in that SDK's own drift-detection run.

Source PRs

…e and new graphQL/databaseQueryData options

Automated drift-fix run.

Co-Authored-By: Claude (claude-sonnet-5) <noreply@anthropic.com>
@@ -359,13 +359,18 @@ Fine-grained control over what data the SDK collects. Replaces the simple `sendD
| `cookies` | `boolean \| { allow: string[] } \| { deny: string[] }` | `true` | Cookie collection and filtering; `true` = all cookies (sensitive keys filtered) |
| `httpHeaders.request` | `boolean \| { allow: string[] } \| { deny: string[] }` | `true` | HTTP request header collection |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: Documentation for dataCollection options was updated for the React SDK but not for other affected JavaScript SDKs, creating an inconsistency.
Severity: LOW

Suggested Fix

Update the dataCollection documentation in all relevant JavaScript SDK files (e.g., browser/index.md, node/index.md, svelte/index.md) to replace queryParams with urlQueryParams and add the new graphQL and databaseQueryData options, mirroring the changes made to the React SDK documentation.

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: src/references/sdks/react/index.md#L360

Potential issue: The pull request updates the documentation for the React SDK to reflect
a change from `queryParams` to `urlQueryParams` and adds new `graphQL` and
`databaseQueryData` options. This change originates in `@sentry/core`, which suggests it
should apply to all JavaScript SDKs. However, the documentation for other SDKs, such as
Browser, Node, Svelte, NestJS, NextJS, and TanStack Start, was not updated. This creates
an inconsistency where developers using other SDKs are shown outdated and incorrect
configuration options, potentially leading to confusion and misconfiguration.

Also affects:

  • src/references/sdks/svelte/index.md
  • src/references/sdks/browser/index.md
  • src/references/sdks/node/index.md
  • src/references/sdks/nestjs/index.md
  • src/references/sdks/tanstack-start/index.md
  • src/references/sdks/nextjs/index.md

Did we get this right? 👍 / 👎 to inform future reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants