iOS 세션 리플레이¶

전제 조건¶

• GuanceSDKRUM 구성을 설정 및 초기화하고, View 모니터링 수집을 활성화했는지 확인하세요.
• iOS 세션 리플레이 버전 지원: SDK.Version >= 1.6.0.
• 이전 버전에서 SDK 1.6.6 이상으로 업그레이드하는 경우, 세션 리플레이 제품명이 GuanceSessionReplay로 변경되었습니다. 마이그레이션 가이드를 참조하세요.

• 문서 상단의 배지에 표시된 공식 안정 버전을 우선 사용하는 것을 권장하며, alpha, beta 등의 프리릴리스 버전은 더 이상 사용하지 않는 것이 좋습니다.

• 선행 기능을 미리 통합하거나 최신 기능을 확인하거나 공식 릴리스되지 않은 변경 사항을 추적하려면 GitHub에서 iOS SDK 저장소 및 관련 업데이트 로그를 확인하세요: GuanceCloud/datakit-ios

설정¶

패키지 관리자에 따라 GuanceSDK 라이브러리의 GuanceSessionReplay 기능 구성 요소를 프로젝트에 연결하세요:

CocoaPods¶

pod 'GuanceSDK', 'last_version'
pod 'GuanceSDK/SessionReplay', 'last_version' # 새로 추가

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 경로는 통합 방식에 따라 다릅니다:

코드 호출¶

@import GuanceSessionReplay;
FTSessionReplayConfig *srConfig = [[FTSessionReplayConfig alloc]init];
   srConfig.touchPrivacy = FTTouchPrivacyLevelShow;
   srConfig.textAndInputPrivacy = FTTextAndInputPrivacyLevelMaskSensitiveInputs;
   srConfig.imagePrivacy = FTImagePrivacyLevelMaskNonBundledOnly;
   // SwiftUI 페이지 수집이 필요한 경우, SDK 1.6.5 이상 버전에서 활성화 가능
   srConfig.enableSwiftUI = YES;
   // 세션 리플레이 히트맵 연동이 필요한 경우, SDK 1.6.6 이상 버전에서 활성화 가능
   srConfig.enableHeatmap = YES;
   srConfig.sampleRate = 100;
   [[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
   // 세션 리플레이 히트맵 연동이 필요한 경우, SDK 1.6.6 이상 버전에서 활성화 가능
   srConfig.enableHeatmap = true
   srConfig.sampleRate = 100
   FTRumSessionReplay.shared().start(with: srConfig)

참고: enableHeatmap은 자동 수집된 UIKit Action에만 연결됩니다. 일부 UIKit Action은 Heatmap을 지원하지 않을 수 있습니다. SwiftUI Action은 현재 자동 수집을 지원하지 않으므로 enableHeatmap을 통해 히트맵을 연결할 수 없습니다.

프라이버시 오버라이드¶

SDK 1.6.1 이상 버전 지원

SDK는 FTSessionReplayConfig를 통한 전역 마스킹 수준 설정 외에도 뷰 수준에서 이러한 설정을 덮어쓰는 것을 지원합니다.

뷰 수준 프라이버시 오버라이드:

• 텍스트 및 입력 마스킹 수준, 터치 마스킹 수준, 이미지 마스킹 수준(SDK 1.6.2 이상 버전 지원)의 덮어쓰기를 지원합니다.
• 특정 뷰를 완전히 숨기는 설정을 지원합니다.

참고:

• 오버라이드를 올바르게 식별하려면 뷰의 수명 주기 초기에 적용해야 합니다. 이렇게 하면 세션 리플레이가 설정된 오버라이드를 적용하기 전에 뷰를 처리하는 상황을 방지할 수 있습니다.
• 프라이버시 오버라이드는 뷰와 그 하위 뷰에 영향을 미칩니다. 즉, 오버라이드가 즉시 적용되지 않을 수 있는 뷰(예: 텍스트 입력에 이미지 오버라이드 적용)에 적용되더라도 오버라이드는 모든 하위 뷰에 계속 적용됩니다.
• 프라이버시 오버라이드 우선순위: 하위 뷰 > 상위 뷰 > 전역 설정

텍스트 및 입력 오버라이드¶

텍스트 및 입력 프라이버시를 덮어쓰려면 뷰 인스턴스에서 sessionReplayPrivacyOverrides.textAndInputPrivacy를 사용하여 FTTextAndInputPrivacyLevelOverride 열거형의 값 중 하나로 설정합니다. 기존 오버라이드 규칙을 제거하려면 해당 속성을 FTTextAndInputPrivacyLevelOverrideNone으로 설정하면 됩니다.

@import GuanceSessionReplay;
// 지정된 뷰에 텍스트 및 입력 오버라이드 설정
   myView.sessionReplayPrivacyOverrides.textAndInputPrivacy = FTTextAndInputPrivacyLevelOverrideMaskAll;
   // 뷰의 텍스트 및 입력 오버라이드 설정 제거
   myView.sessionReplayPrivacyOverrides.textAndInputPrivacy = FTTextAndInputPrivacyLevelOverrideNone;

   // 지정된 뷰에 텍스트 및 입력 오버라이드 설정
   myView.sessionReplayPrivacyOverrides.textAndInputPrivacy = .maskAll
   // 뷰의 텍스트 및 입력 오버라이드 설정 제거
   myView.sessionReplayPrivacyOverrides.textAndInputPrivacy = .none

터치 오버라이드¶

터치 프라이버시를 덮어쓰려면 뷰 인스턴스에서 sessionReplayPrivacyOverrides.touchPrivacy를 사용하여 FTTouchPrivacyLevelOverride 열거형의 값 중 하나로 설정합니다. 기존 오버라이드 규칙을 제거하려면 해당 속성을 FTTouchPrivacyLevelOverrideNone으로 설정하면 됩니다.

@import GuanceSessionReplay;
// 지정된 뷰에 터치 오버라이드 설정
   myView.sessionReplayPrivacyOverrides.touchPrivacy = FTTouchPrivacyLevelOverrideShow;
   // 뷰의 터치 오버라이드 설정 제거
   myView.sessionReplayPrivacyOverrides.touchPrivacy = FTTouchPrivacyLevelOverrideNone;

   // 지정된 뷰에 터치 오버라이드 설정
   myView.sessionReplayPrivacyOverrides.touchPrivacy = .show;
   // 뷰의 터치 오버라이드 설정 제거
   myView.sessionReplayPrivacyOverrides.touchPrivacy = .none;

이미지 오버라이드¶

SDK 1.6.2 이상 버전 지원

이미지 프라이버시를 덮어쓰려면 뷰 인스턴스에서 sessionReplayPrivacyOverrides.imagePrivacy를 사용하여 FTImagePrivacyLevelOverride 열거형의 값 중 하나로 설정합니다. 기존 오버라이드 규칙을 제거하려면 해당 속성을 FTImagePrivacyLevelOverrideNone으로 설정하면 됩니다.

사용 가능한 이미지 오버라이드 수준:

• FTImagePrivacyLevelOverrideMaskNonBundledOnly: SF Symbols 및 [UIImage imageNamed:] / UIImage(named:)로 로드되어 앱에 번들된 이미지만 기록하며, 네트워크 다운로드 또는 런타임에 생성된 이미지는 마스킹됩니다.
• FTImagePrivacyLevelOverrideMaskAll: 모든 이미지 마스킹.
• FTImagePrivacyLevelOverrideMaskNone: 네트워크 다운로드 또는 런타임에 생성된 이미지를 포함한 모든 이미지를 기록합니다. 이미지에 민감한 콘텐츠가 포함되어 있지 않은지 확인 후 사용하세요.

@import GuanceSessionReplay;
// 지정된 뷰에 이미지 오버라이드 설정
   myImageView.sessionReplayPrivacyOverrides.imagePrivacy = FTImagePrivacyLevelOverrideMaskNonBundledOnly;
   // 뷰의 이미지 오버라이드 설정 제거
   myImageView.sessionReplayPrivacyOverrides.imagePrivacy = FTImagePrivacyLevelOverrideNone;

   // 지정된 뷰에 이미지 오버라이드 설정
   myImageView.sessionReplayPrivacyOverrides.imagePrivacy = .maskNonBundledOnly
   // 뷰의 이미지 오버라이드 설정 제거
   myImageView.sessionReplayPrivacyOverrides.imagePrivacy = .none

숨김 요소 오버라이드¶

완전히 숨겨야 하는 민감한 요소의 경우 sessionReplayPrivacyOverrides.hide를 사용하여 설정합니다.

특정 요소를 숨김으로 설정하면 리플레이에서 "Hidden"으로 표시된 플레이스홀더로 대체되며, 하위 뷰는 기록되지 않습니다.

참고: 뷰를 숨김으로 표시한다고 해서 해당 요소에 대한 터치 상호 작용 기록이 방지되지는 않습니다. 터치 상호 작용을 숨기려면 요소를 숨김으로 표시하는 것 외에 터치 오버라이드도 함께 사용하세요.

@import GuanceSessionReplay;
// 지정된 뷰를 숨김 요소로 표시
   myView.sessionReplayPrivacyOverrides.hide = YES;
   // 뷰의 숨김 요소 오버라이드 설정 제거
   myView.sessionReplayPrivacyOverrides.hide = NO;

   // 지정된 뷰를 숨김 요소로 표시
   myView.sessionReplayPrivacyOverrides.hide = true;
   // 뷰의 숨김 요소 오버라이드 설정 제거
   myView.sessionReplayPrivacyOverrides.hide = false;

Webview 세션 리플레이¶

SDK 1.6.2 이상 버전 지원

WebView 세션 리플레이를 사용하려면 WebView에서 액세스하는 페이지에 Web 모니터링 SDK를 통합하고, Webview에서 세션 리플레이를 활성화해야 합니다.

//webview RUM 설정 외
window.DATAFLUX_RUM.startSessionReplayRecording();

코드 및 설정 참조¶

• iOS Demo Cocoapod 설정
• iOS Demo 코드 호출