iOS 세션 리플레이¶
사전 조건¶
SDK 1.6.8 이상 버전은 iOS 15 이상이 필요합니다. 구버전에서 업그레이드할 때는 1.6.8 업그레이드 요구 사항을 확인하세요.
* GuanceSDKRUM 구성을 설정 및 초기화하고 View 모니터링 수집을 활성화했는지 확인하세요.
* iOS Session Replay 버전 지원: SDK.Version >= 1.6.0.
* 구버전에서 SDK 1.6.6 이상으로 업그레이드할 때 Session Replay 제품명이 GuanceSessionReplay로 변경되었으므로 마이그레이션 가이드를 참고하세요.
* 문서 상단 badge에 표시된 정식 릴리스 안정 버전을 우선 사용하는 것이 좋으며, alpha, beta 등 사전 릴리스 버전은 더 이상 사용하지 않는 것이 좋습니다.
- 최신 기능을 사전에 통합하거나 최신 특성을 확인하고 정식 릴리스되지 않은 변경 사항을 추적하려면 GitHub에서 iOS SDK 저장소 및 관련 변경 로그를 확인하세요: GuanceCloud/datakit-ios
구성¶
패키지 관리자에 따라 GuanceSDK 라이브러리의 GuanceSessionReplay 기능 컴포넌트를 프로젝트에 연결하세요:
CocoaPods¶
Swift Package Manager¶
dependencies: [
.package(url: "https://github.com/GuanceCloud/datakit-ios.git",
from: "last_version")
],
targets: [
.target(
name: "YourTarget",
dependencies: [
.product(name: "GuanceSDK", package: "GuanceSDK"),
.product(name: "GuanceSessionReplay", package: "GuanceSDK"), //추가
]),
]
Carthage/Framework¶
SDK 1.6.2 이상 버전에서 지원됩니다
Carthage를 사용하거나 Framework를 수동으로 통합할 때는 기본 SDK 외에도 GuanceSessionReplay 세션 리플레이 컴포넌트를 함께 메인 프로젝트 Target의 Frameworks에 추가해야 합니다.
GuanceSessionReplay는 세션 리플레이 기능 컴포넌트이며 GuanceSDK의 기본 기능에 의존하므로 단독으로 사용할 수 없습니다.
Objective-C 진입점¶
Objective-C import 경로는 통합 방식에 따라 다릅니다:
| 통합 방식 | 권장 진입점 |
|---|---|
| CocoaPods | #import <GuanceSDK/GuanceSessionReplay.h> |
| Swift Package Manager | @import GuanceSessionReplay; |
| Carthage / Framework | #import <GuanceSessionReplay/GuanceSessionReplay.h> |
| 다음 Objective-C 예제는 Swift Package Manager 방식을 기준으로 작성되었습니다. CocoaPods 또는 Carthage / Framework로 통합하는 경우 위 표에 따라 진입점 줄을 바꾸세요. |
코드 호출¶
@import GuanceSessionReplay;
FTSessionReplayConfig *srConfig = [[FTSessionReplayConfig alloc]init];
srConfig.touchPrivacy = FTTouchPrivacyLevelShow;
srConfig.textAndInputPrivacy = FTTextAndInputPrivacyLevelMaskSensitiveInputs;
srConfig.imagePrivacy = FTImagePrivacyLevelMaskNonBundledOnly;
// SwiftUI 페이지를 수집하려면 SDK 1.6.5 이상 버전에서 활성화할 수 있습니다
srConfig.enableSwiftUI = YES;
// Session Replay 히트맵 연관을 활성화하려면 SDK 1.6.6 이상 버전에서 활성화할 수 있습니다
srConfig.enableHeatmap = YES;
srConfig.sessionReplaySamplingRate = 100; // SDK 1.6.8부터 지원
[[FTRumSessionReplay sharedInstance] startWithSessionReplayConfig:srConfig];
let srConfig = FTSessionReplayConfig.init()
srConfig.touchPrivacy = .show
srConfig.textAndInputPrivacy = .maskSensitiveInputs
srConfig.imagePrivacy = .maskNonBundledOnly
// SwiftUI 페이지를 수집하려면 SDK 1.6.5 이상 버전에서 활성화할 수 있습니다
srConfig.enableSwiftUI = true
// Session Replay 히트맵 연관을 활성화하려면 SDK 1.6.6 이상 버전에서 활성화할 수 있습니다
srConfig.enableHeatmap = true
srConfig.sessionReplaySamplingRate = 100 // SDK 1.6.8부터 지원
FTRumSessionReplay.shared().start(with: srConfig)
| 속성 | 유형 | 필수 | 의미 |
|---|---|---|---|
| sessionReplaySamplingRate | float | 아니요 | Session Replay 백분율 샘플링 비율, 범위 [0,100], 소수 지원(0.1은 0.1%, 1은 1%), 기본값 100(전체 샘플링). RUM 세션 샘플링을 기반으로 Replay 샘플링을 수행합니다. 기존 원격 필드는 [0,1] 비율을 사용합니다. 원격 샘플링 구성을 참고하세요. SDK 1.6.8부터 지원합니다. |
| sampleRate | int | 아니요 | SDK 1.6.8부터 폐기되었으며 호환성을 위해 유지됩니다. 정수 백분율 샘플링 비율, 범위 [0,100], 기본값 100. sessionReplaySamplingRate 사용을 권장합니다. |
| sessionReplayOnErrorSamplingRate | float | 아니요 | Replay 오류 보충 샘플링 백분율, 범위 [0,100], 소수 지원, 기본값 0; 정상 Replay 샘플링에 포함되지 않은 세션에 사용됩니다. SDK 1.6.8부터 지원합니다. |
| sessionReplayOnErrorSampleRate | int | 아니요 | SDK 1.6.8부터 폐기되었으며 호환성을 위해 유지됩니다. 정수 백분율 오류 보충 샘플링 설정, 범위 [0,100], 기본값 0. sessionReplayOnErrorSamplingRate 사용을 권장합니다. |
| privacy | FTSRPrivacy | 아니요 | Session Replay에서 콘텐츠 마스킹의 프라이버시 수준을 설정합니다. 기본값은 FTSRPrivacyMask입니다.마스킹 처리: 텍스트를 * 또는 #으로 대체합니다. FTSRPrivacyAllow: 민감한 입력 컨트롤을 제외한 텍스트와 입력 내용을 기록하고, 사용자 터치를 표시하며, 모든 이미지를 기록합니다.FTSRPrivacyMaskUserInput: 입력 요소를 마스킹하고 사용자 터치를 숨기며, SF Symbols 및 [UIImage imageNamed:] / UIImage(named:)로 로드되고 App과 함께 번들된 이미지만 기록합니다.FTSRPrivacyMask: 모든 텍스트, 입력, 터치 및 이미지를 마스킹합니다.곧 폐기될 예정이며 호환성을 위해 사용할 수 있습니다. touchPrivacy, textAndInputPrivacy, imagePrivacy를 사용하여 세분화된 마스킹 프라이버시 수준을 설정하는 것을 우선 권장합니다 |
| touchPrivacy | FTTouchPrivacyLevel | 아니요 | 세션 리플레이에서 터치 마스킹에 사용할 수 있는 프라이버시 수준입니다. 기본값은 FTTouchPrivacyLevelHide입니다.FTTouchPrivacyLevelShow: 모든 사용자 터치를 표시합니다FTTouchPrivacyLevelHide: 모든 사용자 터치를 마스킹합니다설정 시 privacy 구성을 재정의합니다SDK 1.6.1 이상 버전에서 지원됩니다 |
| textAndInputPrivacy | FTTextAndInputPrivacyLevel | 아니요 | 세션 리플레이에서 텍스트 및 입력 마스킹에 사용할 수 있는 프라이버시 수준입니다. 기본값은 FTTextAndInputPrivacyLevelMaskAll입니다FTTextAndInputPrivacyLevelMaskSensitiveInputs: 비밀번호 입력 등 민감한 입력을 제외한 모든 텍스트를 표시합니다FTTextAndInputPrivacyLevelMaskAllInputs: UITextField, UISwitch, UISlider 등 모든 입력 필드를 마스킹합니다FTTextAndInputPrivacyLevelMaskAll: 모든 텍스트와 입력을 마스킹합니다설정 시 privacy 구성을 재정의합니다SDK 1.6.1 이상 버전에서 지원됩니다 |
| imagePrivacy | FTImagePrivacyLevel | 아니요 | 세션 리플레이에서 이미지 마스킹에 사용할 수 있는 프라이버시 수준입니다. 기본값은 FTImagePrivacyLevelMaskAll입니다.FTImagePrivacyLevelMaskNonBundledOnly: SF Symbols 및 [UIImage imageNamed:] / UIImage(named:)로 로드되고 App과 함께 번들된 이미지만 기록하며, 네트워크에서 다운로드되었거나 런타임에 생성된 이미지는 마스킹됩니다.FTImagePrivacyLevelMaskAll: 모든 이미지를 마스킹합니다.FTImagePrivacyLevelMaskNone: 네트워크에서 다운로드되었거나 런타임에 생성된 이미지를 포함한 모든 이미지를 기록합니다. 이미지에 민감한 내용이 포함되어 있지 않은지 확인한 후 사용하세요.설정 시 privacy 구성을 재정의합니다SDK 1.6.2 이상 버전에서 지원됩니다 |
| enableSwiftUI | BOOL | 아니요 | SwiftUI 페이지의 세션 리플레이 수집을 활성화합니다. 기본값은 NO입니다. SDK 1.6.5 이상 버전에서 지원됩니다 |
| enableHeatmap | BOOL | 아니요 | Session Replay 히트맵 연관 기능을 활성화합니다. 기본값은 NO이며 실험적 기능입니다. SDK 1.6.6 이상 버전에서 지원됩니다 |
| enableLinkRUMKeys | NSArray | 아니요 | 활성화하면 설정된 keys에 따라 RUM Context의 해당 필드를 세션 리플레이 데이터에 연관시킵니다. 세션 리플레이 데이터 라우팅을 구현하는 데 사용할 수 있습니다 SDK 1.6.2 이상 버전에서 지원됩니다 |
주의:
enableHeatmap은 자동 수집된 UIKit Action을 연관시키는 데만 사용됩니다. 일부 UIKit Action은 Heatmap을 지원하지 않을 수 있습니다. SwiftUI Action은 현재 자동 수집을 지원하지 않으므로enableHeatmap을 통해 히트맵을 연관시킬 수 없습니다.
프라이버시 재정의¶
SDK 1.6.1 이상 버전에서 지원됩니다
SDK는 FTSessionReplayConfig를 통해 전역 마스킹 수준을 구성하는 것 외에도 뷰 수준에서 이러한 설정을 재정의할 수 있습니다.
뷰 수준 프라이버시 재정의:
- 텍스트 및 입력 마스킹 수준, 터치 마스킹 수준, 이미지 마스킹 수준(SDK 1.6.2 이상 버전에서 지원)을 재정의할 수 있습니다
- 특정 뷰를 완전히 숨기도록 설정할 수 있습니다
주의:
- 재정의가 올바르게 인식되도록 하려면 뷰 수명 주기에서 가능한 한 일찍 적용해야 합니다. 이렇게 하면 세션 리플레이가 설정된 재정의를 적용하기 전에 뷰를 처리하는 상황을 방지할 수 있습니다.
- 프라이버시 재정의는 뷰와 해당 하위 뷰에 영향을 미칩니다. 즉, 재정의가 즉시 적용되지 않을 수 있는 뷰에 적용되더라도(예: 텍스트 입력에 이미지 재정의 적용) 재정의는 모든 하위 뷰에 계속 적용됩니다.
- 프라이버시 재정의 우선순위: 하위 뷰 > 상위 뷰 > 전역 설정
텍스트 및 입력 재정의¶
텍스트 및 입력 프라이버시를 재정의하려면 뷰 인스턴스에서 sessionReplayPrivacyOverrides.textAndInputPrivacy를 사용하여 FTTextAndInputPrivacyLevelOverride 열거형의 값 중 하나로 설정하세요. 기존 재정의 규칙을 제거하려면 해당 속성을 FTTextAndInputPrivacyLevelOverrideNone으로 설정하면 됩니다.
터치 재정의¶
터치 프라이버시를 재정의하려면 뷰 인스턴스에서 sessionReplayPrivacyOverrides.touchPrivacy를 사용하여 FTTouchPrivacyLevelOverride 열거형의 값 중 하나로 설정하세요. 기존 재정의 규칙을 제거하려면 해당 속성을 FTTouchPrivacyLevelOverrideNone으로 설정하면 됩니다.
이미지 재정의¶
SDK 1.6.2 이상 버전에서 지원됩니다
이미지 프라이버시를 재정의하려면 뷰 인스턴스에서 sessionReplayPrivacyOverrides.imagePrivacy를 사용하여 FTImagePrivacyLevelOverride 열거형의 값 중 하나로 설정하세요. 기존 재정의 규칙을 제거하려면 해당 속성을 FTImagePrivacyLevelOverrideNone으로 설정하면 됩니다.
사용 가능한 이미지 재정의 수준:
FTImagePrivacyLevelOverrideMaskNonBundledOnly: SF Symbols 및[UIImage imageNamed:]/UIImage(named:)로 로드되고 App과 함께 번들된 이미지만 기록하며, 네트워크에서 다운로드되었거나 런타임에 생성된 이미지는 마스킹됩니다.FTImagePrivacyLevelOverrideMaskAll: 모든 이미지를 마스킹합니다.FTImagePrivacyLevelOverrideMaskNone: 네트워크에서 다운로드되었거나 런타임에 생성된 이미지를 포함한 모든 이미지를 기록합니다. 이미지에 민감한 내용이 포함되어 있지 않은지 확인한 후 사용하세요.
숨김 요소 재정의¶
완전히 숨겨야 하는 민감한 요소에는 sessionReplayPrivacyOverrides.hide를 사용하여 설정하세요.
특정 요소를 숨김으로 설정하면 리플레이에서 "Hidden"으로 표시된 자리 표시자로 대체되고 해당 하위 뷰는 기록되지 않습니다.
주의: 뷰를 숨김으로 표시해도 해당 요소에서 터치 상호 작용이 기록되는 것을 막을 수는 없습니다. 터치 상호 작용을 숨기려면 요소를 숨김으로 표시하는 것 외에도 터치 재정의를 사용해야 합니다.
Webview Session Replay¶
SDK 1.6.2 이상 버전에서 지원됩니다
먼저 이 페이지의 세션 리플레이 초기화와 WebView 페이지 초기화를 완료한 다음 페이지에서 녹화를 활성화하세요: