docs(dataCollection): Clarify URL handling in data collection spec#17911
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
chargome
requested review from
cleptric and
s1gr1d
and removed request for
s1gr1d
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
+149
to
+157
| URL strings in span descriptions follow the format defined in [Structuring Data](/sdk/telemetry/traces/structuring-data/): `METHOD scheme://host/path` — query strings and fragments are excluded. Authority credentials (`userinfo@`) are always replaced with `[Filtered]@`. | ||
|
|
||
| The `queryParams` option controls query parameter filtering wherever query strings appear — including `url.full`, `url.query`, and [`request.query_string`](/sdk/foundations/envelopes/event-payloads/request/). `url.path` and the span description are unaffected since they never contain query strings. For general data scrubbing rules (variable size limits, structuring for server-side scrubbing), see [Data Scrubbing](/sdk/foundations/data-scrubbing/). | ||
|
|
||
| **Example:** Given a request to `https://user:pass@example.com/api/users?token=abc123&page=5`: | ||
|
|
||
| | Attribute | `queryParams` enabled | `queryParams` off | | ||
| |---|---|---| | ||
| | Span description | `GET https://[Filtered]:[Filtered]@example.com/api/users` | same | |
Contributor
There was a problem hiding this comment.
Bug: The documentation for URL credential filtering is inconsistent. The prose description of replacing userinfo@ with [Filtered]@ contradicts the provided examples.
Severity: LOW
Suggested Fix
Update the prose and examples to be consistent. Decide on a single, clear rule for filtering user credentials in URLs and ensure all descriptions and examples in the documentation reflect this rule. For instance, if the intended behavior is to replace the entire userinfo block, the examples should show https://[Filtered]@example.com/....
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#L149-L157
Potential issue: The documentation regarding URL credential filtering is inconsistent.
The prose at line 149 states that `userinfo@` is always replaced with `[Filtered]@`.
However, this is contradicted by the examples. One example for `url.full` shows the
credentials being completely removed from the URL, not replaced. Another example for the
span description shows the username and password being filtered individually, resulting
in `[Filtered]:[Filtered]@`. This ambiguity can lead to incorrect or inconsistent
implementations by SDK developers.
Also affects:
develop-docs/sdk/foundations/client/data-collection/index.mdx:157~158
Did we get this right? 👍 / 👎 to inform future reviews.
s1gr1d
approved these changes
May 29, 2026
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
2 participants
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.
Add a URLs section to the data collection spec clarifying how
queryParamsinteracts with URL attributes.