|
| 1 | +--- |
| 2 | +title: Configuration |
| 3 | +sidebar_order: 4110 |
| 4 | +description: "Learn about the general Session Replay configuration fields." |
| 5 | +og_image: /og-images/platforms-android-session-replay-configuration.png |
| 6 | +--- |
| 7 | + |
| 8 | +## General Configuration |
| 9 | + |
| 10 | +On Android you configure Session Replay by creating `<meta-data>` entries inside your `AndroidManifest.xml` ([Options configuration](/platforms/android/configuration/options/)), or alternatively in code `SentryAndroid.init(context) { options -> ... }` ([Manual Initialization](/platforms/android/configuration/manual-init/#manual-initialization)). |
| 11 | + |
| 12 | +The SDK exposes the following main options to configure Session Replay for your project: |
| 13 | +| Key | AndroidManifest | Type | Default | Description | |
| 14 | +|-------------------------|--------------------------------------------------------|----------------------------------------------------------------------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 15 | + | sessionSampleRate | `io.sentry.session-replay.session-sample-rate` | double | `0.0` | Sample rate for replay sessions that start immediately and last the entirety of the user's session. `1.0` collects all sessions. | |
| 16 | + | onErrorSampleRate | `io.sentry.session-replay.on-error-sample-rate` | double | `0.0` | Sample rate for buffered replays that are triggered when an error occurs. The SDK keeps the previous minute of activity and continues until the session ends when an error is sampled. | |
| 17 | + |
| 18 | +and the following options provide further customization: |
| 19 | + |
| 20 | +| Key | AndroidManifest | Type | Default | Description | |
| 21 | +|-------------------------|--------------------------------------------------------|----------------------------------------------------------------------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |
| 22 | + | maskAllText | `io.sentry.session-replay.mask-all-text` | boolean | `true` | Masks all text-containing views by default. Setting this to `false` adds `TextView` classes to the unmask list so text appears in replays. | |
| 23 | + | maskAllImages | `io.sentry.session-replay.mask-all-images` | boolean | `true` | Masks image views by default. Turning this off moves `ImageView` into the unmask list so bitmap content is visible in replays. | |
| 24 | + | quality | `—` | enum | `SentryReplayQuality.MEDIUM` | Defines the image quality of the session replay; higher quality yields a more accurate replay at the cost of more data transfer and CPU work. | |
| 25 | + | screenshotStrategy | `io.sentry.session-replay.screenshot-strategy` | enum | `ScreenshotStrategyType.PIXEL_COPY` | Determines how the SDK captures screenshots. `PIXEL_COPY` is the default and offers better performance with masking, while `CANVAS` always masks text and images and is intended for strict PII environments (See [ScreenshotStrategy](/platforms/android/session-replay/#screenshot-strategy)). | |
| 26 | + | networkDetailAllowUrls| `io.sentry.session-replay.network-detail-allow-urls` | List<String> | `[]` | Regexp patterns of URLs to enable capture of request/response bodies and headers. You can mix plain strings and regexes to capture only the traffic you want. | |
| 27 | + | networkDetailDenyUrls | `io.sentry.session-replay.network-detail-deny-urls` | List<String> | `[]` | Regexp patterns of URLs to never enable capture of request/response bodies and headers, even if an allow pattern matches them. | |
| 28 | + | networkCaptureBodies | `io.sentry.session-replay.network-capture-bodies` | boolean | `true` | Controls whether request and response bodies are captured for allowed URLs. | |
| 29 | +| networkRequestHeaders | `io.sentry.session-replay.network-request-headers` | List<String> | `['Content-Type', 'Content-Length', 'Accept']` | Request header names to capture for enabled URLs. | |
| 30 | +| networkResponseHeaders| `io.sentry.session-replay.network-response-headers` | List<String> | `['Content-Type', 'Content-Length', 'Accept']` | Response header names to capture for enabled URLs. | |
| 31 | +| debug | `io.sentry.session-replay.debug` | boolean | `false` | Enables Session Replay debug logging, which prints diagnostic information when a replay is recorded. | |
| 32 | + |
| 33 | + |
| 34 | +## Network Details |
| 35 | + |
| 36 | +By default, Replay will capture basic information about all outgoing http requests in your application. This includes the URL, request and response body sizes, method, and status code. The intention is to limit the chance of collecting private data. |
| 37 | + |
| 38 | +To capture additional information such as request and response headers or bodies, you'll need to opt-in via `networkDetailAllowUrls`. This will make it possible for you to elect to only add URLs that are safe for capturing bodies and avoid any endpoints that may contain Personal Identifiable Information (PII). |
| 39 | + |
| 40 | +<Alert> |
| 41 | + |
| 42 | +Body and header content will be PII-sanitized server-side, based on object keys and values. Refer to [Server-Side Scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) for more details. |
| 43 | + |
| 44 | +</Alert> |
| 45 | + |
| 46 | +### Requirements |
| 47 | +- SDK version >= [8.28.0](https://github.com/getsentry/sentry-java/releases/tag/8.28.0) |
| 48 | +- OkHttp |
| 49 | + |
| 50 | +<Alert> |
| 51 | + |
| 52 | +If you've configured `networkDetailAllowUrls` but don't see request/response bodies or headers in your replays, see our [troubleshooting guide](/platforms/android/session-replay/troubleshooting/#why-cant-i-see-the-full-http-request-body-or-all-the-headers) for help. |
| 53 | + |
| 54 | +</Alert> |
| 55 | +Any URL matching the given pattern(s) will then be captured with additional details: |
| 56 | +```kotlin {tabTitle:Kotlin} |
| 57 | +SentryAndroid.init(this) { options -> |
| 58 | + options.sessionReplay.networkDetailAllowUrls = listOf("https://example.com") |
| 59 | +} |
| 60 | +``` |
| 61 | + |
| 62 | +```java {tabTitle:Java} |
| 63 | +SentryAndroid.init(this, options -> { |
| 64 | + options |
| 65 | + .getSessionReplay() |
| 66 | + .setNetworkDetailAllowUrls(Collections.singletonList("https://example.com")); |
| 67 | +}); |
| 68 | +``` |
| 69 | + |
| 70 | +```xml {tabTitle:XML} |
| 71 | +<application> |
| 72 | + <meta-data |
| 73 | + android:name="io.sentry.session-replay.network-detail-allow-urls" |
| 74 | + android:value="https://example.com" /> |
| 75 | +</application> |
| 76 | +``` |
| 77 | + |
| 78 | +If you give us a string, we'll match any URL that contains that string using Java's [`String#matches()`](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#matches-java.lang.String-)). This way, you can use a regex to handle exact or more complex matches. |
| 79 | + |
| 80 | +Requests to a URL matched by the configured patterns will be enhanced with request and response bodies, as well as the following default headers: |
| 81 | + |
| 82 | +- `Content-Type` |
| 83 | +- `Content-Length` |
| 84 | +- `Accept` |
| 85 | + |
| 86 | +If you want to capture additional headers, you'll have to configure them with the options `networkRequestHeaders` and `networkResponseHeaders`, for example: |
| 87 | + |
| 88 | +```xml |
| 89 | +<application> |
| 90 | + <meta-data |
| 91 | + android:name="io.sentry.session-replay.network-request-headers" |
| 92 | + android:value="Cache-Control,X-My-Header" /> |
| 93 | + <meta-data |
| 94 | + android:name="io.sentry.session-replay.network-response-headers" |
| 95 | + android:value="Referrer-Policy,X-Response-Header" /> |
| 96 | +</application> |
| 97 | +``` |
| 98 | + |
| 99 | +```kotlin {tabTitle:Kotlin} {7-8} |
| 100 | +SentryAndroid.init(this) { options -> |
| 101 | + options.sessionReplay.networkDetailAllowUrls = listOf( |
| 102 | + "https://api.example.com/.*", |
| 103 | + ) |
| 104 | + options.sessionReplay.networkRequestHeaders = listOf("Cache-Control", "X-My-Header") |
| 105 | + options.sessionReplay.networkResponseHeaders = listOf("Referrer-Policy", "X-Response-Header") |
| 106 | +} |
| 107 | +``` |
| 108 | + |
| 109 | +```java {tabTitle:Java} {5-11} |
| 110 | +SentryAndroid.init(this, options -> { |
| 111 | + options |
| 112 | + .getSessionReplay() |
| 113 | + .setNetworkDetailAllowUrls(Collections.singletonList("https://api.example.com/.*")); |
| 114 | + options |
| 115 | + .getSessionReplay() |
| 116 | + .setNetworkRequestHeaders(Arrays.asList("Cache-Control", "X-My-Header")); |
| 117 | + options |
| 118 | + .getSessionReplay() |
| 119 | + .setNetworkResponseHeaders(Arrays.asList("Referrer-Policy", "X-Response-Header")); |
| 120 | +}); |
| 121 | +``` |
| 122 | + |
| 123 | +<Alert>Captured bodies will be truncated to 150k characters max.</Alert> |
0 commit comments