Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/platforms/android/data-management/data-collected.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PlatformLink to="/configuration/options/#send-default-pii">sendDefaultPii option</PlatformLink>.
Many of the categories listed here require you to enable the <PlatformLink to="/configuration/options/#sendDefaultPii">sendDefaultPii option</PlatformLink>.

## 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 <PlatformLink to="/configuration/options/#send-default-pii">`sendDefaultPii=true`</PlatformLink>.
To start sending HTTP headers, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii=true`</PlatformLink>.

## Cookies

Expand Down Expand Up @@ -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 <PlatformLink to="/configuration/options/#max-request-body-size">maxRequestBodySize</PlatformLink> 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 <PlatformLink to="/configuration/options/#maxRequestBodySize">maxRequestBodySize</PlatformLink> option that's set to `NONE` by default. This means by default no request body is sent to Sentry.

## Source Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/integrations/navigation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/tracing/trace-propagation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/platforms/android/user-feedback/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PlatformLink to="/configuration/options/#before-send">beforeSend</PlatformLink>, 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 <PlatformLink to="/configuration/options/#beforeSend">beforeSend</PlatformLink>, or the return value of the method capturing an event.


```java
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The <PlatformLink to="/configuration/http-client-errors">HTTP Client Errors</Pla

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 <PlatformLink to="/configuration/options/#send-default-pii">`sendDefaultPii=true`</PlatformLink>.
To enable sending the user's IP address, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii=true`</PlatformLink>.

## Request URL

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Do you want to try some new experimental features? On the latest version of the
- Enable <PlatformLink to="/configuration/app-hangs/#app-hangs-v2">AppHangsV2</PlatformLink> 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.
</PlatformSection>
- 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 <PlatformLink to="/configuration/options/#enable-persisting-traces-when-crashing">`enablePersistingTracesWhenCrashing`</PlatformLink> option to link ongoing transactions to a crash event when your app crashes.
- Enable the <PlatformLink to="/configuration/options/#enablePersistingTracesWhenCrashing">`enablePersistingTracesWhenCrashing`</PlatformLink> 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).
Original file line number Diff line number Diff line change
Expand Up @@ -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/apple/guides/ios/configuration/options/#idleTimeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds).

<Alert>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/apple/common/usage/in-app-frames/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
6 changes: 3 additions & 3 deletions docs/platforms/dart/common/data-management/data-collected.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PlatformLink to="/configuration/options/#send-default-pii">sendDefaultPii option</PlatformLink>.
Many of the categories listed here require you to enable the <PlatformLink to="/configuration/options/#sendDefaultPii">sendDefaultPii option</PlatformLink>.

## 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 <PlatformLink to="/configuration/options/#send-default-pii">`sendDefaultPii = true`</PlatformLink>.
To start sending HTTP headers, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii = true`</PlatformLink>.

## Information About Logged-in User

Expand Down Expand Up @@ -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 <PlatformLink to="/configuration/options/#max-request-body-size">maxRequestBodySize</PlatformLink> 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 <PlatformLink to="/configuration/options/#maxRequestBodySize">maxRequestBodySize</PlatformLink> option that's set to `NONE` by default. This means by default no request body is sent to Sentry.

## File I/O

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PlatformLink to="/configuration/options/#send-default-pii">sendDefaultPii option</PlatformLink>.
Many of the categories listed here require you to enable the <PlatformLink to="/configuration/options/#sendDefaultPii">sendDefaultPii option</PlatformLink>.

## 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 <PlatformLink to="/configuration/options/#send-default-pii">`sendDefaultPii = true`</PlatformLink>.
To start sending HTTP headers, set <PlatformLink to="/configuration/options/#sendDefaultPii">`sendDefaultPii = true`</PlatformLink>.

## Information About Logged-in User

Expand Down Expand Up @@ -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 <PlatformLink to="/configuration/options/#max-request-body-size">maxRequestBodySize</PlatformLink> 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 <PlatformLink to="/configuration/options/#maxRequestBodySize">maxRequestBodySize</PlatformLink> option that's set to `NONE` by default. This means by default no request body is sent to Sentry.

## Source Context

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The full request query string of outgoing and incoming HTTP requests is **always

## Request Body

The <PlatformLink to="/configuration/options/#max-request-body-size">MaxRequestBodySize</PlatformLink> option can be used to configure whether the request body of incoming HTTP requests will be sent to Sentry.
The <PlatformLink to="/configuration/options/#MaxRequestBodySize">MaxRequestBodySize</PlatformLink> 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/java/common/configuration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/java/common/configuration/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PlatformIdentifier name="sendDefaultPii" /> flag must also be enabled.
Please consult the <PlatformLink to="/configuration/options/#send-default-pii">documentation for <PlatformIdentifier name="sendDefaultPii" /></PlatformLink> 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 <PlatformLink to="/data-management/sensitive-data">managing Sensitive Data</PlatformLink>.
Please consult the <PlatformLink to="/configuration/options/#sendDefaultPii">documentation for <PlatformIdentifier name="sendDefaultPii" /></PlatformLink> 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 <PlatformLink to="/data-management/sensitive-data">managing Sensitive Data</PlatformLink>.

</SdkOption>

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/java/common/configuration/sampling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 <PlatformLink to="/configuration/options/#enable-backpressure-handling"><PlatformIdentifier name="enable-backpressure-handling" /></PlatformLink> 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 <PlatformLink to="/configuration/options/#enableBackpressureHandling"><PlatformIdentifier name="enable-backpressure-handling" /></PlatformLink> for more details or if you would like to opt out of this behaviour.

## Configuring the Transaction Sample Rate

Expand Down
Loading
Loading