세션 리플레이 iOS 세그먼트 연동
이 문서에서는 세션 리플레이 iOS 세그먼트 플러그인을 사용하여 세션 리플레이를 설치하는 방법에 대해 설명합니다. 앱이 세그먼트의 Analytics-Swift 라이브러리와 Amplitude(동작) 목적지를 사용하는 경우 이 옵션을 사용하십시오.
앱에서 Amplitude iOS SDK를 사용하는 경우, 세션 리플레이 iOS SDK 플러그인을 사용하십시오.
세그먼트를 다른 옵션과 함께 사용하는 경우 독립형 구현을 선택합니다.
세션 리플레이 및 성능
Amplitude는 설치된 iOS 앱의 성능에 미치는 영향을 최소화하기 위해 다음과 같은 방법으로 세션 리플레이를 구축했습니다.
- 기본 사용자 인터페이스 스레드가 차단되지 않도록 리플레이 데이터를 비동기적으로 처리합니다. 뷰 계층 구조와 상호작용하려면 메인 스레드를 사용해야 하지만, 모든 처리는 백그라운드 큐에서 수행됩니다.
- 배치 및 경량 압축을 사용하여 네트워크 연결 횟수와 대역폭을 줄입니다.
- 뷰 계층 구조 처리 최적화. 계층 구조 처리에 문제가 발생하면 Amplitude에 문의하십시오.
세션 리플레이는 앱의 뷰 트리(기본 뷰와 모든 하위 뷰)에 대한 변경 사항을 재귀적으로 캡처합니다. 그런 다음 세션 리플레이는 이러한 변경 사항을 재생하여 비디오와 유사한 재생을 구성합니다. 세션이 시작될 때 세션 리플레이는 앱의 뷰 트리의 전체 스냅샷을 캡처합니다. 사용자가 앱과 상호작용할 때 세션 리플레이는 각 변경 사항을 차이로 캡처합니다. 재생을 시청할 때 세션 리플레이는 각 차이를 순차적으로 원본 뷰 트리에 다시 적용합니다. 세션 리플레이에는 최대 길이가 없습니다.
문제 리포트
iOS용 세션 리플레이와 관련된 문제를 리포트하려면 AmplitudeSessionReplay-ios GitHub 저장소로 이동하십시오.
시작하기 전에
세션 리플레이 iOS Segment Plugin을 사용하려면 다음이 필요합니다.
- 애플리케이션은 iOS 또는 iPadOS에서 실행됩니다.
- 수집을 위해 Segment의 Analytics-Swift 라이브러리를 사용합니다.
- Segment의 Amplitude (Actions) 목적지를 사용합니다.
- Segment의 Amplitude 플러그인을 사용합니다.
지원되는 iOS 버전
세션 리플레이는 최소 iOS 13 버전을 지원합니다.
빠른 시작
최신 버전의 플러그인을 프로젝트 종속성에 추가합니다.
Segment 플러그인은 Swift 패키지 관리자를 통해서만 사용할 수 있습니다. 세션 리플레이를 Package.swift 파일 또는 Xcode의 패키지 목록에 종속성으로 추가하십시오.
dependencies: [
.package(url: "https://github.com/amplitude/AmplitudeSessionReplay-iOS", from: "0.20.0")
]
Analytics-Swift와 통합하려면 AmplitudeSegmentSessionReplayPlugin 타겟을 사용하십시오.
.product(name: "AmplitudeSegmentSessionReplayPlugin", package: "AmplitudeSessionReplay")
애플리케이션 코드를 구성합니다.
import AmplitudeSegmentSessionReplayPlugin
import Segment
import SegmentAmplitude
// Initialize Segment
let analytics = Analytics(configuration: config)
// Ensure Segment's AmplitudeSession plugin is added before AmplitudeSegmentSessionReplayPlugin
analytics.add(plugin: AmplitudeSession())
// Initialize AmplitudeSegmentSessionReplayPlugin with your Amplitude API key
analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
sampleRate: 0.1))
구성
세션 리플레이 플러그인을 초기화할 때 다음 옵션을 전달하십시오.
| 이름 | 유형 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
amplitudeApiKey | String | 예 | 해당 없음 | Amplitude API 키를 설정합니다. Segment 플러그인은 Amplitude로 재생을 전송하려면 이 값을 필요로 합니다. |
sampleRate | Float | 아니요 | 0 | 이 옵션을 사용하여 리플레이 수집을 위해 선택할 세션 수를 제어합니다. 숫자는 0과 1 사이의 소수(예: 0.4)여야 하며, 이는 리플레이 수집을 위해 무작위로 선택할 세션의 비율을 나타냅니다. 많은 수의 세션에 대해 0.4은(는) 해당 세션 중 40%를 선택합니다. |
serverZone | ServerZone | 아니요 | .US | EU 또는 US. Amplitude 서버 영역을 설정합니다. EU 데이터 센터에서 생성된 Amplitude 프로젝트의 경우 이 값을 EU로 설정합니다. |
enableRemoteConfig | Bool | 아니요 | true | 이 세션 리플레이 인스턴스에 대한 원격 구성을 활성화하거나 비활성화합니다. |
autoStart | Bool | 아니요 | true | 세션 리플레이가 초기화될 때 자동으로 캡처를 시작할지 여부를 제어합니다. |
maskLevel | MaskLevel | 아니요 | .medium | 세션 리플레이가 화면상의 콘텐츠를 얼마나 많이 마스킹할지 설정합니다. .light, .medium 또는 .conservative을 사용하십시오. 자세한 내용은 마스크 수준을 참조하십시오. |
captureWebViews | Bool | 아니요 | false | 웹 보기 콘텐츠를 캡처할 수 있습니다. 기본적으로 세션 리플레이는 웹 뷰를 차단합니다. |
webviewMappings | [String: String] | 아니요 | [:] | 캡처된 웹 뷰 콘텐츠의 하위 문자열을 대체 값에 매핑합니다. captureWebViews을 활성화하면 세션 리플레이는 업로드하기 전에 웹 뷰 기록 데이터에 각 항목을 대소문자를 구분하지 않는 검색 및 바꾸기로 적용합니다. 이것은 고급옵션입니다. 대부분의 앱은 비워 둡니다. |
recordLogOptions.logCountThreshold | Int | 아니요 | 1000 | 이 옵션을 사용하여 세션당 최대 로그 수를 구성합니다. |
recordLogOptions.maxMessageLength | Int | 아니요 | 2000 | 이 옵션을 사용하여 로그 메시지의 최대 길이를 구성합니다. |
quality | QualityProfile | 아니요 | .high | 캡처 및 인코딩 품질(예: 프레임 속도 및 이미지 해상도)을 제어합니다. .low, .medium 또는 .high을 사용하여 재생 충실도와 성능 및 저장 용량의 균형을 맞출 수 있습니다. SDK가 장치에 따라 프로파일을 선택하도록 하려면 QualityProfile.automatic를 사용합니다. |
uploadConfig | UploadConfig | 아니요 | UploadConfig() | 세션 리플레이가 데이터를 업로드하는 시기와 위치를 제어합니다. 종량제 네트워크(예: 셀룰러)에서 업로드를 일시 중지하려면 UploadConfig(disableMeteredUploads: true)을(를) 사용하십시오. UploadConfig(serverUrl:)을(를) 사용하여 업로드를 프록시(버전 0.14.0 이상)로 전송하십시오. |
원격 구성
원격 구성을 활성화하여 Amplitude에서 샘플 속도 및 마스킹 수준을 설정합니다.
원격 구성 및 테스트
원격 구성을 활성화하면 Amplitude에서 정의한 설정이 SDK에서 로컬로 정의한 설정보다 우선합니다. 따라서 애플리케이션을 테스트하는 동안 원격 구성을 비활성화하여 sampleRate을(를) 1(으)로 설정할 수 있도록 하고, 테스트 세션을 캡처해야 합니다.
화면에 표시되는 데이터 차단
세션 리플레이는 화면에 표시되는 민감한 데이터를 차단하는 세 가지 방법을 지원합니다. WebViews에 대한 마스킹 설정은 웹 뷰 지원 섹션에 있습니다.
마스크 수준
iOS용 세션 리플레이는 세 가지 수준의 마스킹을 지원하며, maskLevel 옵션을 사용하여 구성할 수 있습니다.
세션 리플레이 구성에서 이 옵션을 사용하십시오.
| 마스크 수준 | 설명 |
|---|---|
light | 모든 암호, 이메일 주소, 신용카드 번호 및 전화번호를 마스킹합니다. |
medium | 모든 편집 가능한 텍스트 뷰를 마스킹합니다. |
conservative | 모든 텍스트 뷰를 마스킹합니다. |
UIKit의 개인정보 보호 메서드
세션 리플레이는 개인정보 보호를 관리하기 위한 UIView 확장 프로그램을 제공합니다. 세션 리플레이 라이브러리를 가져와 액세스합니다.
import AmplitudeSessionReplay
| 변수 | 설명 |
|---|---|
amp_isBlocked | 세션 리플레이에서 뷰와 해당 하위 뷰를 선택적으로 자리 표시자로 대체하려면 view.amp_isBlocked을(를) 설정합니다. UITextViews 및 UITextFields는 자동으로 차단됩니다. 기본적으로 마스킹된 뷰의 차단을 해제하려면 이 값을 false로 설정하십시오. |
SwiftUI용 개인정보 보호 수정자
세션 리플레이는 개인정보 보호를 관리하기 위한 View 확장 프로그램을 제공합니다. 세션 리플레이 라이브러리를 가져와서 액세스합니다.
import AmplitudeSessionReplay
| 수정자 | 설명 |
|---|---|
amp_setBlocked(_ blocked: Bool) | 세션 리플레이에서 뷰와 해당 하위 뷰를 선택적으로 플레이스홀더로 대체하려면 amp_setBlocked() 수정자를 View에 추가하십시오. 기본적으로 마스킹된 뷰의 차단을 해제하려면 이 값을 false로 설정하십시오. |
사용자 옵트아웃
사용자가 세션 리플레이를 거부했음을 나타내려면 플러그인에 optOut을 설정하십시오.
// Pass a boolean value to indicate a users opt-out status
amplitudeSegmentSessionReplayPlugin.optOut = true
EU 데이터 상주
세션 리플레이는 EU 데이터 센터를 사용하는 Amplitude 고객에게 제공됩니다. 초기화 중에 serverZone 구성 옵션을 EU(으)로 설정하십시오. 예를 들면 다음과 같습니다.
// Set serverZone on the AmplitudeSegmentSessionReplayPlugin
let plugin = AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
sampleRate: 0.1,
serverZone: .EU)
샘플링 속도
기본적으로 세션 리플레이는 재생을 위해 세션의 0%를 캡처합니다. SDK의 sampleRate 구성 옵션을 사용하여 캡처할 세션의 비율을 설정합니다.
수동 및 동적 샘플링, 할당량 계획 및 할당량 계정에 대해서는 세션 리플레이 샘플링 구성으로 이동하십시오.
// This configuration samples 1% of all sessions
analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
sampleRate: 0.01))
레코딩 품질
재생 충실도와 성능 및 저장 공간의 균형을 맞추기 위해 품질 프로파일을 선택하십시오. 프로파일이 낮을수록 캡처 프레임 속도가 낮고 이미지 해상도가 낮습니다. 프로파일이 높을수록 프레임 속도가 높고 해상도가 높아집니다. SDK가 장치에 따라 프로파일을 선택하도록 허용하려면 QualityProfile.automatic 를 사용합니다. 예를 들어 SDK는 최신 기기에서는 높음을 선택하고 이전 기기에서는 낮음을 선택합니다.
// Use automatic profile selection based on device
analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
sampleRate: 0.1,
quality: .automatic))
// Or set a fixed profile (low, medium, or high)
analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
sampleRate: 0.1,
quality: .medium))
사용량이 부과되는 네트워크에서 업로드 비활성화
기기가 종량제 네트워크를 사용하는 동안 세션 리플레이 업로드를 일시 중지하여 사용자의 셀룰러 데이터 사용을 방지하십시오. 세션 리플레이는 여전히 데이터를 로컬로 기록합니다. 기기가 Wi-Fi 또는 다른 종량제 제한이 없는 연결에 다시 연결되면 업로드가 재개됩니다.
analytics.add(plugin: AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
sampleRate: 0.1,
uploadConfig: UploadConfig(disableMeteredUploads: true)))
리플레이 수집 비활성화
세션 리플레이를 활성화한 후에는 다음 중 하나가 될 때까지 앱에서 실행됩니다.
- 사용자가 앱을 떠납니다.
amplitudeSegmentSessionReplayPlugin.stop()을(를) 호출하십시오.analytics.remove(plugin: amplitudeSegmentSessionReplayPlugin)를 사용하여 세그먼트에서 플러그인을 제거합니다.
사용자가 앱의 제한된 영역으로 이동하기 전에 호출하여 사용자가 해당 영역에 있는 동안 재생 수집을 비활성화하십시오amplitudeSegmentSessionReplayPlugin.stop().
참조를 유지하십시오
SessionReplayPlugin 인스턴스에 대한 참조를 유지하십시오: let amplitudeSegmentSessionReplayPlugin = AmplitudeSegmentSessionReplayPlugin(/* session replay options */).
사용자가 앱의 제한되지 않은 영역으로 돌아왔을 때 재생 수집을 다시 활성화하려면 amplitudeSegmentSessionReplayPlugin.start()를 호출하십시오.
특정 화면만 캡처하려면 플러그인이 시작될 때 시작되지 않도록 autoStart: false를 사용하여 초기화한 다음, 사용자가 해당 화면에 들어오거나 나갈 때 start() 및 stop()를 호출하십시오.
// Add the plugin once, without starting capture
let amplitudeSegmentSessionReplayPlugin = AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY,
sampleRate: 1.0,
autoStart: false)
analytics.add(plugin: amplitudeSegmentSessionReplayPlugin)
// Start capture when the user enters a screen you want to record
amplitudeSegmentSessionReplayPlugin.start()
// Stop capture when the user leaves that screen
amplitudeSegmentSessionReplayPlugin.stop()
또한 Amplitude 실험과 같은 기능 플래그 제품을 사용하여 위치와 같은 기준에 따라 리플레이 수집을 활성화하거나 비활성화하는 로직을 만들 수도 있습니다. 예를 들어, 특정 사용자 그룹을 대상으로 하는 기능 플래그를 생성한 다음 해당 플래그를 초기화 논리에 추가합니다.
import AmplitudeSegmentSessionReplayPlugin
import Segment
import SegmentAmplitude
// Your existing initialization logic with Segment
let analytics = Analytics(configuration: config)
analytics.add(plugin: AmplitudeSession())
if (nonEUCountryFlagEnabled) {
// Create and Install Session Replay Plugin
let amplitudeSegmentSessionReplayPlugin = AmplitudeSegmentSessionReplayPlugin(amplitudeApiKey: API_KEY, sampleRate: 0.1)
analytics.add(plugin: amplitudeSegmentSessionReplayPlugin)
}
웹 뷰 지원 (베타)
기본적으로 세션 리플레이는 캡처에서 웹 뷰를 차단합니다. 모든 WebView 구성 요소의 캡처를 활성화하려면 세션 리플레이 구성에서 captureWebViews을(를) true로 설정하십시오.
특정 WebView 구성 요소를 마스크하려면 화면 데이터 차단에 설명된 개인정보 보호 메서드를 사용하십시오.
// UIKit
webView.amp_isBlocked = false
맵 보기 지원(알파)
세션 리플레이는 iOS 애플리케이션에서 맵 뷰를 캡처할 수 있도록 지원합니다. 맵 뷰 캡처를 활성화하려면 구현에서 맵 뷰의 마스킹을 해제하십시오.
// UIKit
mapView.amp_isBlocked = false
// SwiftUI
Map().amp_setBlocked(false)
로그 기록
가용성
AmplitudeSessionReplay 0.8.0 이상부터 로그 기록을 지원합니다.
세션 리플레이는 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 기반의 뷰
이 내용이 도움이 되었나요?
For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.