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: docs/platforms/rust/common/configuration/draining.mdx
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@ sidebar_order: 70
4
4
description: "Learn more about the default behavior of our SDK if the application shuts down unexpectedly."
5
5
---
6
6
7
-
The default behavior of most SDKs is to send out events over the network
8
-
asynchronously in the background. This means that some events might be lost if the application shuts down unexpectedly. The SDKs provide mechanisms to cope with this.
7
+
By default the SDK sends out events over the network on a background thread. This means that some events might be lost if the application shuts down unexpectedly. The SDK provides mechanisms to cope with this.
Copy file name to clipboardExpand all lines: docs/platforms/rust/common/configuration/filtering.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Event and breadcrumb `hints` are objects containing various information used to
33
33
34
34
For events, hints contain properties such as `event_id`, `originalException`, `syntheticException` (used internally to generate cleaner stack trace), and any other arbitrary `data` that you attach.
35
35
36
-
For breadcrumbs, the use of `hints`is implementation dependent. For XHR requests, the hint contains the xhr object itself; for user interactions the hint contains the DOM element and event name and so forth.
36
+
For breadcrumbs, the use of `hints`depends on the type of breadcrumb.
Copy file name to clipboardExpand all lines: docs/platforms/rust/common/configuration/options.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
@@ -85,7 +85,7 @@ This option can be overridden using `in_app_include`.
85
85
86
86
<SdkOptionname="before_breadcrumb"type='Fn'>
87
87
88
-
This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When `None` is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object.
88
+
This function is called with a breadcrumb object before the breadcrumb is added to the scope. When `None` is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object.
89
89
The callback typically gets a second argument (called a "hint"), which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like.
90
90
91
91
</SdkOption>
@@ -107,7 +107,7 @@ The default value of `MaxRequestBodySize::Medium` will capture request bodies up
107
107
108
108
<SdkOptionname="before_send"type='Fn'>
109
109
110
-
This function is called with an SDK-specific message or error event object, and can return a modified event object, or `None` to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.
110
+
This function is called with the event payload, and can return a modified event object, or `null` to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.
111
111
112
112
By the time `before_send` is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.
Copy file name to clipboardExpand all lines: docs/platforms/rust/common/data-management/sensitive-data/index.mdx
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,21 +19,19 @@ These are some great examples for data scrubbing that every company should think
19
19
20
20
We offer the following options depending on your legal and operational needs:
21
21
22
-
- filtering or scrubbing sensitive data within the SDK, so that data is _not sent to_ Sentry. Different SDKs have different capabilities, and configuration changes require a redeployment of your application.
22
+
- filtering or scrubbing sensitive data within the SDK, so that data is _not sent to_ Sentry. Configuration changes require a redeployment of your application.
23
23
-[configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events.
24
24
-[running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying.
25
25
26
26
<Alert>
27
27
28
28
Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review.
29
29
30
-
If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details.
31
-
32
30
</Alert>
33
31
34
32
## Personally Identifiable Information (PII)
35
33
36
-
Our newer SDKs do not purposefully send PII to stay on the safe side. This behavior is controlled by an option called [`send-default-pii`](../../configuration/options/#send-default-pii).
34
+
The SDK purposefully does not send PII to stay on the safe side. This behavior is controlled by an option called [`send-default-pii`](../../configuration/options/#send-default-pii).
37
35
38
36
Turning this option on is required for certain features in Sentry to work, but also means you will need to be even more careful about what data is being sent to Sentry (using the options below).
39
37
@@ -43,7 +41,7 @@ If you _do not_ wish to use the default PII behavior, you can also choose to ide
SDKs provide a <PlatformIdentifiername="before-send" /> hook, which is invoked before an error or message event is sent and can be used to modify event data to remove sensitive information. Some SDKs also provide a <PlatformIdentifiername="before-send-transaction" /> hook which does the same thing for transactions. We recommend using <PlatformIdentifiername="before-send" /> and <PlatformIdentifiername="before-send-transaction" /> in the SDKs to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment.
44
+
The SDK provides a <PlatformIdentifiername="before-send" /> hook, which is invoked before an error or message event is sent and can be used to modify event data to remove sensitive information. The SDK also provide a <PlatformIdentifiername="before-send-transaction" /> hook which does the same thing for transactions. We recommend using <PlatformIdentifiername="before-send" /> and <PlatformIdentifiername="before-send-transaction" /> in the SDK to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment.
Copy file name to clipboardExpand all lines: docs/platforms/rust/common/enriching-events/context/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ Learn more about conventions for common contexts in the [contexts interface deve
29
29
30
30
When sending context, _consider payload size limits_. Sentry does not recommend sending the entire application state and large data blobs in contexts. If you exceed the maximum payload size, Sentry will respond with HTTP error `413 Payload Too Large` and reject the event.
31
31
32
-
The Sentry SDK will try its best to accommodate the data you send and trim large context payloads. Some SDKs can truncate parts of the event; for more details, see the [developer documentation on SDK data handling](https://develop.sentry.dev/sdk/expected-features/data-handling/).
32
+
The Sentry SDK will try its best to accommodate the data you send and trim large context payloads. The SDK can truncate parts of the event; for more details, see the [developer documentation on SDK data handling](https://develop.sentry.dev/sdk/expected-features/data-handling/).
Copy file name to clipboardExpand all lines: docs/platforms/rust/common/enriching-events/identify-user/index.mdx
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,9 @@ An alternative, or addition, to the username. Sentry is aware of email addresses
22
22
### `ip_address`
23
23
24
24
The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user.
25
-
Serverside SDKs that instrument incoming requests will attempt to pull the IP address from the HTTP request data (`request.env.REMOTE_ADDR` field in JSON), if available. That might require <PlatformIdentifiername="send-default-pii" /> set to `true` in the SDK options.
25
+
The SDK will attempt to pull the IP address from the HTTP request data on incoming requests (`request.env.REMOTE_ADDR` field in JSON), if available. That requires <PlatformIdentifiername="send-default-pii" /> set to `true` in the SDK options.
26
26
27
-
If the user's `ip_address` is set to `"{{auto}}"`, Sentry will infer the IP address from the connection between your app and Sentry's server.
28
-
29
-
If the field is omitted, the default value is `null`. However, due to backwards compatibility concerns, certain platforms (in particular JavaScript) have a different default value for `"{{auto}}"`. SDKs and other clients should not rely on this behavior and should set IP addresses or `"{{auto}}"` explicitly.
27
+
If the user's `ip_address` is set to `"{{auto}}"`, Sentry will infer the IP address from the connection between your app and Sentry's server. If the field is omitted, the default value is `null`.
30
28
31
29
To opt out of storing users' IP addresses in your event data, you can go to your project settings, click on "Security & Privacy", and enable "Prevent Storing of IP Addresses" or use Sentry's [server-side data](/security-legal-pii/scrubbing/) scrubbing to remove `$user.ip_address`. Adding such a rule ultimately overrules any other logic.
Copy file name to clipboardExpand all lines: docs/platforms/rust/common/enriching-events/scopes/index.mdx
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,10 @@
1
1
---
2
2
title: Scopes and Hubs
3
-
description: "SDKs will typically automatically manage the scopes for you in the framework integrations. Learn what a scope is and how you can use it to your advantage."
3
+
description: "The SDK will in most cases automatically manage the scopes for you in the framework integrations. Learn what a scope is and how you can use it to your advantage."
4
4
---
5
5
6
6
When an event is captured and sent to Sentry, SDKs will merge that event data with extra
7
-
information from the current scope. SDKs will typically automatically manage the scopes
8
-
for you in the framework integrations and you don't need to think about them. However,
7
+
information from the current scope. The SDK will in most cases automatically manage the scopes for you in the framework integrations and you don't need to think about them. However,
9
8
you should know what a scope is and how you can use it for your advantage.
0 commit comments