Skip to content

docs(sdk): Add queue arguments configuration to data collection spec#18637

Merged
ericapisani merged 10 commits into
masterfrom
py-2577-queue-args-datacollection
Jul 8, 2026
Merged

docs(sdk): Add queue arguments configuration to data collection spec#18637
ericapisani merged 10 commits into
masterfrom
py-2577-queue-args-datacollection

Conversation

@ericapisani

@ericapisani ericapisani commented Jul 3, 2026

Copy link
Copy Markdown
Member

Adds documentation for the queues.taskArguments configuration option, which controls whether arguments passed to tasks within queues are collected. Bumps the data collection spec to version 0.7.0.

  • Add queues.taskArguments option to client options table and init snippets
  • Note task queue arguments as a PII-adjacent data type
  • Bump spec_version to 0.7.0 with changelog entry

Some other small adjustments:

  • Updates to the database configuration to also be a boolean value
  • Change the name of the graphql property to graphQL

Fixes PY-2577
Fixes getsentry/sentry-python#6737

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.
@linear-code

linear-code Bot commented Jul 3, 2026

Copy link
Copy Markdown

PY-2577

@vercel

vercel Bot commented Jul 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Jul 8, 2026 3:55pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview Jul 8, 2026 3:55pm

Request Review

@github-actions github-actions Bot added the sdk-develop-docs PRs touching develop-docs/sdk label Jul 3, 2026
@ericapisani ericapisani marked this pull request as ready for review July 3, 2026 13:45
Comment thread develop-docs/sdk/foundations/client/data-collection/index.mdx Outdated
Comment thread develop-docs/sdk/foundations/client/data-collection/index.mdx Outdated
@ericapisani ericapisani requested a review from cleptric July 3, 2026 13:49
Comment thread develop-docs/sdk/foundations/client/data-collection/index.mdx Outdated
Comment thread develop-docs/sdk/foundations/client/data-collection/index.mdx
Comment thread develop-docs/sdk/foundations/client/data-collection/index.mdx Outdated
Comment thread develop-docs/sdk/foundations/client/data-collection/index.mdx Outdated
Comment thread develop-docs/sdk/foundations/client/data-collection/index.mdx Outdated
| `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` | Boolean | `true` | 0.6.0 | Include parameters/arguments passed to database queries, or the results of a query. |
| `databaseQueryData` | Boolean | `true` | 0.6.0 | Include data that's associated with database queries (inputs and outputs). |

@s1gr1d s1gr1d Jul 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This might be a bit too vague.

Maybe something like this: "Include the data a database operation reads and writes (e.g. query text/statement values, bind parameters, operation payloads and returned results). Structural metadata is always collected (e.g. query summary, operation, table, system)."

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I can update this to give some more concrete examples, but I'm trying to stay away from writing "query text" because this would likely cause some confusion given db.query.textis not gated by the PII flag and where we store the query text today.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Have added concrete examples in 1c112b2

ericapisani added a commit to getsentry/sentry-python that referenced this pull request Jul 8, 2026
…6770)

Add a `queues` boolean to the data collection spec, gated by
send_default_pii like other PII-bearing fields.

Depends on getsentry/sentry-docs#18637 and the
outcome of discussions there.

Fixes PY-2679
Fixes #6739

---

<sub>Stack created with <a
href="https://github.com/github/gh-stack">GitHub Stacks CLI</a> • <a
href="https://gh.io/stacks-feedback">Give Feedback 💬</a></sub>
ericapisani added a commit to getsentry/sentry-python that referenced this pull request Jul 8, 2026
@ericapisani ericapisani merged commit f3c5078 into master Jul 8, 2026
24 checks passed
@ericapisani ericapisani deleted the py-2577-queue-args-datacollection branch July 8, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

sdk-develop-docs PRs touching develop-docs/sdk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update data collection spec to support queue args

3 participants