Configuration

General Configuration

Configure Session Replay inside your SentrySDK.start call by setting properties on options.sessionReplay (Session Replay Options).

The SDK exposes the following main options to configure Session Replay for your project:

The following options provide further customization:

To configure masking by view class, see Custom Masking.

Network Details

When enabled, Replay can capture basic information about all outgoing HTTP requests in your application, including the URL, request and response body sizes, method, and status code. This limits the chance of collecting private data.

To capture additional information such as request and response headers or bodies, you need to:

1. Enable the experimental flag options.experimental.enableReplayNetworkDetailsCapturing
2. Specify which URLs to capture via networkDetailAllowUrls

This opt-in approach lets you choose only URLs that are safe for capturing bodies and avoid any endpoints that may contain Personally Identifiable Information (PII).

Requirements

• SDK version >= 9.12.0

Any URL matching the given pattern(s) will be captured with additional details:

SentrySDK.start { options in
    options.experimental.enableReplayNetworkDetailsCapturing = true
    options.sessionReplay.networkDetailAllowUrls = ["https://example.com"]
}

SentrySDK.start { options in
    options.experimental.enableReplayNetworkDetailsCapturing = true
    options.sessionReplay.networkDetailAllowUrls = ["https://example.com"]
}

String patterns use substring matching — any URL containing the string will match. To use exact or more complex matching, pass an NSRegularExpression:

let apiRegex = try! NSRegularExpression(pattern: "^https://api\\.example\\.com/.*")

SentrySDK.start { options in
    options.experimental.enableReplayNetworkDetailsCapturing = true
    options.sessionReplay.networkDetailAllowUrls = [
        "api.example.com",  // substring match
        apiRegex,           // regex match
    ]
}

let apiRegex = try! NSRegularExpression(pattern: "^https://api\\.example\\.com/.*")

SentrySDK.start { options in
    options.experimental.enableReplayNetworkDetailsCapturing = true
    options.sessionReplay.networkDetailAllowUrls = [
        "api.example.com",  // substring match
        apiRegex,           // regex match
    ]
}

Requests to a matching URL will include request and response bodies, as well as the following default headers:

• Content-Type
• Content-Length
• Accept

To capture additional headers, configure networkRequestHeaders and networkResponseHeaders. The default headers above are always included:

SentrySDK.start { options in
    options.experimental.enableReplayNetworkDetailsCapturing = true
    options.sessionReplay.networkDetailAllowUrls = ["https://api.example.com"]
    options.sessionReplay.networkRequestHeaders = ["Cache-Control", "X-My-Header"]
    options.sessionReplay.networkResponseHeaders = ["Referrer-Policy", "X-Response-Header"]
}

SentrySDK.start { options in
    options.experimental.enableReplayNetworkDetailsCapturing = true
    options.sessionReplay.networkDetailAllowUrls = ["https://api.example.com"]
    options.sessionReplay.networkRequestHeaders = ["Cache-Control", "X-My-Header"]
    options.sessionReplay.networkResponseHeaders = ["Referrer-Policy", "X-Response-Header"]
}