From e898e476fb8b0aa4546f1ffb718b4be22cca678b Mon Sep 17 00:00:00 2001 From: Shannon Anahata Date: Wed, 15 Oct 2025 12:58:57 -0700 Subject: [PATCH 1/4] Fixed all the broken links to options since the platform casing is now the anchor format for hyperlinks --- docs/platforms/android/data-management/data-collected.mdx | 6 +++--- .../android/data-management/sensitive-data/index.mdx | 2 +- .../android/integrations/jetpack-compose/index.mdx | 2 +- docs/platforms/android/integrations/navigation/index.mdx | 2 +- .../tracing/instrumentation/automatic-instrumentation.mdx | 2 +- .../platforms/android/tracing/trace-propagation/index.mdx | 2 +- docs/platforms/android/troubleshooting/index.mdx | 2 +- docs/platforms/android/user-feedback/index.mdx | 2 +- .../dart/common/data-management/data-collected.mdx | 6 +++--- .../guides/flutter/data-management/data-collected.mdx | 6 +++--- .../dotnet/common/data-management/data-collected.mdx | 2 +- .../common/data-management/sensitive-data/index.mdx | 2 +- docs/platforms/java/common/configuration/index.mdx | 2 +- docs/platforms/java/common/configuration/options.mdx | 2 +- docs/platforms/java/common/configuration/sampling.mdx | 2 +- .../java/common/data-management/data-collected.mdx | 8 ++++---- .../java/common/data-management/sensitive-data/index.mdx | 2 +- docs/platforms/java/common/migration/5.x-to-6.0.mdx | 2 +- .../java/common/tracing/trace-propagation/index.mdx | 2 +- docs/platforms/java/common/user-feedback/index.mdx | 2 +- .../powershell/data-management/sensitive-data/index.mdx | 2 +- .../react-native/data-management/data-collected.mdx | 4 ++-- .../unity/enriching-events/attachments/index.mdx | 2 +- docs/platforms/unity/index.mdx | 2 +- docs/platforms/unreal/data-management/data-collected.mdx | 2 +- 25 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/platforms/android/data-management/data-collected.mdx b/docs/platforms/android/data-management/data-collected.mdx index b11d9d0d6a043..779b16eb141e7 100644 --- a/docs/platforms/android/data-management/data-collected.mdx +++ b/docs/platforms/android/data-management/data-collected.mdx @@ -8,13 +8,13 @@ Sentry takes data privacy very seriously and has default settings in place that 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 Sentry Android SDK collects. -Many of the categories listed here require you to enable the sendDefaultPii option. +Many of the categories listed here require you to enable the sendDefaultPii option. ## HTTP Headers By default, the Sentry SDK doesn't send any headers for outgoing HTTP request. Even when sending HTTP headers is enabled, we have a [denylist](https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/util/HttpUtils.java#L21-L34) in place, which filters out any headers that contain sensitive data. -To start sending HTTP headers, set `sendDefaultPii=true`. +To start sending HTTP headers, set `sendDefaultPii=true`. ## Cookies @@ -48,7 +48,7 @@ The request body of incoming HTTP requests can be sent to Sentry. Whether it's s - **The type of the request body:** - JSON and form bodies are sent -- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. +- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. ## Source Context diff --git a/docs/platforms/android/data-management/sensitive-data/index.mdx b/docs/platforms/android/data-management/sensitive-data/index.mdx index f06150b89cbdd..9233f0a37ae5c 100644 --- a/docs/platforms/android/data-management/sensitive-data/index.mdx +++ b/docs/platforms/android/data-management/sensitive-data/index.mdx @@ -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). +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/#sendDefaultPii). 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). diff --git a/docs/platforms/android/integrations/jetpack-compose/index.mdx b/docs/platforms/android/integrations/jetpack-compose/index.mdx index db81f1efe7ba0..b441c22f60099 100644 --- a/docs/platforms/android/integrations/jetpack-compose/index.mdx +++ b/docs/platforms/android/integrations/jetpack-compose/index.mdx @@ -234,7 +234,7 @@ NavHost( } ``` -By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished. You can customize the timeout to your needs. +By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished. You can customize the timeout to your needs. ### Verify diff --git a/docs/platforms/android/integrations/navigation/index.mdx b/docs/platforms/android/integrations/navigation/index.mdx index 9c6afa155cd9c..8e2f4470345b1 100644 --- a/docs/platforms/android/integrations/navigation/index.mdx +++ b/docs/platforms/android/integrations/navigation/index.mdx @@ -70,7 +70,7 @@ protected void onPause() { } ``` -By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished. You can customize the timeout to your needs. +By default, the navigation transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished. You can customize the timeout to your needs. ## Verify diff --git a/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx index efd92ed76778b..356f1254c0e8b 100644 --- a/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx @@ -338,7 +338,7 @@ plugins { #### Transaction Lifetime -The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished, or after it reaches the specified [deadlineTimeout](/platforms/android/configuration/options/#deadline-timeout), even if child spans are still running. +The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished, or after it reaches the specified [deadlineTimeout](/platforms/android/configuration/options/#deadlineTimeout), even if child spans are still running. The `idleTimeout` defaults to `3000` milliseconds (three seconds), and the `deadlineTimeout` defaults to `30000` milliseconds (thirty seconds). You can also disable the idle timeout and deadline timeout by setting them to `null`, but the transaction must be finished manually in this case. diff --git a/docs/platforms/android/tracing/trace-propagation/index.mdx b/docs/platforms/android/tracing/trace-propagation/index.mdx index f43f11619e5f4..d48a2d62fd588 100644 --- a/docs/platforms/android/tracing/trace-propagation/index.mdx +++ b/docs/platforms/android/tracing/trace-propagation/index.mdx @@ -68,4 +68,4 @@ SentryAndroid.init(context, { options -> Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](https://develop.sentry.dev/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. -To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/android/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. +To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/android/configuration/options/#propagateTraceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. diff --git a/docs/platforms/android/troubleshooting/index.mdx b/docs/platforms/android/troubleshooting/index.mdx index 6aa9e8794aebc..f9a76757748b0 100644 --- a/docs/platforms/android/troubleshooting/index.mdx +++ b/docs/platforms/android/troubleshooting/index.mdx @@ -198,7 +198,7 @@ If you set up the Sentry SDK and it's not sending any data to Sentry: - Check that you have configured a DSN and that you are passing it to the `dsn` option in `SentryAndroid.init()` or `AndroidManifest`. - When a crash happens or the app closes, the system allows only a short time to handle it before terminating the process. The SDK might not have enough time to send the event, spans, profile, or replay data. In these cases, simply relaunching the app should allow the SDK to send the remaining data. -- An ad-blocker (e.g. [DuckDuckGo's App Tracking Protection](https://duckduckgo.com/duckduckgo-help-pages/p-app-tracking-protection/what-is-app-tracking-protection)) or network restrictions might be preventing the SDK from reaching Sentry's servers. As a workaround, you can use [tunneling](/platforms/javascript/troubleshooting/#using-the-tunnel-option) to proxy Sentry events through your own server. Then you can add the [proxy option](/platforms/android/configuration/options/#proxy) to your SDK configuration. +- An ad-blocker (e.g. [DuckDuckGo's App Tracking Protection](https://duckduckgo.com/duckduckgo-help-pages/p-app-tracking-protection/what-is-app-tracking-protection)) or network restrictions might be preventing the SDK from reaching Sentry's servers. As a workaround, you can use [tunneling](/platforms/javascript/troubleshooting/#using-the-tunnel-option) to proxy Sentry events through your own server. Then you can add the [proxy option](/platforms/android/configuration/options/#httpProxy) to your SDK configuration. - Set `debug: true` in the `SentryAndroid.init()` or the manifest options and observe your Logcat output when you start your application. The SDK may tell you why it is not sending any data. - Check the [Stats](https://sentry.io/orgredirect/organizations/:orgslug/stats/) and [Subscription](https://sentry.io/orgredirect/organizations/:orgslug/settings/billing/overview/) pages in Sentry. You may be out of quota. diff --git a/docs/platforms/android/user-feedback/index.mdx b/docs/platforms/android/user-feedback/index.mdx index a1a8940d831c1..0f67b9c5d113e 100644 --- a/docs/platforms/android/user-feedback/index.mdx +++ b/docs/platforms/android/user-feedback/index.mdx @@ -76,7 +76,7 @@ The User Feedback widget integrates seamlessly with Session Replay. When the wid The User Feedback API allows you to collect user feedback while using your own UI components. You can submit feedback directly using the `Sentry.captureFeedback(Feedback)` method. -Sentry can optionally pair this feedback with an event, giving you additional insight into issues. Sentry needs the `eventId` to be able to associate the user feedback to the corresponding event. For example, to get the `eventId`, you can use beforeSend, or the return value of the method capturing an event. +Sentry can optionally pair this feedback with an event, giving you additional insight into issues. Sentry needs the `eventId` to be able to associate the user feedback to the corresponding event. For example, to get the `eventId`, you can use beforeSend, or the return value of the method capturing an event. ```java diff --git a/docs/platforms/dart/common/data-management/data-collected.mdx b/docs/platforms/dart/common/data-management/data-collected.mdx index c239d77b68e82..31cb749320421 100644 --- a/docs/platforms/dart/common/data-management/data-collected.mdx +++ b/docs/platforms/dart/common/data-management/data-collected.mdx @@ -8,13 +8,13 @@ Sentry takes data privacy very seriously and has default settings in place that 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 Sentry Dart SDK collects. -Many of the categories listed here require you to enable the sendDefaultPii option. +Many of the categories listed here require you to enable the sendDefaultPii option. ## HTTP Headers By default, the Sentry SDK doesn't send any HTTP headers. Even when sending HTTP headers is enabled, we have a [denylist](https://github.com/getsentry/sentry-dart/blob/ea1d45d64f52551e2e033c50b0ff8512e3d8a4e3/dart/lib/src/utils/http_sanitizer.dart#L9C1-L21C1) in place, which filters out any headers that contain sensitive data. -To start sending HTTP headers, set `sendDefaultPii = true`. +To start sending HTTP headers, set `sendDefaultPii = true`. ## Information About Logged-in User @@ -42,7 +42,7 @@ The request body of incoming HTTP requests can be sent to Sentry. Whether it's s - **The type of the request body:** - JSON and form bodies are sent -- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. +- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. ## File I/O diff --git a/docs/platforms/dart/guides/flutter/data-management/data-collected.mdx b/docs/platforms/dart/guides/flutter/data-management/data-collected.mdx index db9e20f1683f3..6129e0ce1e4c9 100644 --- a/docs/platforms/dart/guides/flutter/data-management/data-collected.mdx +++ b/docs/platforms/dart/guides/flutter/data-management/data-collected.mdx @@ -8,13 +8,13 @@ Sentry takes data privacy very seriously and has default settings in place that 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 Sentry Flutter SDK collects. -Many of the categories listed here require you to enable the sendDefaultPii option. +Many of the categories listed here require you to enable the sendDefaultPii option. ## HTTP Headers By default, the Sentry SDK doesn't send any HTTP headers. Even when sending HTTP headers is enabled, we have a [denylist](https://github.com/getsentry/sentry-dart/blob/ea1d45d64f52551e2e033c50b0ff8512e3d8a4e3/dart/lib/src/utils/http_sanitizer.dart#L9C1-L21C1) in place, which filters out any headers that contain sensitive data. -To start sending HTTP headers, set `sendDefaultPii = true`. +To start sending HTTP headers, set `sendDefaultPii = true`. ## Information About Logged-in User @@ -42,7 +42,7 @@ The request body of incoming HTTP requests can be sent to Sentry. Whether it's s - **The type of the request body:** - JSON and form bodies are sent -- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. +- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. ## Source Context diff --git a/docs/platforms/dotnet/common/data-management/data-collected.mdx b/docs/platforms/dotnet/common/data-management/data-collected.mdx index 5668919579c48..dc389452c5e06 100644 --- a/docs/platforms/dotnet/common/data-management/data-collected.mdx +++ b/docs/platforms/dotnet/common/data-management/data-collected.mdx @@ -54,7 +54,7 @@ The full request query string of outgoing and incoming HTTP requests is **always ## Request Body -The MaxRequestBodySize option can be used to configure whether the request body of incoming HTTP requests will be sent to Sentry. +The MaxRequestBodySize option can be used to configure whether the request body of incoming HTTP requests will be sent to Sentry. By default this is sent to `RequestSize.None`, which means that the request body is not sent to Sentry. 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..0dccdba9c0713 100644 --- a/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx @@ -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). +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/#SendDefaultPii). 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). diff --git a/docs/platforms/java/common/configuration/index.mdx b/docs/platforms/java/common/configuration/index.mdx index abf3ad1ade660..dc471bdfaca14 100644 --- a/docs/platforms/java/common/configuration/index.mdx +++ b/docs/platforms/java/common/configuration/index.mdx @@ -418,7 +418,7 @@ Sentry.init { ## Client reports -To turn off sending of client reports, use the [`sendClientReports`](/platforms/java/configuration/options/#send-client-reports) option: +To turn off sending of client reports, use the [`sendClientReports`](/platforms/java/configuration/options/#sendClientReports) option: ```properties {tabTitle:sentry.properties} send-client-reports=false diff --git a/docs/platforms/java/common/configuration/options.mdx b/docs/platforms/java/common/configuration/options.mdx index f9609de6130f6..a200be95e4d74 100644 --- a/docs/platforms/java/common/configuration/options.mdx +++ b/docs/platforms/java/common/configuration/options.mdx @@ -150,7 +150,7 @@ This parameter controls whether integrations should capture HTTP request bodies. - `always`: The SDK will always capture the request body as long as Sentry can make sense of it. For request bodies to be captured, the flag must also be enabled. -Please consult the documentation for to evaluate whether you would want to enable it, making sure to manually remove the data you don't want to send using our features for managing Sensitive Data. +Please consult the documentation for to evaluate whether you would want to enable it, making sure to manually remove the data you don't want to send using our features for managing Sensitive Data. diff --git a/docs/platforms/java/common/configuration/sampling.mdx b/docs/platforms/java/common/configuration/sampling.mdx index ac487d4051c74..be76c6403b55b 100644 --- a/docs/platforms/java/common/configuration/sampling.mdx +++ b/docs/platforms/java/common/configuration/sampling.mdx @@ -29,7 +29,7 @@ We recommend sampling your transactions for two reasons: Choose a sampling rate with the goal of finding a balance between performance and volume concerns with data accuracy. You don't want to collect _too_ much data, but you want to collect sufficient data from which to draw meaningful conclusions. If you’re not sure what rate to choose, start with a low value and gradually increase it as you learn more about your traffic patterns and volume. -As of version 7.8.0 of the Java SDK Sentry will automatically downsample while the system is under load. Take a look at for more details or if you would like to opt out of this behaviour. +As of version 7.8.0 of the Java SDK Sentry will automatically downsample while the system is under load. Take a look at for more details or if you would like to opt out of this behaviour. ## Configuring the Transaction Sample Rate diff --git a/docs/platforms/java/common/data-management/data-collected.mdx b/docs/platforms/java/common/data-management/data-collected.mdx index 5f08f31235ad3..7b89882bfa0b2 100644 --- a/docs/platforms/java/common/data-management/data-collected.mdx +++ b/docs/platforms/java/common/data-management/data-collected.mdx @@ -8,7 +8,7 @@ Sentry takes data privacy very seriously and has default settings in place that 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 Sentry Java SDK collects. -For many of the categories listed here it is required to enable the sendDefaultPii option. +For many of the categories listed here it is required to enable the sendDefaultPii option. ## HTTP Headers @@ -16,13 +16,13 @@ For many of the categories listed here it is required to enable the `sendDefaultPii=true`. +To send all HTTP headers, set `sendDefaultPii=true`. ### Incoming Requests By default, the Sentry SDK sends headers for incoming HTTP requests to Sentry but filters out any headers that contain sensitive data. (See the [list of headers](https://github.com/getsentry/sentry-java/blob/main/sentry/src/main/java/io/sentry/util/HttpUtils.java#L21-L34) that are filtered). -To send all HTTP headers, set `sendDefaultPii=true`. +To send all HTTP headers, set `sendDefaultPii=true`. ## Cookies @@ -56,7 +56,7 @@ The request body of incoming HTTP requests can be sent to Sentry. Whether it's s - **The type of the request body:** - JSON and form bodies are sent -- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. +- **The size of the request body:** There's a maxRequestBodySize option that's set to `NONE` by default. This means by default no request body is sent to Sentry. ## Source Context diff --git a/docs/platforms/java/common/data-management/sensitive-data/index.mdx b/docs/platforms/java/common/data-management/sensitive-data/index.mdx index b75989aa3be6b..e9ae615c1204b 100644 --- a/docs/platforms/java/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/java/common/data-management/sensitive-data/index.mdx @@ -31,7 +31,7 @@ Ensure that your team is aware of your company's policy around what can and cann ## Personally Identifiable Information (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). +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/#sendDefaultPii). 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). diff --git a/docs/platforms/java/common/migration/5.x-to-6.0.mdx b/docs/platforms/java/common/migration/5.x-to-6.0.mdx index 77fc13b14357b..69538c5abb925 100644 --- a/docs/platforms/java/common/migration/5.x-to-6.0.mdx +++ b/docs/platforms/java/common/migration/5.x-to-6.0.mdx @@ -43,7 +43,7 @@ val hints = mutableMapOf("myHint" to "myStringHint") Sentry.captureException(RuntimeException("exception"), hints) ``` -- `SentryOptions#sendClientReports` is now enabled by default. To disable it, see [sendClientReports](/platforms/java/configuration/#client-reports). For more information on the option see [sendClientReports](/platforms/java/configuration/options/#send-client-reports). +- `SentryOptions#sendClientReports` is now enabled by default. To disable it, see [sendClientReports](/platforms/java/configuration/#client-reports). For more information on the option see [sendClientReports](/platforms/java/configuration/options/#sendClientReports). ### Sentry Self-hosted Compatibility diff --git a/docs/platforms/java/common/tracing/trace-propagation/index.mdx b/docs/platforms/java/common/tracing/trace-propagation/index.mdx index 4faa3f17830d9..9827365151dfd 100644 --- a/docs/platforms/java/common/tracing/trace-propagation/index.mdx +++ b/docs/platforms/java/common/tracing/trace-propagation/index.mdx @@ -68,4 +68,4 @@ Sentry.init(context, { options -> Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](https://develop.sentry.dev/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. -To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/java/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. \ No newline at end of file +To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/java/configuration/options/#propagateTraceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. \ No newline at end of file diff --git a/docs/platforms/java/common/user-feedback/index.mdx b/docs/platforms/java/common/user-feedback/index.mdx index ff9898f80c246..16ea69c1ba44a 100644 --- a/docs/platforms/java/common/user-feedback/index.mdx +++ b/docs/platforms/java/common/user-feedback/index.mdx @@ -16,6 +16,6 @@ Ensure you are using the Java SDK version 8.12.0 or above of the SDK to access t The User Feedback API allows you to collect user feedback while using your own UI components. -Sentry can optionally pair the feedback with an event, giving you additional insight into issues. Sentry needs the `eventId` to be able to associate the user feedback to the corresponding event. For example, to get the `eventId`, you can use or the return value of the method capturing an event. +Sentry can optionally pair the feedback with an event, giving you additional insight into issues. Sentry needs the `eventId` to be able to associate the user feedback to the corresponding event. For example, to get the `eventId`, you can use or the return value of the method capturing an event. diff --git a/docs/platforms/powershell/data-management/sensitive-data/index.mdx b/docs/platforms/powershell/data-management/sensitive-data/index.mdx index f06150b89cbdd..0dccdba9c0713 100644 --- a/docs/platforms/powershell/data-management/sensitive-data/index.mdx +++ b/docs/platforms/powershell/data-management/sensitive-data/index.mdx @@ -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). +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/#SendDefaultPii). 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). diff --git a/docs/platforms/react-native/data-management/data-collected.mdx b/docs/platforms/react-native/data-management/data-collected.mdx index 29da347f36c24..dde3db8a76aeb 100644 --- a/docs/platforms/react-native/data-management/data-collected.mdx +++ b/docs/platforms/react-native/data-management/data-collected.mdx @@ -8,13 +8,13 @@ Sentry takes data privacy very seriously and has default settings in place that 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 Sentry React Native SDK collects. -Many of the categories listed here require you to set `sendDefaultPii: true` in your `Sentry.init({})` config. +Many of the categories listed here require you to set `sendDefaultPii: true` in your `Sentry.init({})` config. ## HTTP Headers By default, failed Fetch and XHR requests error events from `Sentry.httpClientIntegration` don't contain headers. -To start sending headers, set `sendDefaultPii: true` in your `Sentry.init({})` config. +To start sending headers, set `sendDefaultPii: true` in your `Sentry.init({})` config. ## User-Agent diff --git a/docs/platforms/unity/enriching-events/attachments/index.mdx b/docs/platforms/unity/enriching-events/attachments/index.mdx index 3a8cc28545f17..0c1eba9e5757f 100644 --- a/docs/platforms/unity/enriching-events/attachments/index.mdx +++ b/docs/platforms/unity/enriching-events/attachments/index.mdx @@ -15,7 +15,7 @@ Alternately, use `bytes` to initialize an attachment. When doing so, you also ne -With [Offline Caching](/platforms/unity/configuration/options/#cache-directory-path) enabled, each attachment is stored to disk for each event or transaction you capture when the device is offline. When using large attachments, this storage can consume the disk space if the device is offline for a longer time period. +With [Offline Caching](/platforms/unity/configuration/options/#CacheDirectoryPath) enabled, each attachment is stored to disk for each event or transaction you capture when the device is offline. When using large attachments, this storage can consume the disk space if the device is offline for a longer time period. In addition, you can set these parameters: diff --git a/docs/platforms/unity/index.mdx b/docs/platforms/unity/index.mdx index fdca7c8d07cc3..01170d06a3b9f 100644 --- a/docs/platforms/unity/index.mdx +++ b/docs/platforms/unity/index.mdx @@ -26,7 +26,7 @@ Our Unity SDK builds on top of the [.NET SDK](/platforms/dotnet/) and extends it - [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) support - [Screenshot attachments](/platforms/unity/enriching-events/screenshots/) for errors - [ViewHierarchy attachments](/platforms/unity/enriching-events/view-hierarchy/) for errors -- [Offline Caching](/platforms/unity/configuration/options/#cache-directory-path) stores event data to disk in case the device is not online +- [Offline Caching](/platforms/unity/configuration/options/#CacheDirectoryPath) stores event data to disk in case the device is not online - [Release Health](/platforms/unity/configuration/releases/) to keep track of crash-free users and sessions - [Automatically adding breadcrumbs](/platforms/unity/enriching-events/breadcrumbs/#automatic-breadcrumbs) for - Unity's `Debug.Log` and `Debug.LogWarning` diff --git a/docs/platforms/unreal/data-management/data-collected.mdx b/docs/platforms/unreal/data-management/data-collected.mdx index 692384a55db87..55b6554d1c674 100644 --- a/docs/platforms/unreal/data-management/data-collected.mdx +++ b/docs/platforms/unreal/data-management/data-collected.mdx @@ -12,7 +12,7 @@ The category types and amount of data collected vary, depending on the integrati By default, the Sentry SDK doesn't send the user's IP address. Once enabled, the Sentry backend services will infer the user ip address based on the incoming request, unless certain integrations you can enable override this behavior. -To enable sending the user's IP address, set `sendDefaultPii=true`. +To enable sending the user's IP address, set `sendDefaultPii=true`. ## Screenshots From 7de190e06a16546069d364cbf08b35d9fe43ba4a Mon Sep 17 00:00:00 2001 From: Shannon Anahata Date: Wed, 15 Oct 2025 13:13:03 -0700 Subject: [PATCH 2/4] adding more broken links I found --- docs/platforms/apple/common/data-management/data-collected.mdx | 2 +- docs/platforms/apple/common/features/experimental-features.mdx | 2 +- .../tracing/instrumentation/automatic-instrumentation.mdx | 2 +- docs/platforms/apple/common/usage/in-app-frames/index.mdx | 2 +- .../kotlin-multiplatform/data-management/data-collected.mdx | 2 +- docs/platforms/php/common/data-management/data-collected.mdx | 2 +- .../php/common/data-management/sensitive-data/index.mdx | 2 +- docs/platforms/python/data-management/sensitive-data/index.mdx | 2 +- docs/platforms/rust/common/data-management/data-collected.mdx | 2 +- .../rust/common/data-management/sensitive-data/index.mdx | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/platforms/apple/common/data-management/data-collected.mdx b/docs/platforms/apple/common/data-management/data-collected.mdx index 062688353f9c5..a9ded0dea981b 100644 --- a/docs/platforms/apple/common/data-management/data-collected.mdx +++ b/docs/platforms/apple/common/data-management/data-collected.mdx @@ -24,7 +24,7 @@ The HTTP Client Errors`sendDefaultPii=true`. +To enable sending the user's IP address, set `sendDefaultPii=true`. ## Request URL diff --git a/docs/platforms/apple/common/features/experimental-features.mdx b/docs/platforms/apple/common/features/experimental-features.mdx index 525dd43064294..c5c70e2a24d30 100644 --- a/docs/platforms/apple/common/features/experimental-features.mdx +++ b/docs/platforms/apple/common/features/experimental-features.mdx @@ -19,7 +19,7 @@ Do you want to try some new experimental features? On the latest version of the - Enable AppHangsV2 to get more detailed app hangs. This differentiates between fully-blocking and non-fully-blocking app hangs, and also tells you the duration of app hangs. - If you use Swift concurrency, stitch together stack traces of your async code with the `swiftAsyncStacktraces` option. Note that you can enable this in your Objective-C project, but only async code written in Swift will be stitched together. -- Enable the `enablePersistingTracesWhenCrashing` option to link ongoing transactions to a crash event when your app crashes. +- Enable the `enablePersistingTracesWhenCrashing` option to link ongoing transactions to a crash event when your app crashes. - Enable the `enableUnhandledCPPExceptionsV2` option to capture fatal CPPExceptions via hooking into `cxa_throw` Let us know if you have feedback through [GitHub issues](https://github.com/getsentry/sentry-cocoa/issues). diff --git a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx index 0fabb73f42f7c..4feb133955081 100644 --- a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx @@ -409,7 +409,7 @@ SentrySDK.start { options in }]; ``` -The SDK composes the transaction name out of the host `UIViewController` and the method that the `UIView` is calling; for example, `YourApp_LoginUIViewController.loginButton`. The SDK sets the transaction operation to `ui.action`. If the SDK detects the interaction's origin was a click, it adds `click` as a suffix to the operation. The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds). +The SDK composes the transaction name out of the host `UIViewController` and the method that the `UIView` is calling; for example, `YourApp_LoginUIViewController.loginButton`. The SDK sets the transaction operation to `ui.action`. If the SDK detects the interaction's origin was a click, it adds `click` as a suffix to the operation. The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds). diff --git a/docs/platforms/apple/common/usage/in-app-frames/index.mdx b/docs/platforms/apple/common/usage/in-app-frames/index.mdx index 20beba57d39a4..c5230995beefe 100644 --- a/docs/platforms/apple/common/usage/in-app-frames/index.mdx +++ b/docs/platforms/apple/common/usage/in-app-frames/index.mdx @@ -19,7 +19,7 @@ If you're not familiar with these terms, you can learn more: ## Dynamic Frameworks -If you use dynamic frameworks such as Sentry, the Sentry SDK will mark them as `not inApp`. If you have a private framework that should be marked as `inApp`, use the SentryOptions [`inAppInclude`](/platforms/apple/configuration/options/#in-app-include) or [`inAppExclude`](/platforms/apple/configuration/options/#in-app-exclude). +If you use dynamic frameworks such as Sentry, the Sentry SDK will mark them as `not inApp`. If you have a private framework that should be marked as `inApp`, use the SentryOptions [`inAppInclude`](/platforms/apple/configuration/options/#inAppInclude) or [`inAppExclude`](/platforms/apple/configuration/options/#inAppExclude). ```swift {tabTitle:Swift} diff --git a/docs/platforms/kotlin/guides/kotlin-multiplatform/data-management/data-collected.mdx b/docs/platforms/kotlin/guides/kotlin-multiplatform/data-management/data-collected.mdx index d6c807f661ecb..d2aec121131cd 100644 --- a/docs/platforms/kotlin/guides/kotlin-multiplatform/data-management/data-collected.mdx +++ b/docs/platforms/kotlin/guides/kotlin-multiplatform/data-management/data-collected.mdx @@ -8,7 +8,7 @@ Sentry takes data privacy very seriously and has default settings in place that The category types and amount of data collected vary, depending on the integrations you've enabled in the Sentry SDK. By default the Kotlin Multiplatform SDK will collect data as specified by the used native SDKs. -Many of the categories listed require you to set `sendDefaultPii: true` in your `Sentry.init` config. +Many of the categories listed require you to set `sendDefaultPii: true` in your `Sentry.init` config. diff --git a/docs/platforms/php/common/data-management/data-collected.mdx b/docs/platforms/php/common/data-management/data-collected.mdx index 89795d6708b0c..a118996a8ff77 100644 --- a/docs/platforms/php/common/data-management/data-collected.mdx +++ b/docs/platforms/php/common/data-management/data-collected.mdx @@ -50,7 +50,7 @@ If you want to prevent bodies from being sent to Sentry altogether, set `max_req When an unhandled exception is sent to Sentry, a snapshot of the source code surrounding the line where the error originates is sent with it. -To opt out of sending this source context to Sentry, set the `context_lines` option to `0`. +To opt out of sending this source context to Sentry, set the `context_lines` option to `0`. ## Local Variables In Stack Trace diff --git a/docs/platforms/php/common/data-management/sensitive-data/index.mdx b/docs/platforms/php/common/data-management/sensitive-data/index.mdx index f06150b89cbdd..309aa0801be3e 100644 --- a/docs/platforms/php/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/php/common/data-management/sensitive-data/index.mdx @@ -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). +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). 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). diff --git a/docs/platforms/python/data-management/sensitive-data/index.mdx b/docs/platforms/python/data-management/sensitive-data/index.mdx index 2a9a54f636b54..a167fca104a69 100644 --- a/docs/platforms/python/data-management/sensitive-data/index.mdx +++ b/docs/platforms/python/data-management/sensitive-data/index.mdx @@ -31,7 +31,7 @@ Ensure that your team is aware of your company's policy around what can and cann ## Personally Identifiable Information (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). +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). diff --git a/docs/platforms/rust/common/data-management/data-collected.mdx b/docs/platforms/rust/common/data-management/data-collected.mdx index 82948c25f13b4..ade4f8b00ce96 100644 --- a/docs/platforms/rust/common/data-management/data-collected.mdx +++ b/docs/platforms/rust/common/data-management/data-collected.mdx @@ -52,7 +52,7 @@ Then, whether the request body is sent or not, depends on the type and size of r - 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/rust/configuration/options/#max-request-body-size) option that's set to `MaxRequestBodySize::Medium` by default, which governs the maximum size of request bodies that are sent to Sentry. +- **The size of the request body:** There's a [`max_request_body_size`](/platforms/rust/configuration/options/#max_request_body_size) option that's set to `MaxRequestBodySize::Medium` by default, which governs the maximum size of request bodies that are sent to Sentry. If you want to prevent request bodies from being sent to Sentry altogether, set `max_request_body_size` to `MaxRequestBodySize::None`. diff --git a/docs/platforms/rust/common/data-management/sensitive-data/index.mdx b/docs/platforms/rust/common/data-management/sensitive-data/index.mdx index 1e9cf022cf141..23a78bf5392c6 100644 --- a/docs/platforms/rust/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/rust/common/data-management/sensitive-data/index.mdx @@ -31,7 +31,7 @@ Ensure that your team is aware of your company's policy around what can and cann ## Personally Identifiable Information (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). +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). From 39cae7153add34d42de531b5a79ed9d94f9ff951 Mon Sep 17 00:00:00 2001 From: Shannon Anahata Date: Wed, 15 Oct 2025 13:35:32 -0700 Subject: [PATCH 3/4] fixing android link --- docs/platforms/android/troubleshooting/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/platforms/android/troubleshooting/index.mdx b/docs/platforms/android/troubleshooting/index.mdx index f9a76757748b0..6aa9e8794aebc 100644 --- a/docs/platforms/android/troubleshooting/index.mdx +++ b/docs/platforms/android/troubleshooting/index.mdx @@ -198,7 +198,7 @@ If you set up the Sentry SDK and it's not sending any data to Sentry: - Check that you have configured a DSN and that you are passing it to the `dsn` option in `SentryAndroid.init()` or `AndroidManifest`. - When a crash happens or the app closes, the system allows only a short time to handle it before terminating the process. The SDK might not have enough time to send the event, spans, profile, or replay data. In these cases, simply relaunching the app should allow the SDK to send the remaining data. -- An ad-blocker (e.g. [DuckDuckGo's App Tracking Protection](https://duckduckgo.com/duckduckgo-help-pages/p-app-tracking-protection/what-is-app-tracking-protection)) or network restrictions might be preventing the SDK from reaching Sentry's servers. As a workaround, you can use [tunneling](/platforms/javascript/troubleshooting/#using-the-tunnel-option) to proxy Sentry events through your own server. Then you can add the [proxy option](/platforms/android/configuration/options/#httpProxy) to your SDK configuration. +- An ad-blocker (e.g. [DuckDuckGo's App Tracking Protection](https://duckduckgo.com/duckduckgo-help-pages/p-app-tracking-protection/what-is-app-tracking-protection)) or network restrictions might be preventing the SDK from reaching Sentry's servers. As a workaround, you can use [tunneling](/platforms/javascript/troubleshooting/#using-the-tunnel-option) to proxy Sentry events through your own server. Then you can add the [proxy option](/platforms/android/configuration/options/#proxy) to your SDK configuration. - Set `debug: true` in the `SentryAndroid.init()` or the manifest options and observe your Logcat output when you start your application. The SDK may tell you why it is not sending any data. - Check the [Stats](https://sentry.io/orgredirect/organizations/:orgslug/stats/) and [Subscription](https://sentry.io/orgredirect/organizations/:orgslug/settings/billing/overview/) pages in Sentry. You may be out of quota. From 57f0fc8d8b9fd79bc507d914968e05ffaf78602b Mon Sep 17 00:00:00 2001 From: Shannon Anahata Date: Wed, 15 Oct 2025 13:50:23 -0700 Subject: [PATCH 4/4] updating for sub-frameworks --- .../tracing/instrumentation/automatic-instrumentation.mdx | 2 +- docs/platforms/unity/enriching-events/attachments/index.mdx | 2 +- docs/platforms/unity/index.mdx | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx index 4feb133955081..746c932a7d914 100644 --- a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx @@ -409,7 +409,7 @@ SentrySDK.start { options in }]; ``` -The SDK composes the transaction name out of the host `UIViewController` and the method that the `UIView` is calling; for example, `YourApp_LoginUIViewController.loginButton`. The SDK sets the transaction operation to `ui.action`. If the SDK detects the interaction's origin was a click, it adds `click` as a suffix to the operation. The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idleTimeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds). +The SDK composes the transaction name out of the host `UIViewController` and the method that the `UIView` is calling; for example, `YourApp_LoginUIViewController.loginButton`. The SDK sets the transaction operation to `ui.action`. If the SDK detects the interaction's origin was a click, it adds `click` as a suffix to the operation. The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/apple/guides/ios/configuration/options/#idleTimeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds). diff --git a/docs/platforms/unity/enriching-events/attachments/index.mdx b/docs/platforms/unity/enriching-events/attachments/index.mdx index 0c1eba9e5757f..e39fbe5c6a8c3 100644 --- a/docs/platforms/unity/enriching-events/attachments/index.mdx +++ b/docs/platforms/unity/enriching-events/attachments/index.mdx @@ -15,7 +15,7 @@ Alternately, use `bytes` to initialize an attachment. When doing so, you also ne -With [Offline Caching](/platforms/unity/configuration/options/#CacheDirectoryPath) enabled, each attachment is stored to disk for each event or transaction you capture when the device is offline. When using large attachments, this storage can consume the disk space if the device is offline for a longer time period. +With [Offline Caching](/platforms/unity/configuration/options/#InitCacheFlushTimeout) enabled, each attachment is stored to disk for each event or transaction you capture when the device is offline. When using large attachments, this storage can consume the disk space if the device is offline for a longer time period. In addition, you can set these parameters: diff --git a/docs/platforms/unity/index.mdx b/docs/platforms/unity/index.mdx index 01170d06a3b9f..9e2dae2a99122 100644 --- a/docs/platforms/unity/index.mdx +++ b/docs/platforms/unity/index.mdx @@ -26,7 +26,7 @@ Our Unity SDK builds on top of the [.NET SDK](/platforms/dotnet/) and extends it - [PlayStation](/platforms/playstation/), [Xbox](/platforms/xbox/) and [Nintendo Switch](/platforms/nintendo-switch/) support - [Screenshot attachments](/platforms/unity/enriching-events/screenshots/) for errors - [ViewHierarchy attachments](/platforms/unity/enriching-events/view-hierarchy/) for errors -- [Offline Caching](/platforms/unity/configuration/options/#CacheDirectoryPath) stores event data to disk in case the device is not online +- [Offline Caching](/platforms/unity/configuration/options/#InitCacheFlushTimeout) stores event data to disk in case the device is not online - [Release Health](/platforms/unity/configuration/releases/) to keep track of crash-free users and sessions - [Automatically adding breadcrumbs](/platforms/unity/enriching-events/breadcrumbs/#automatic-breadcrumbs) for - Unity's `Debug.Log` and `Debug.LogWarning`