docs(dotnet): add Data Collected pages #13529
Conversation
Flash0ver
requested review from
aritchie,
bitsandfoxes,
jamescrosswell and
vaind
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 654 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
| ## Request URL | ||
|
|
||
| The full request URL of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data. | ||
|
|
||
| ## Request Query String | ||
|
|
||
| The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data. | ||
|
|
||
| ## Request Body | ||
|
|
||
| The request body of incoming HTTP requests can be sent to Sentry. Whether it's sent or not, depends on the type and size of request body as described below: | ||
|
|
||
| - **The type of the request body:** | ||
| - JSON and form bodies are sent | ||
| - Raw request bodies are always removed | ||
| - Uploaded files in the request bodies are never sent to Sentry | ||
| - **The size of the request body:** There's a ["max_request_body_size"](/platforms/python/configuration/options/#max-request-body-size) option that's set to `medium` by default. This means that larger request bodies aren't sent to Sentry. | ||
|
|
||
| If you want to prevent bodies from being sent to Sentry altogether, set `max_request_body_size` to `"never"`. |
There was a problem hiding this comment.
This is server-side SDK stuff so not related to PowerShell (or .net in general for that matter, only asp.net)
| ## Request URL | |
| The full request URL of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data. | |
| ## Request Query String | |
| The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data. | |
| ## Request Body | |
| The request body of incoming HTTP requests can be sent to Sentry. Whether it's sent or not, depends on the type and size of request body as described below: | |
| - **The type of the request body:** | |
| - JSON and form bodies are sent | |
| - Raw request bodies are always removed | |
| - Uploaded files in the request bodies are never sent to Sentry | |
| - **The size of the request body:** There's a ["max_request_body_size"](/platforms/python/configuration/options/#max-request-body-size) option that's set to `medium` by default. This means that larger request bodies aren't sent to Sentry. | |
| If you want to prevent bodies from being sent to Sentry altogether, set `max_request_body_size` to `"never"`. |
There was a problem hiding this comment.
I've made the Request Body stuff platform specific (ASP.NET and ASP.NET Core only).
I think the Request URL and Query string are relevant for other integrations though, since we capture this information on outbound HTTP requests via the SentryHttpMessageHandler.
That may be a bit of an edge case in Powershell...
| ## SQL Queries | ||
|
|
||
| While SQL queries are sent to Sentry, neither the full SQL query (`UPDATE app_user SET password='supersecret' WHERE id=1;`), nor the values of its parameters will ever be sent. A parameterized version of the query (`UPDATE app_user SET password='%s' WHERE id=%s;`) is sent instead. | ||
|
|
There was a problem hiding this comment.
@vaind I've left this in there for the time being as I think it's relevant for the Sentry.DiagnosticSource and Sentry.EntityFramework integrations.
Here, for example, we record the command query in a span description.
We can also capture this information via our OpenTelemetry integration. I got this from an app that calls out to Postgres, for example:
|
@bitsandfoxes could I get a sanity check on the Unity stuff from you? I'm not very familiar with our Unity SDK (that would be an understatement). |
docs/platforms/dotnet/common/data-management/data-collected.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| The full request query string of outgoing and incoming HTTP requests is **always sent to Sentry**. Depending on your application, this could contain PII data. | ||
|
|
||
| ## Local Variables In Stack Trace |
There was a problem hiding this comment.
PowerShell might have local variables actually, but I don't know.
@vaind does it?
There was a problem hiding this comment.
I've updated the powershell docs so these basically say "see the data collected by the .net skd" now. If there are some minor differences, we can always tweak that to say "except A, B and C as detailed below".
There was a problem hiding this comment.
PowerShell might have local variables actually, but I don't know.
@vaind does it?
Yes but we don't capture them at the moment
|
|
||
| By default, the Sentry SDK doesn't send any information about the logged-in user, such as email address, user ID, or username. Even if enabled, the type of logged-in user information you'll be able to send depends on the integrations you enable in Sentry's SDK. Most integrations won't send any user information. Some will only set the user ID, but there are a few that will set the user ID, username, and email address. | ||
|
|
||
| To start sending logged-in user information, set the option `SendDefaultPii = true` when initializing the Sentry SDK. |
There was a problem hiding this comment.
Not sure Unity adds User if we flip this flag. @bitsandfoxes ?
There was a problem hiding this comment.
It does not. The one place the Unity SDK uses SendDefaultPii for guarding and setting the DeviceUniqueIdentifier here. The rest is in control of the .NET SDK.
bruno-garcia
left a comment
bruno-garcia
left a comment
There was a problem hiding this comment.
since it has one approval, rquesting changes to be clear some changes are needed before we can merge
closes #13416
DESCRIBE YOUR PR
Add "Data Collected" pages for
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES