You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: develop-docs/sdk/foundations/client/data-collection/index.mdx
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,6 +144,22 @@ init({
144
144
})
145
145
```
146
146
147
+
#### URLs
148
+
149
+
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.
150
+
151
+
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/).
152
+
153
+
**Example:** Given a request to `https://example.com/api/users?token=abc123&page=5`:
154
+
155
+
| Attribute |`queryParams` enabled |`queryParams` off |
156
+
|---|---|---|
157
+
| Span description |`GET https://example.com/api/users`| same |
|`url.query`|`token=[Filtered]&page=5`| not collected |
161
+
|`request.query_string`|`token=[Filtered]&page=5`| not collected |
162
+
147
163
#### Cookies and Query Params
148
164
149
165
Cookies and query params may arrive as a single unparsed string (e.g., `Cookie: user_session=abc; theme=dark-mode`) rather than pre-split key-value pairs. SDKs **MAY** handle both cases:
Copy file name to clipboardExpand all lines: develop-docs/sdk/foundations/data-scrubbing.mdx
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ The normative rules for sensitive data, PII, cookies, request bodies, and user-s
18
18
- SDKs should not include PII or other sensitive data in the payload by default. The legacy option [_send-default-pii_](https://docs.sentry.io/platforms/python/configuration/options/#send-default-pii) is **disabled by default**; the replacement is `dataCollection.includeUserInfo` and `dataCollection.collect` (see [Data Collection](/sdk/foundations/client/data-collection/)).
19
19
- Certain sensitive data must never be sent through SDK instrumentation: header/cookie/query values matching the default denylist are replaced with `"[Filtered]"`. User-set data is always attached; only automatically gathered data is scrubbed. Users can use `beforeSend` / event processors to remove or redact any data.
20
20
- For the exact default denylist (partial, case-insensitive match), PII denylist (`x-forwarded-`, `-user`), cookies when unparsable, and raw request bodies, see [Data Collection — Default Denylist](/sdk/foundations/client/data-collection/#default-denylist) and [User-Set Data and Scrubbing](/sdk/foundations/client/data-collection/#user-set-data-scrubbing).
21
+
- For how `queryParams` filtering applies to URL attributes, see [Data Collection — URLs](/sdk/foundations/client/data-collection/#urls).
When an upload is marked as selective, Sentry only diffs the snapshots you uploaded. Any snapshot that exists in the base build but was not included in the upload is treated as unchanged (skipped) rather than removed.
62
-
63
-
### Detecting Removals and Renames in Selective Mode
64
-
65
-
By default, `--selective` cannot detect removals or renames because Sentry cannot distinguish a deliberately deleted snapshot from one that was not part of the subset. To enable removal and rename detection, pass the full list of image file names from your test suite using one of:
66
-
67
-
-`--all-image-file-names <NAMES>` — a comma-separated list of all image file names.
68
-
-`--all-image-file-names-file <PATH>` — a path to a file (`.txt`, `.csv`, etc.) containing all image file names, one per line.
69
-
-`--all-image-file-names-as-regex <PATTERNS>` — a comma-separated list of regex patterns matching all image file names.
70
-
-`--all-image-file-names-as-regex-file <PATH>` — a path to a file containing regex patterns, one per line.
71
-
72
-
<Alertlevel="warning">
73
-
These four flags are mutually exclusive — you can only use one per upload.
With the image names or patterns provided, Sentry can tell apart three categories of missing images:
91
-
92
-
-**Skipped** — matched by the list/pattern but not uploaded (part of the test suite, just not run in this CI job).
93
-
-**Removed** — not matched and not uploaded (deliberately deleted from the test suite).
94
-
-**Renamed** — a new image has the same content hash as a missing one.
61
+
When an upload is marked as selective, Sentry only diffs the snapshots you uploaded. Any snapshot that exists in the base build but was not included in the upload is treated as unchanged rather than removed. Removals and renames cannot be detected when using `--selective`, because Sentry cannot distinguish a deliberately deleted snapshot from one that was not part of the subset.
|`--auth-token <TOKEN>`| Sentry auth token. Can also be set via `SENTRY_AUTH_TOKEN`. |
117
84
|`-o`, `--org <ORG>`| Sentry organization slug. Can also be set via `SENTRY_ORG`. |
118
85
|`-p`, `--project <PROJECT>`| Sentry project slug. Can also be set via `SENTRY_PROJECT`. |
119
-
|`--selective`| Mark the upload as a subset. Use when uploading only a portion of your snapshots (for example, affected tests only). |
120
-
|`--all-image-file-names <NAMES>`| Comma-separated list of all image file names in the full test suite. Enables removal and rename detection in selective mode. Implicitly enables `--selective`. Mutually exclusive with the other `--all-image-*` flags. |
121
-
|`--all-image-file-names-file <PATH>`| Path to a file (`.txt`, `.csv`, etc.) containing all image file names, one per line. Enables removal and rename detection in selective mode. Implicitly enables `--selective`. Mutually exclusive with the other `--all-image-*` flags. |
122
-
|`--all-image-file-names-as-regex <PATTERNS>`| Comma-separated list of regex patterns matching all image file names in the full test suite. Enables removal and rename detection in selective mode. Implicitly enables `--selective`. Mutually exclusive with the other `--all-image-*` flags. |
123
-
|`--all-image-file-names-as-regex-file <PATH>`| Path to a file containing regex patterns matching all image file names, one per line. Enables removal and rename detection in selective mode. Implicitly enables `--selective`. Mutually exclusive with the other `--all-image-*` flags. |
124
-
|`--diff-threshold <THRESHOLD>`| Float between `0.0` and `1.0`. Sentry only reports images as changed if the percentage of changed pixels exceeds this value. |
86
+
|`--selective`| Mark the upload as a subset. Use when uploading only a portion of your snapshots (for example, affected tests only). |
87
+
|`--diff-threshold <THRESHOLD>`| Float between `0.0` and `1.0`. Sentry only reports images as changed if the percentage of changed pixels exceeds this value. |
125
88
|`--head-sha <SHA>`| Commit SHA for the upload. Auto-detected in CI. |
126
89
|`--base-sha <SHA>`| Base commit SHA for comparison (PR only). Auto-detected from merge-base. |
127
90
|`--vcs-provider <PROVIDER>`| VCS provider (for example, `github`). Auto-detected from the git remote. |
Copy file name to clipboardExpand all lines: docs/contributing/approach/sdk-docs/write-quick-start.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ sidebar_order: 25
6
6
7
7
New SDKs should use the Quick Start guide format outlined on this page. You may still encounter Getting Started guides for existing SDKs.
8
8
9
-
<Alerttype="info"title="Note">
9
+
<Alertlevel="info"title="Note">
10
10
If you want to update an existing Getting Started Guide without refactoring it
11
11
into a Quick Start guide, see [How to Write - Getting
12
12
Started](/contributing/approach/sdk-docs/write-getting-started/). If you're
@@ -133,7 +133,7 @@ If the content you want to include doesn't already exist, create a new file for
133
133
134
134
Integrate this content into your guide using the `PlatformSection` component.
135
135
136
-
<Alert type="info">
136
+
<Alert level="info">
137
137
If the SDK supports performance monitoring, add it to the list that links back
138
138
into the SDK content from Product, stored in
139
139
[`/docs/product/dashboards/sentry-dashboards/index.mdx`](https://github.com/getsentry/sentry-docs/blob/master/docs/product/dashboards/sentry-dashboards/index.mdx) (Sentry Dashboards index, which includes a Set Up section and platform redirect to tracing).
To automate stripping in your project after building, add a Run Script phase that skips non-release builds and leaves Apple-signed frameworks untouched:
52
52
53
-
<Alerttype="warning">
53
+
<Alertlevel="warning">
54
54
This script will strip the main app binary along with any binaries in the
55
55
`Frameworks/` directory. This is a sample script that **may require
56
56
adjustments** for your project.
@@ -304,7 +304,7 @@ Xcode now limits the export trie to just that allowlist.
304
304
305
305
**How to fix**: Enable [Source maps](https://reactnative.dev/docs/debugging-release-builds) when building your release app.
306
306
307
-
<Alerttype="warning">
307
+
<Alertlevel="warning">
308
308
Stripping debug information breaks crash symbolication. Source maps need to be
0 commit comments