diff --git a/docs/platforms/dotnet/common/configuration/draining.mdx b/docs/platforms/dotnet/common/configuration/draining.mdx index 18f4f92ac74db..0f9f54a357a23 100644 --- a/docs/platforms/dotnet/common/configuration/draining.mdx +++ b/docs/platforms/dotnet/common/configuration/draining.mdx @@ -11,7 +11,6 @@ notSupported: - unreal --- -The default behavior of most SDKs is to send out events over the network -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. +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. diff --git a/docs/platforms/dotnet/common/configuration/options.mdx b/docs/platforms/dotnet/common/configuration/options.mdx index fe0f6529b27ee..87dac74c98805 100644 --- a/docs/platforms/dotnet/common/configuration/options.mdx +++ b/docs/platforms/dotnet/common/configuration/options.mdx @@ -221,7 +221,7 @@ These options can be used to hook the SDK in various ways to customize the repor -This function is called with an SDK-specific message or error event object, 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. +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. By the time is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect. @@ -231,14 +231,14 @@ When filtering based on exception types, the original exception (including any ` -This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object. +This function is called with a breadcrumb object before the breadcrumb is added to the scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object. 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. -This function is called with an SDK-specific transaction object, and can return a modified transaction object, or `null` to skip reporting the transaction. This can be used, for instance, for manual PII-stripping before sending. +This function is called with a transaction object, and can return a modified transaction object, or `null` to skip reporting the transaction. This can be used, for instance, for manual PII-stripping before sending. By the time is executed, all scope data has already been applied to the event and further modification of the scope won't have any effect. @@ -250,7 +250,7 @@ Transports are used to send events to Sentry. Transports can be customized to so -Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication. +Switches out the transport used to send events. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication. @@ -294,7 +294,7 @@ The default is `1` (one) second. -Controls how many seconds to wait before shutting down. Sentry SDKs send events from a background queue. This queue is given a certain amount to drain pending events. The default is SDK specific but typically around two seconds. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems. +Controls how many seconds to wait before shutting down. The SDK sends events from a background queue. This queue is given a certain amount to drain pending events. Setting this value too low may cause problems for sending events from command line applications. Setting the value too high will cause the application to block for a long time for users experiencing network connectivity problems. diff --git a/docs/platforms/dotnet/common/configuration/sampling.mdx b/docs/platforms/dotnet/common/configuration/sampling.mdx index e714c315cfb2b..77537d5ad742e 100644 --- a/docs/platforms/dotnet/common/configuration/sampling.mdx +++ b/docs/platforms/dotnet/common/configuration/sampling.mdx @@ -58,7 +58,7 @@ By default, none of these options are set, meaning no transactions will be sent ### Default Sampling Context Data -The information contained in the object passed to the when a transaction is created varies by platform and integration. +The information contained in the object passed to the when a transaction is created varies by integration. diff --git a/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx b/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx index f06150b89cbdd..bf094da4aeb28 100644 --- a/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx @@ -19,7 +19,7 @@ These are some great examples for data scrubbing that every company should think We offer the following options depending on your legal and operational needs: -- 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. +- filtering or scrubbing sensitive data within the SDK, so that data is _not sent to_ Sentry. Configuration changes require a redeployment of your application. - [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. - [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. @@ -33,7 +33,7 @@ If you are using Sentry in your mobile app, read our [frequently asked questions ## Personally Identifiable Information (PII) -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). +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). 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). @@ -43,7 +43,7 @@ If you _do not_ wish to use the default PII behavior, you can also choose to ide ### & -SDKs provide a 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 hook which does the same thing for transactions. We recommend using and in the SDKs to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment. +The SDK provides a 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 hook which does the same thing for transactions. We recommend using and in the SDK to **scrub any data before it is sent**, to ensure that sensitive data never leaves the local environment. diff --git a/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx b/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx index 909b014f6d0e8..0fce666395cab 100644 --- a/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/breadcrumbs/index.mdx @@ -29,6 +29,6 @@ Manually record a breadcrumb: SDKs allow you to customize breadcrumbs through the hook. -This hook is passed an already assembled breadcrumb and, in some SDKs, an optional hint. The function can modify the breadcrumb or decide to discard it entirely by returning `null`: +This hook is passed an already assembled breadcrumb and a `hint` object containing extra metadata. The function can modify the breadcrumb or decide to discard it entirely by returning `null`: diff --git a/docs/platforms/dotnet/common/enriching-events/context/index.mdx b/docs/platforms/dotnet/common/enriching-events/context/index.mdx index 3c36bc77e1f8b..1c0cfb9ae2427 100644 --- a/docs/platforms/dotnet/common/enriching-events/context/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/context/index.mdx @@ -29,7 +29,7 @@ Learn more about conventions for common contexts in the [contexts interface deve 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. -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/). +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/). ## Additional Data diff --git a/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx b/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx index 242b1077788c4..35b2a863cfd53 100644 --- a/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx @@ -28,11 +28,9 @@ An alternative, or addition, to the username. Sentry is aware of email addresses ### `ip_address` The user's IP address. If the user is unauthenticated, Sentry uses the IP address as a unique identifier for the user. -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 set to `true` in the SDK options. +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 set to `true` in the SDK options. -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`. 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. +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`. 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. diff --git a/docs/platforms/dotnet/common/enriching-events/scopes/index.mdx b/docs/platforms/dotnet/common/enriching-events/scopes/index.mdx index c70db4f1f633c..d31cfee3eeae1 100644 --- a/docs/platforms/dotnet/common/enriching-events/scopes/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/scopes/index.mdx @@ -1,11 +1,10 @@ --- title: Scopes and Hubs -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." +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." --- When an event is captured and sent to Sentry, SDKs will merge that event data with extra -information from the current scope. SDKs will typically automatically manage the scopes -for you in the framework integrations and you don't need to think about them. However, +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, you should know what a scope is and how you can use it for your advantage. ## What's a Scope, What's a Hub diff --git a/docs/platforms/dotnet/common/tracing/instrumentation/performance-metrics.mdx b/docs/platforms/dotnet/common/tracing/instrumentation/performance-metrics.mdx index 7115f88f18c31..8955adc964609 100644 --- a/docs/platforms/dotnet/common/tracing/instrumentation/performance-metrics.mdx +++ b/docs/platforms/dotnet/common/tracing/instrumentation/performance-metrics.mdx @@ -4,7 +4,7 @@ description: "Learn how to attach performance metrics to your transactions." sidebar_order: 20 --- -Sentry's SDKs support sending performance metrics data to Sentry. These are numeric values attached to transactions that are aggregated and displayed in Sentry. +The SDK supports sending performance metrics data to Sentry. These are numeric values attached to transactions that are aggregated and displayed in Sentry. ## Custom Measurements diff --git a/docs/platforms/dotnet/common/usage/sdk-fingerprinting/index.mdx b/docs/platforms/dotnet/common/usage/sdk-fingerprinting/index.mdx index 9bc4a4d4b772c..a7b2e0dbca5cf 100644 --- a/docs/platforms/dotnet/common/usage/sdk-fingerprinting/index.mdx +++ b/docs/platforms/dotnet/common/usage/sdk-fingerprinting/index.mdx @@ -11,7 +11,7 @@ By default, Sentry will run one of our built-in grouping algorithms to generate 1. In your SDK, using SDK Fingerprinting, as documented below 2. In your project, using [Fingerprint Rules](/concepts/data-management/event-grouping/fingerprint-rules/) or [Stack Trace Rules](/concepts/data-management/event-grouping/stack-trace-rules/) -In supported SDKs, you can override Sentry's default grouping that passes the fingerprint attribute as an array of strings. The length of a fingerprint's array is not restricted. This works similarly to the [fingerprint rules functionality](/concepts/data-management/event-grouping/fingerprint-rules/), which is always available and can achieve similar results. +You can override Sentry's default grouping that passes the fingerprint attribute as an array of strings. The length of a fingerprint's array is not restricted. This works similarly to the [fingerprint rules functionality](/concepts/data-management/event-grouping/fingerprint-rules/), which can achieve similar results. ## Basic Example