세션 리플레이 iOS 독립형 SDK

이 문서에서는 독립형 SDK를 사용하여 iOS용 세션 리플레이를 설치하는 방법을 설명합니다. 제품 내 분석을 위해 Amplitude 이외의 공급자를 사용하는 경우 이 옵션을 선택하십시오.

앱에서 이미 Amplitude iOS SDK를 사용하고 있는 경우, 세션 리플레이 iOS SDK 플러그인을 대신 사용하십시오.

Analytics-Swift SDK 및 Amplitude(액션) 목적지를 통해 세그먼트를 사용하는 경우 세그먼트 플러그인을 선택합니다.

시작하기 전에

세션 리플레이 독립형 SDK를 사용하려면 다음이 필요합니다.

1. 애플리케이션은 iOS 또는 iPadOS에서 실행됩니다.
2. 타임스탬프 또는 SDK에 전달할 수 있는 사용자 지정 문자열 세션 ID를 사용하여 세션을 추적합니다. 세션 식별자가 변경될 때마다 SDK에 이를 알립니다.
3. SDK에 장치 ID를 제공할 수 있습니다.
4. 독립형 SDK에 전달하는 Session ID 및 Device ID는 Amplitude에 이벤트 속성으로 전송되는 항목과 일치합니다.

독립형 SDK는 세션 관리를 제공하지 않습니다. 애플리케이션 또는 타사 연동 기능은 Session ID 및 Device ID에 대한 변경 사항을 적용하여 SDK를 업데이트해야 합니다.

지원되는 iOS 버전

세션 리플레이는 iOS 13 이상을 지원합니다.

빠른 시작

최신 버전의 세션 리플레이를 프로젝트 종속성에 추가합니다.

dependencies: [
    .package(url: "https://github.com/amplitude/AmplitudeSessionReplay-iOS", from: "0.17.0")
]

.product(name: "AmplitudeSessionReplay", package: "AmplitudeSessionReplay")

애플리케이션 코드를 구성합니다.

1. SessionReplay 인스턴스를 생성합니다. API 키와 세션 식별자 및 장치 식별자를 전달합니다(사용 가능한 경우).
2. 리플레이 캡처를 시작하려면 sessionReplay.start()을(를) 호출하십시오. 독립형 SDK는 자동으로 캡처를 시작하지 않으므로 장치 및 세션 식별자를 설정한 후 start()를 호출해야 합니다.
3. 세션 식별자 또는 기기 식별자가 변경되면 새 값을 각각 sessionReplay.sessionId 또는 sessionReplay.deviceId를 사용하여 Amplitude에 전달하십시오. 문자열 세션 ID의 경우 sessionReplay.customSessionId을 대신 사용하십시오. 사용자 지정 세션 ID를 참조하십시오.
4. sessionReplay.additionalEventProperties를 사용하여 다른 이벤트 속성과 함께 전송할 세션 리플레이 속성을 수집합니다.

import AmplitudeSessionReplay
import ThirdPartyAnalytics
// Initialize the standalone session replay SDK
let sessionReplay = SessionReplay(apiKey: amplitude.apiKey,
                                     deviceId: DEVICE_ID,
                                     sessionId: SESSION_ID,
                                     sampleRate: 0.1)
// Start capturing replays. The standalone SDK doesn't start automatically.
sessionReplay.start()
// Track an event
// Get session replay properties for this session
var eventProperties = event.eventProperties ?? [:]
eventProperties.merge(sessionReplay.additionalEventProperties) { (current, _) in current }
event.eventProperties = eventProperties
ThirdPartyAnalytics.track(event)
// Handle session ID changes
// Whenever the session ID changes
ThirdPartyAnalytics.setSessionId(sessionId)
// Update the session ID in session replay
sessionReplay.sessionId = ThirdPartyAnalytics.getSessionId()
// Handle device ID changes
// Whenever the device ID changes
ThirdPartyAnalytics.setDeviceId(deviceId)
// Update the device ID in session replay
sessionReplay.deviceId = ThirdPartyAnalytics.getDeviceId()

구성

세션 리플레이 SDK를 초기화할 때 다음 구성 옵션을 전달하십시오.

사용자 지정 세션 ID

iOS 버전 0.11.2 이상용 세션 리플레이는 customSessionId속성을 통해 문자열 세션 ID(예: UUID)를 지원합니다. 프로젝트에서 타임스탬프 기반 session_id 대신 사용자 지정 이벤트 속성을 사용하여 세션을 정의하는 경우 사용자 지정 세션 ID를 사용하십시오.

초기화기는 숫자 sessionId만 허용합니다. 문자열 값을 사용하려면 인스턴스를 생성한 후 인스턴스에 customSessionId를 설정하고, 사용자 정의 세션이 변경될 때마다 이를 업데이트하십시오.

let sessionReplay = SessionReplay(apiKey: API_KEY,
                                     deviceId: DEVICE_ID,
                                     sampleRate: 0.1)
// Set a string session ID instead of the numeric sessionId
sessionReplay.customSessionId = "ef197fc7-a46f-4e6c-a77f-8d90c17065c0"
sessionReplay.start()
// Whenever your custom session changes
sessionReplay.customSessionId = ThirdPartyAnalytics.getCustomSessionId()

sessionId 및 customSessionId은 동일한 기본 값에 대한 두 개의 뷰이며, SDK는 이를 문자열로 저장합니다.

• sessionId 설정을 사용하면 현재 사용자 지정 세션 ID가 숫자 값으로 바뀝니다. 사용자 지정 세션 ID를 사용할 때는 세션이 변경될 때마다 sessionId 대신 customSessionId를 업데이트하십시오.
• 저장된 값이 숫자가 아닌 경우 이 sessionId 속성은 -1을 반환합니다. 현재 값을 얻으려면 customSessionId를 읽으십시오.
• 다른 값을 설정하면 현재 재생이 종료되고 새 재생이 시작됩니다.

세션 리플레이가 사용자 정의 세션을 안정적으로 일치시키려면 사용자 정의 세션 ID가 다음 제약 조건을 따라야 합니다.

• 이 값은 /을 포함할 수 없습니다. 세션 리플레이는 /을 세션 리플레이 ID의 구분 기호로 사용하며, 형식은 <deviceId>/<sessionId>입니다.
• 값에는 a-z A-Z 0-9 _ - . | @ : = 문자만 포함할 수 있습니다.
• 이 값은 이벤트에 대해 Amplitude로 전송하는 세션 정의 속성과 일치해야 합니다. 자세한 내용은 세션 일치를 참조하십시오.

런타임 시 마스킹 변경

앱이 실행되는 동안 자동 마스킹 수준을 변경하려면 privacyConfig를 설정하세요.

sessionReplay.privacyConfig = PrivacyConfig(maskLevel: .conservative)

원격 구성에서 마스킹 수준을 제공하는 경우 해당 수준이 우선합니다. SDK는 로컬 privacyConfig 값을 유지하며 원격 구성에서 마스킹 수준을 제공하지 않거나 원격 구성을 비활성화할 때 이 값을 적용합니다.

원격 구성

Amplitude에서 샘플링 비율과 마스크 수준을 설정할 수 있도록 원격 구성을 활성화합니다.

화면상의 데이터 차단

세션 리플레이는 화면에 표시되는 민감한 데이터를 차단하는 세 가지 방법을 지원합니다. WebView에 대한 마스킹 설정은 웹 뷰 지원 섹션에서 확인하실 수 있습니다.

마스크 수준

iOS용 세션 리플레이는 maskLevel 옵션을 사용하여 구성할 수 있는 세 가지 수준의 마스킹을 지원합니다.

이 옵션은 세션 리플레이 설정에서 사용하십시오.

UIKit의 개인정보 보호 방법

세션 리플레이는 UIView에서 개인정보 보호 기능을 관리하기 위한 확장 기능을 제공합니다. 사용하려면 세션 리플레이 라이브러리를 가져오십시오.

import AmplitudeSessionReplay

SwiftUI의 개인정보 보호 수정자

세션 리플레이는 개인정보 보호를 관리하기 위한 View 확장 기능을 제공합니다. 세션 리플레이 라이브러리를 가져와서 액세스 하세요.

import AmplitudeSessionReplay

사용자 옵트아웃

세션 리플레이는 옵트아웃 구성 옵션을 제공합니다. 초기화 중에 optOut: true를 전달하면 Amplitude가 세션 리플레이를 수집하지 못하게 됩니다. 예를 들면 다음과 같습니다.

// Pass a boolean value to indicate a user's opt-out status
        let sessionReplay = SessionReplay(apiKey: API_KEY,
                                             optOut: true,
                                             /* other session replay options */)

EU 데이터 레지던시

세션 리플레이는 EU 데이터 센터를 사용하는 Amplitude 고객이 이용할 수 있습니다. 초기화할 때 serverZone 구성 옵션을 EU로 설정하십시오. 예를 들어:

// Set serverZone to EU
let sessionReplay = SessionReplay(apiKey: API_KEY,
                                     serverZone: .EU,
                                     /* other session replay options */)

샘플링 비율

기본적으로 세션 리플레이는 세션의 0%를 수집하도록 설정되어 있습니다. SDK의 sampleRate 구성 옵션을 사용하여 캡처할 세션의 비율을 설정합니다.

수동 및 동적 샘플링, 할당량 계획 및 할당량 계산에 대한 자세한 내용은 세션 리플레이 샘플링 구성을 참조하세요.

// This configuration samples 1% of all sessions
let sessionReplay = SessionReplay(apiKey: API_KEY,
                                     sampleRate: 0.01,
                                     /* other session replay options */)

레코딩 품질

재생 충실도와 성능 및 저장 공간의 균형을 맞추기 위해 품질 프로파일을 선택하십시오. 프로파일이 낮을수록 캡처 프레임 속도와 이미지 해상도가 낮아집니다. 프로파일이 높을수록 프레임 속도와 해상도가 높아집니다. SDK가 장치에 따라 프로파일을 선택하도록 허용하는 데 사용합니다(예: 최신 장치에서는 높음, 이전 장치에서는 낮음)QualityProfile.automatic.

// Use automatic profile selection based on device
let sessionReplay = SessionReplay(apiKey: API_KEY,
                                     deviceId: DEVICE_ID,
                                     sessionId: SESSION_ID,
                                     quality: .automatic,
                                     /* other session replay options */)
// Or set a fixed profile (low, medium, or high)
let sessionReplay = SessionReplay(apiKey: API_KEY,
                                     deviceId: DEVICE_ID,
                                     sessionId: SESSION_ID,
                                     quality: .medium,
                                     /* other session replay options */)

또한 기존 독립 실행형 인스턴스의 프로파일을 변경할 수 있습니다.

sessionReplay.quality = .medium

사용량이 부과되는 네트워크에서 업로드 비활성화

기기가 종량제 네트워크를 사용하는 동안 세션 리플레이 업로드를 일시 중지하여 사용자의 셀룰러 데이터 사용을 방지하십시오. 세션 리플레이는 여전히 데이터를 로컬로 기록합니다. 기기가 Wi-Fi 또는 다른 종량제 제한이 없는 연결에 다시 연결되면 업로드가 재개됩니다.

let sessionReplay = SessionReplay(apiKey: API_KEY,
                                     deviceId: DEVICE_ID,
                                     sessionId: SESSION_ID,
                                     uploadConfig: UploadConfig(disableMeteredUploads: true),
                                     /* other session replay options */)

리플레이 수집 비활성화

세션 리플레이를 활성화한 후에는 다음 중 하나가 될 때까지 앱에서 실행됩니다.

• 사용자가 앱을 떠납니다.
• sessionReplay.stop()을(를) 호출하십시오.

사용자가 앱의 제한된 영역으로 이동하기 전에 호출하여 사용자가 해당 영역에 있는 동안 재생 수집을 비활성화하십시오sessionReplay.stop().

사용자가 앱의 제한되지 않은 영역으로 돌아왔을 때 리플레이 수집을 다시 활성화하려면 sessionReplay.start()을(를) 호출하십시오.start() 및 stop()가 동일한 인스턴스에서 캡처를 재개하고 일시 중지하므로, 화면 전환 시 이를 호출하여 선택한 화면만 기록할 수 있습니다.

기록된 데이터 플러시

flush()를 호출하여 독립 실행형 SDK가 기록된 리플레이 데이터를 플러시하도록 요청하세요. 이 기능은 호스트 분석 클라이언트가 플러시되고 세션 리플레이를 동일한 지점에서 플러시하려는 경우에 유용합니다.

sessionReplay.flush()

또한 Amplitude 실험과 같은 기능 플래그 제품을 사용하여 위치와 같은 기준에 따라 리플레이 수집을 활성화하거나 비활성화하는 로직을 만들 수도 있습니다. 예를 들어, 특정 사용자 그룹을 대상으로 하는 기능 플래그를 생성하고 이를 초기화 논리에 추가합니다.

import AmplitudeSessionReplay
import ThirdPartyAnalytics
let sessionReplay = SessionReplay(apiKey: amplitude.apiKey,
                                     deviceId: DEVICE_ID,
                                     sessionId: SESSION_ID,
                                     sampleRate: 1.0)
if (nonEUCountryFlagEnabled) {
    sessionReplay.start()
}

Web view 지원 (베타)

기본적으로 세션 리플레이는 캡처에서 웹 뷰를 차단합니다. 모든 WebView 구성 요소의 캡처를 활성화하려면 세션 리플레이 구성에서 captureWebViews를 true로 설정하십시오.

특정 WebView 구성 요소를 마스크하려면 화면 데이터 차단에 설명된 개인정보 보호 방법을 사용하십시오.

// UIKit
webView.amp_isBlocked = false

지도 보기 지원 (알파)

세션 리플레이는 iOS 애플리케이션에서 지도 보기 캡처를 지원합니다. 지도 보기 캡처를 활성화하려면 구현에서 지도 보기의 마스킹을 해제하십시오.

// UIKit
mapView.amp_isBlocked = false
// SwiftUI
Map().amp_setBlocked(false)

로그 기록

세션 리플레이는 iOS 애플리케이션에서 로그 기록을 지원합니다. 연동 초기화 시 recordLogOptions를 사용하여 제한을 설정한 다음 recordLog(level:message:date:)를 통해 로그 메시지를 전송하십시오.

import AmplitudeSessionReplay
let sessionReplay = SessionReplay(
    apiKey: API_KEY,
    recordLogOptions: .init(logCountThreshold: 2000, maxMessageLength: 4000)
)
sessionReplay.recordLog(level: .error, message: "This is an error log")

로그 시스템을 구현한 경우 한 곳만 수정하여 로그 기록 기능을 통합할 수 있습니다. 자세한 내용은 다음 예제를 참조하십시오.

CocoaLumberjack

CocoaLumberjack을 사용하는 경우 사용자 지정 로거 공급자와 통합할 수 있습니다.

class AmplitudeLogRecordLogger: DDAbstractLogger {
    private weak var plugin: SessionReplayPlugin?
    init(_ plugin: SessionReplayPlugin) {
        self.plugin = plugin
    }
    override func log(message logMessage: DDLogMessage) {
        let recordLevel: RecordLogLevel
        switch logMessage.flag {
        case .error:
            recordLevel = .error
        case .warning:
            recordLevel = .warn
        case .info:
            recordLevel = .log
        default:
            return
        }
        plugin?.recordLog(level: recordLevel,
                          message: logMessage.message,
                          date: logMessage.timestamp)
    }
}
let sessionReplayPlugin = AmplitudeSwiftSessionReplayPlugin()
amplitude.add(plugin: sessionReplayPlugin)
DDLog.add(AmplitudeLogRecordLogger(sessionReplayPlugin))

React Native

console 로그나 react-native-logs를 consoleTransport와 함께 사용한다면 이를 RCTAddLogFunction과 통합할 수 있습니다.

RCTAddLogFunction { level, source, fileName, lineNumber, message in
  let recordLevel: RecordLogLevel
  switch level {
  case .error:
    recordLevel = .error
  case .warning:
    recordLevel = .warn
  case .info:
    recordLevel = .log
  case .fatal:
    recordLevel = .error
  case .trace:
    recordLevel = .init("trace")
  default:
    return
  }
  self.sessionReplayPlugin.recordLog(level: recordLevel, message: message)
}

데이터 리텐션, 삭제 및 개인정보 보호

캡처를 구현할 때 동의 지침을 검토하십시오.

보관 기간

네이티브 및 Flutter SDK 보관 지침과 변경 시점에 대해서는 세션 리플레이 데이터 생애주기 분석 참조를 참조하세요.

DSAR API

DSAR API에서 반환된 리플레이 메타데이터에 대한 자세한 내용은 세션 리플레이 DSAR 메타데이터를 참조하세요.

데이터 삭제

사용자 및 프로젝트 삭제 동작에 대해서는 세션 리플레이 데이터 삭제를 참조하세요.

봇 필터

봇 필터링 및 속성 필터 제한에 대해서는 세션 리플레이 봇 필터링을 참조하세요.

세션 리플레이 저장 공간

사용자가 앱에서 추적을 거부하는 경우 optOut 구성 옵션을 사용하여 해당 사용자에 대한 리플레이 수집을 비활성화하십시오.

세션 리플레이 기능은 리플레이 데이터를 업로드하기 전에 파일 시스템에 임시로 저장합니다. 모든 초기화 시, 가장 오래된 리플레이 항목들을 트리밍하여 총 디스크 사용량을 최대 크기 이하로 줄입니다.

알려진 제한 사항

세션 리플레이 구현 시 다음 제한 사항을 염두에 두십시오.

• 세션 리플레이는 여러 프로젝트에 걸쳐 있는 동일 사용자의 리플레이를 하나로 연결하여 재생하지 않습니다. 예를 들어:

  • 여러 앱을 별도의 Amplitude 프로젝트로 계측할 수 있으며 각 프로젝트에서 세션 리플레이 기능이 활성화되어 있습니다.
  • 식별된 사용자는 한 앱에서 시작한 다음 다른 앱으로 전환합니다.
  • Amplitude는 두 세션을 모두 캡처합니다.
  • 각 세션의 리플레이는 해당 호스트 프로젝트에서 볼 수 있습니다.

• 조직에서 사용자 세션 정의를 사용하는 경우 사용자 세션 차트에는 세션 리플레이가 표시되지 않습니다.

• 세션 리플레이 기능은 다음과 같은 iOS 뷰를 캡처할 수 없습니다.

  • SFSafariViewController와 같은 별도 프로세스에서 실행되는 iOS 뷰
  • AVPlayerLayer 기반 뷰

문제 해결

개별 상태 및 오류에 대한 자세한 내용은 세션 리플레이 수집 모니터링을 참조하십시오.

다중 Amplitude 인스턴스

세션 리플레이 기능은 Amplitude SDK 단일 인스턴스에 연결할 수 있도록 지원합니다. 애플리케이션에 인스턴스가 둘 이상 있는 경우 프로젝트와 가장 관련성이 높은 인스턴스에서 세션 리플레이를 시작해야 합니다.

리플레이 길이와 세션 길이가 일치하지 않습니다.

일부 시나리오에서는 리플레이 시간이 [Amplitude] Start Session과 [Amplitude] End Session 이벤트 사이의 시간을 초과할 수 있습니다. 이는 사용자가 [Amplitude] End Session로 종료하였으나, iOS SDK와 세션 리플레이 미들웨어가 해당 이벤트를 처리하기 전에 앱이 종료될 때 발생합니다. 사용자가 앱을 다시 사용하면 SDK 및 미들웨어가 해당 이벤트를 처리하여 리플레이와 함께 Amplitude로 전송합니다. End Session Client Event Time과 Client Upload Time에 차이가 발생하는 경우에 이 시나리오가 발생했는지 확인할 수 있습니다.

Amplitude에서 세션 리플레이가 표시되지 않음

세션 리플레이는 다음과 같은 이유로 Amplitude에 표시되지 않을 수 있습니다.

• 연결성 부족
• 현재 세션에서 iOS SDK를 통해 트리거된 이벤트가 없습니다.
• 샘플링

연결성 부족

앱이 인터넷에 액세스할 수 있는지 확인한 후 다시 시도하십시오.

현재 세션에서 iOS SDK를 통해 트리거된 이벤트가 없습니다.

세션 리플레이 기능을 사용하려면 사용자 세션의 이벤트 중 하나 이상에 [Amplitude] Session Replay ID 속성이 있어야 합니다. Amplitude 이외의 분석 공급자를 통해 이벤트를 계측하는 경우 iOS SDK는 이 속성을 포함하지 않는 기본 세션 시작 및 세션 종료 이벤트만 전송할 수 있습니다.

로컬 테스트의 경우 세션 시작 이벤트를 강제로 실행하여 세션 리플레이 기능이 작동하도록 할 수 있습니다.

1. Amplitude의 사용자 조회 이벤트 스트림에서 [Amplitude] Session Replay ID 속성을 포함하는 세션 시작 이벤트를 확인하실 수 있습니다. 처리가 완료되면 해당 세션에 '세션 재생' 버튼이 표시됩니다.

샘플링

위에서 언급했듯이 세션 리플레이 시 기본 sampleRate는 0입니다. 비율을 더 높은 숫자로 업데이트하십시오. 자세한 내용은 샘플링 속도를 참조하십시오.

일부 세션에는 세션 리플레이 ID 속성이 포함되어 있지 않습니다.

세션 리플레이를 사용하기 위해 세션의 모든 이벤트에 [Amplitude] Session Replay ID 속성이 있어야 하는 것은 아니며, 세션의 한 이벤트에만 해당 속성이 있으면 됩니다. 이벤트에 [Amplitude] Session Replay ID가 나타나지 않을 수 있는 이유는 다음과 같습니다.

• 사용자가 수집을 거부했거나 현재 sampleRate 설정에 따라 해당 세션이 샘플링 대상에 포함되지 않았을 수 있습니다. sampleRate를 늘리면 더 많은 세션이 캡처됩니다.
• Amplitude 이벤트는 여전히 공급자를 통해 전송될 수 있지만 additionalEventProperties는 [Amplitude] Session Replay ID 속성을 반환하지 않습니다. 이는 optOut 및 sampleRate 구성 설정으로 인해 발생할 수 있습니다. optOut 및 sampleRate가 세션을 포함하도록 설정되어 있는지 확인하십시오.

세션 리플레이 처리 오류

일반적으로 리플레이는 수집 후 몇 분 이내에 사용할 수 있어야 합니다. 지연 또는 오류는 다음 중 하나 이상으로 인해 발생할 수 있습니다.

• API 키 또는 기기 ID가 일치하지 않습니다. 이 문제는 세션 리플레이 및 표준 이벤트 계측이 서로 다른 API 키 또는 기기 ID를 사용하는 경우 발생할 수 있습니다.
• 세션 리플레이가 잘못된 프로젝트를 참조합니다.
• 짧은 세션. 사용자가 초기화 후 몇 초 이내에 바운스하면 SDK가 리플레이 데이터를 업로드할 시간이 없을 수 있습니다.
• 설정된 리텐션 기간(기본값: 90일)이 지난 리플레이.

문제 리포트

위 문제 해결 가이드에서 다루지 않은 세션 리플레이 관련 문제가 발생하면 GitHub 저장소에 보고해 주세요.

문제를 생성할 때는 다음을 포함하십시오:

• 문제에 대한 명확한 설명
• 문제를 재현하기 위한 단계
• 예상 동작 vs 실제 동작
• 사용 중인 SDK 버전
• 관련된 모든 오류 메시지 또는 로그