docs(sdk): Add queue arguments configuration to data collection spec#18637
Open
ericapisani wants to merge 2 commits into
Open
docs(sdk): Add queue arguments configuration to data collection spec#18637ericapisani wants to merge 2 commits into
ericapisani wants to merge 2 commits into
Conversation
Document the `queues.taskArguments` option for controlling collection of arguments passed to tasks within queues. Bump spec_version to 0.7.0 and update the changelog accordingly.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
ericapisani
commented
Jul 3, 2026
| queryParams?: boolean // default: true | ||
| }, | ||
| queues?: { | ||
| taskArguments?: boolean // default: true |
Member
Author
There was a problem hiding this comment.
Putting this in a dict may be overkill - can we foresee any other data collection controls we may want to add in the context of queues? If it's just task arguments I can update this to just be a boolean
| | `graphql` | `{ document?, variables? }` | Both `true` | 0.5.0 | For `document`: Collect the GraphQL document. <br /><br /> For `variables`: Collect the variables that are passed to GraphQL operations. | | ||
| | `genAI` | `{ inputs?, outputs? }` | Both `true` | 0.1.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. | | ||
| | `database` | `{ queryParams? }` | `true` | 0.6.0 | Include parameters/arguments passed to database queries. Setting this to false will either omit the value altogether, or replace the value with '[Filtered]'. | | ||
| | `queues` | `{ taskArguments? }` | `true` | 0.7.0 | Include arguments passed to tasks within queues. Setting this to false will replace the value with '[Filtered]'. | |
Contributor
There was a problem hiding this comment.
Bug: The documentation for queues.taskArguments describes a different behavior for disabling data collection compared to the similar database.queryParams option, which could lead to inconsistent SDK implementations.
Severity: MEDIUM
Suggested Fix
Align the behavior description for queues.taskArguments with database.queryParams. Either allow both omitting the value and replacing it with '[Filtered]', or explicitly justify in the documentation why the behavior for queues is intentionally more restrictive.
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#L569
Potential issue: The documentation for the new `queues.taskArguments` option states that
setting it to `false` will "replace the value with '[Filtered]'", which is inconsistent
with the existing `database.queryParams` option. The description for
`database.queryParams` says that setting it to `false` will "either omit the value
altogether, or replace the value with '[Filtered]'”. This inconsistency in the
specification for similar features risks different implementations across SDKs, leading
to a confusing and inconsistent experience for developers using different Sentry SDKs.
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.
Adds documentation for the
queues.taskArgumentsconfiguration option, which controls whether arguments passed to tasks within queues are collected. Bumps the data collection spec to version 0.7.0.queues.taskArgumentsoption to client options table and init snippetsspec_versionto 0.7.0 with changelog entryFixes PY-2577
Fixes getsentry/sentry-python#6737