-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat: Add Apple Data Collected Page #12754
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a937d52
feat: Add Apple Data Collected Page
philipphofmann 1f19f21
fix links
philipphofmann 439c955
Update docs/platforms/apple/common/data-management/data-collected.mdx
philipphofmann 602dfbb
Update docs/platforms/apple/common/data-management/data-collected.mdx
philipphofmann a2ea3f2
again try to fix links
philipphofmann 38dcf6f
more fixes
philipphofmann c365ae2
platform links
philipphofmann File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
docs/platforms/apple/common/data-management/data-collected.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| title: Data Collected | ||
| description: "See what data is collected by the Sentry SDK." | ||
| sidebar_order: 1 | ||
| --- | ||
|
|
||
| Sentry takes data privacy very seriously and has default settings in place that prioritize data safety, especially when it comes to personally identifiable information (PII) data. When you add the Sentry SDK to your application, you allow it to collect data and send it to Sentry during the runtime of your application. | ||
|
|
||
| The category types and amount of data collected vary, depending on the integrations you've enabled in the Sentry SDK. This page lists data categories that the Apple SDK collects. | ||
|
|
||
| ## HTTP Headers | ||
|
|
||
| The <PlatformLink to="/configuration/http-client-errors">HTTP Client Errors</PlatformLink>, which are enabled by default, send the HTTP headers of the failed request and response to Sentry. The SDK uses a [denylist](https://github.com/getsentry/sentry-cocoa/blob/main/Sources/Swift/Tools/HTTPHeaderSanitizer.swift) to filter out any headers that contain sensitive data. | ||
|
|
||
|
|
||
| ## Request URL | ||
|
|
||
| When the Apple SDK sends URLs to Sentry it always sends a sanitized URL which means it removes the query string and the fragment of the URL. Although the Apple SDK sanitizes the URL by removing the query string and the fragment of the URL, depending on your application, this could contain PII data. | ||
|
|
||
| Network breadcrumbs and HTTP Client Errors, both enabled by default, send a sanitized URL for outgoing HTTP requests. You can disable network breadcrumbs by setting the option `enableNetworkBreadcrumbs` to `false` and you can disable HTTP Client Errors by setting the option `enableCaptureFailedRequests` to `false`. | ||
|
|
||
| When you enable <PlatformLink to="/tracing">tracing</PlatformLink>, which is disabled per default, <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#network-tracking"> network tracing</PlatformLink> sends a sanitized URL for outgoing HTTP requests. | ||
|
|
||
| ## Source Context | ||
|
|
||
| You can upload your source code to Sentry, which can then used to show the lines of code where an error happened in the Issue Details page, via the <PlatformLink to="/sourcecontext/#1-manually-upload-with-the-sentry-cli">sentry-cli</PlatformLink> or the <PlatformLink to="/sourcecontext/#2-fastlane-plugin">Sentry Fastlane plugin</PlatformLink>. | ||
|
|
||
| To opt into sending this source context to Sentry, you have to enable the feature as described in <PlatformLink to="/sourcecontext/">the Source Context documentation</PlatformLink>. | ||
|
|
||
| ## File I/O | ||
|
|
||
| When you enable tracing, which is disabled per default, the Apple SDK <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#file-io-tracing">instruments file I/O operations</PlatformLink> and sends the file names and paths to Sentry. | ||
|
|
||
| ## Core Data Queries | ||
|
|
||
| When you enable <PlatformLink to="/tracing">tracing</PlatformLink>, which is disabled per default, the Apple SDK <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#core-data-tracing">instruments Core Data queries</PlatformLink> and sends the Core Data queries to Sentry. Neither the full SQL query (`SELECT 'User' WHERE name == 'username'`), nor the values of its parameters will ever be sent. A parameterized version of the query (`SELECT 'User' WHERE name == %@`) is sent instead. | ||
|
|
||
| <PlatformSection supported={["apple.ios", "apple.visionos"]}> | ||
|
|
||
| ## Screenshots | ||
|
|
||
| The <PlatformLink to="/enriching-events/screenshots">screenshot feature</PlatformLink> is disabled per default, but when enabled the screenshots may contain PII data. | ||
|
|
||
| ## View Hierarchy | ||
|
|
||
| The <PlatformLink to="/enriching-events/viewhierarchy">view hierarchy feature</PlatformLink> is disabled per default, but when enabled the view hierarchy may contain PII data when using the `accessibilityIdentifier` property with personal information. | ||
philipphofmann marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| </PlatformSection> | ||
|
|
||
| <PlatformSection supported={["apple.ios"]}> | ||
|
|
||
| ## Session Replay | ||
|
|
||
| By default, our Session Replay SDK masks all text content, images, webviews, and user input. This helps ensure that no sensitive data is exposed. You can find <PlatformLink to="/session-replay/#privacy">more details in the Session Replay documentation</PlatformLink>. | ||
|
|
||
| </PlatformSection> | ||
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.
Uh oh!
There was an error while loading. Please reload this page.