콘텐츠로 이동

Android 세션 리플레이

사전 요구 사항

  • FTSdk RUM 구성을 설정 및 초기화하고 View 모니터링 수집을 활성화했는지 확인합니다.
  • Android Session Replay는 ft-sdk:1.7.0 이상 버전이 필요합니다.
  • ft-session-replay와 ft-session-replay-material은 동일한 버전 번호를 사용해야 합니다.
  • ft-sdk 1.7.2 이상 버전은 더 이상 ft-session-replay에 강하게 의존하지 않습니다. Session Replay를 활성화해야 하는 경우에만 ft-session-replay 및 관련 확장 의존성을 추가로 추가하면 됩니다.
  • 문서 최상단 badge에 표시된 정식 릴리스 안정 버전을 우선 사용하는 것이 좋으며, alpha, beta 등 사전 릴리스 버전은 더 이상 사용하지 않는 것이 좋습니다.

  • 미리 앞선 기능을 도입하고, 최신 기능을 확인하거나 정식 릴리스되지 않은 변경 사항을 추적하려면 GitHub에서 Android SDK 저장소 및 관련 변경 로그를 팔로우할 수 있습니다: GuanceCloud/datakit-android

Android 히트맵(실험적 기능)

Android 히트맵은 ft-sdk >= 1.7.4와 ft-session-replay >= 0.1.7을 동시에 사용하고 RUM 사용자 행위 수집 및 Session Replay를 활성화해야 합니다.

ft-sdk >= 1.7.0은 여전히 일반 Android Session Replay의 최소 버전 요구 사항입니다. 위 버전 조합은 Android 히트맵에만 적용됩니다.

설정

//SDK 의존성 추가
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-sdk:[latest_version]'
//session replay 기능을 활성화해야 함
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay:[session_replay_version]'
//session replay를 지원하려면 material 컴포넌트를 지원해야 함
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-material:[session_replay_version]'
//session replay를 지원하려면 compose 컴포넌트를 지원해야 함
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-compose:[session_replay_version]'

Flutter RUM 컨텍스트 호환

ft-session-replay 0.1.5 이상 버전은 Flutter Session Replay 업로드 시 사용되는 RUM 컨텍스트 필드와 호환됩니다. Android 네이티브 프로젝트에 Flutter 페이지 또는 Flutter SDK 수집 파이프라인이 함께 존재하는 경우, ft-session-replay:0.1.5 이상 버전으로 업그레이드하면 추가 구성 없이 Flutter Replay 데이터를 해당 Replay Segment에 올바르게 매핑할 수 있습니다.

혼합 환경에서는 여전히 RUM 초기화를 먼저 완료한 후 Session Replay를 초기화하여 app_id, session_id, view_id 등 컨텍스트가 설정되었는지 확인하는 것이 좋습니다.

코드 호출

FTSdk.initSessionReplayConfig(new FTSessionReplayConfig().setSessionReplaySamplingRate(100f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(new MaterialExtensionSupport()), context);
FTSdk.initSessionReplayConfig(FTSessionReplayConfig().setSessionReplaySamplingRate(100f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(MaterialExtensionSupport()), context)
메서드 이름 유형 필수 의미
setSessionReplaySamplingRate float 아니요 샘플링 백분율이며 범위는 [0,100], 기본값은 100이고 소수를 지원합니다. 명시적 새 필드가 이전 필드보다 우선합니다. ft-session-replay >= 0.1.9에서 지원됩니다.
setSampleRate Float 아니요 ft-session-replay 0.1.9부터 사용 중단되며, 0~1 단위 호환성을 유지합니다. 수집률을 설정하며 값 범위는 [0,1]이고, 0은 수집하지 않음, 1은 전체 수집을 의미하며 기본값은 1입니다.
setSessionReplayOnErrorSamplingRate float 아니요 샘플링 백분율이며 범위는 [0,100], 기본값은 0이고 소수를 지원합니다. 명시적 새 필드가 이전 필드보다 우선합니다. ft-session-replay >= 0.1.9에서 지원됩니다.
setSessionReplayOnErrorSampleRate Float 아니요 ft-session-replay 0.1.9부터 사용 중단되며, 0~1 단위 호환성을 유지합니다. 오류 수집률을 설정합니다. 세션이 setSampleRate로 샘플링되지 않은 경우, 세션 중 오류가 발생하면 오류 발생 전 1분 범위의 데이터를 수집할 수 있습니다. 값 범위는 [0,1]이며, 0은 수집하지 않음, 1은 전체 수집을 의미하고 기본값은 0입니다. ft-session-replay 0.1.2-alpha01 이상 버전에서 지원됩니다.
setPrivacy SessionReplayPrivacy 아니요 SessionReplayPrivacy.ALLOW는 개인정보 데이터를 마스킹하지 않습니다. SessionReplayPrivacy.MASK는 텍스트, CheckBox, RadioButton, Switch를 포함한 모든 데이터를 마스킹합니다. SessionReplayPrivacy.USER_INPUT(권장)은 입력 상자 내 텍스트, CheckBox, RadioButton, Switch를 포함한 사용자 입력 데이터의 일부를 마스킹합니다. 기본값은 SessionReplayPrivacy.MASK입니다. 곧 사용 중단될 예정이며 호환 사용은 가능합니다. 마스킹 설정에는 setTouchPrivacy, setTextAndInputPrivacy를 우선 사용하는 것이 좋습니다
setTextAndInputPrivacy TextAndInputPrivacy 아니요 TextAndInputPrivacy.MASK_SENSITIVE_INPUTS는 비밀번호 등 정보만 마스킹합니다. TextAndInputPrivacy.MASK_ALL_INPUTS는 입력 상자 내 텍스트, CheckBox, RadioButton, Switch를 포함한 사용자 입력 데이터의 일부를 마스킹합니다. TextAndInputPrivacy.MASK_ALL은 텍스트, CheckBox, RadioButton, Switch를 포함한 모든 데이터를 마스킹합니다. 기본값은 TextAndInputPrivacy.MASK_ALL이며, 설정 시 setPrivacy 구성을 재정의합니다. ft-session-replay 0.1.1-alpha01 이상 버전에서 지원됩니다.
setImagePrivacy ImagePrivacy 아니요 ImagePrivacy.MASK_ALL은 모든 이미지를 마스킹합니다. ImagePrivacy.MASK_LARGE_ONLY는 큰 이미지 콘텐츠(100x100 dp보다 큰 콘텐츠 이미지)만 마스킹합니다. ImagePrivacy.MASK_NONE은 이미지를 마스킹하지 않습니다. 기본값은 ImagePrivacy.MASK_ALL이며, 설정 시 setPrivacy 구성을 재정의합니다. ft-sdk >= 1.7.0-alpha40, ft-session-replay >= 0.1.3-alpha14
setTouchPrivacy TouchPrivacy 아니요 TouchPrivacy.SHOW는 터치 데이터를 마스킹하지 않습니다. TouchPrivacy.HIDE는 터치 데이터를 마스킹합니다. 설정 시 setPrivacy 구성을 재정의합니다. ft-session-replay 0.1.1-alpha01 이상 버전에서 지원됩니다.
addExtensionSupport ExtensionSupport 아니요 추가 사용자 정의 지원을 추가합니다. ft-session-replay-material을 사용하면 MaterialExtensionSupport를 사용하여 추가 Material 컴포넌트 수집 지원을 제공할 수 있습니다.

개인정보 보호 재정의

ft-session-replay 0.1.1-alpha01 이상 버전에서 지원됩니다.

SDK는 FTSessionReplayConfig를 통해 전역 마스킹 수준을 구성하는 것 외에도 뷰 수준에서 이러한 설정을 재정의할 수 있습니다.

뷰 수준 개인정보 보호 재정의:

  • 이미지 마스킹 수준 재정의 지원
  • 텍스트 및 입력 마스킹 수준과 터치 마스킹 수준 재정의 지원
  • 특정 뷰를 완전히 숨기도록 설정 지원

참고:

  • 재정의 설정이 올바르게 인식되도록 하려면 뷰 수명 주기에서 가능한 한 일찍 적용해야 합니다. 이렇게 하면 설정된 재정의가 적용되기 전에 Session Replay가 뷰를 처리하는 상황을 방지할 수 있습니다.
  • 개인정보 보호 재정의는 뷰와 하위 뷰에 영향을 줍니다. 즉, 재정의가 즉시 적용되지 않을 수 있는 뷰에 적용되더라도(예: 텍스트 입력에 이미지 재정의 적용) 모든 하위 뷰에 계속 적용됩니다.
  • 개인정보 보호 재정의 우선순위: 하위 뷰 > 상위 뷰 > 전역 설정

이미지 재정의

ft-sdk >= 1.7.0-alpha40, ft-session-replay >= 0.1.3-alpha14

이미지 개인정보 보호를 재정의하려면 뷰 인스턴스에서 PrivacyOverrideExtensions.setSessionReplayImagePrivacy(View,ImagePrivacy)를 사용하여 ImagePrivacy 열거형의 값 중 하나로 설정합니다. 기존 재정의 규칙을 제거하려면 해당 속성을 null로 설정하면 됩니다.

// 지정된 뷰에 이미지 개인정보 보호 재정의 표시
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, ImagePrivacy.MASK_ALL);
// 뷰의 이미지 개인정보 보호 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, null);
// 지정된 뷰에 이미지 개인정보 보호 재정의 표시
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, ImagePrivacy.MASK_ALL)
// 뷰의 이미지 개인정보 보호 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayImagePrivacy(view, null)

텍스트 및 입력 재정의

텍스트 및 입력 개인정보 보호를 재정의하려면 뷰 인스턴스에서 PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(View,TextAndInputPrivacy)를 사용하여 TextAndInputPrivacy 열거형의 값 중 하나로 설정합니다. 기존 재정의 규칙을 제거하려면 해당 속성을 null로 설정하면 됩니다.

// 지정된 뷰에 숨김 요소 재정의 표시
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, TextAndInputPrivacy.MASK_ALL);
// 뷰의 숨김 요소 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, null);
// 지정된 뷰에 숨김 요소 재정의 표시
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, TextAndInputPrivacy.MASK_ALL)
// 뷰의 숨김 요소 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayTextAndInputPrivacy(view, null)

터치 재정의

터치 개인정보 보호를 재정의하려면 뷰 인스턴스에서 PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(View,TouchPrivacy)를 사용하여 TouchPrivacy 열거형의 값 중 하나로 설정합니다. 기존 재정의 규칙을 제거하려면 해당 속성을 null로 설정하면 됩니다.

// 지정된 뷰에 숨김 요소 재정의 표시
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, TouchPrivacy.HIDE);
// 뷰의 숨김 요소 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, null);
// 지정된 뷰에 숨김 요소 재정의 표시
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, TouchPrivacy.HIDE)
// 뷰의 숨김 요소 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayTouchPrivacy(view, null)

숨김 요소 재정의

완전히 숨겨야 하는 민감한 요소의 경우 PrivacyOverrideExtensions.setSessionReplayHidden(View,Boolean)을 사용하여 설정합니다.

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

참고: 뷰를 숨김으로 표시하더라도 해당 요소에서 터치 상호작용이 기록되는 것은 막지 않습니다. 터치 상호작용을 숨기려면 요소를 숨김으로 표시하는 것 외에도 터치 재정의를 사용해야 합니다.

// 지정된 뷰에 숨김 요소 재정의 표시
PrivacyOverrideExtensions.setSessionReplayHidden(view, true)
// 뷰의 숨김 요소 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayHidden(view, false)
// 지정된 뷰에 숨김 요소 재정의 표시
PrivacyOverrideExtensions.setSessionReplayHidden(view, true)
// 뷰의 숨김 요소 재정의 설정 제거
PrivacyOverrideExtensions.setSessionReplayHidden(view, false)

Webview Session Replay

ft-session-replay 0.1.3-alpha11, ft-sdk 1.7.0-alpha36 이상 버전에서 지원됩니다.

먼저 이 페이지의 세션 리플레이 초기화와 WebView 페이지 초기화를 완료한 다음, 페이지에서 녹화를 시작합니다:

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

Tencent Webivew X5 Support

FTSdk.initSessionReplayConfig(new FTSessionReplayConfig()
    //...
    // CustomExtensionSupport 추가 설정
    .addExtensionSupport(new CustomExtensionSupport()
            .addMapper(new MapperTypeWrapper<>(com.tencent.smtt.sdk.WebView.class,
                    new WebViewXWireframeMapper())))
)
FTSdk.initSessionReplayConfig(FTSessionReplayConfig()
    //...
    // CustomExtensionSupport 추가 설정
    .addExtensionSupport(
        CustomExtensionSupport()
            .addMapper(
                MapperTypeWrapper(
                    com.tencent.smtt.sdk.WebView::class.java,
                    WebViewXWireframeMapper()
                )
            )
    )
)

Jetpack Compose 지원

ft-session-replay-compose와 ft-session-replay는 동일한 버전 번호를 사용해야 합니다.

Android Session Replay는 이제 Jetpack Compose UI의 수집 및 리플레이를 지원합니다. Compose 페이지를 사용할 때는 Compose 확장 의존성을 추가로 도입하고 FTSessionReplayConfig에 ComposeExtensionSupport를 추가해야 합니다.

의존성 추가

implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-session-replay-compose:[session_replay_version]'

초기화 구성

FTSdk.initSessionReplayConfig(new FTSessionReplayConfig().setSessionReplaySamplingRate(100f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(new ComposeExtensionSupport())
                .addExtensionSupport(new MaterialExtensionSupport()), context);
FTSdk.initSessionReplayConfig(FTSessionReplayConfig().setSessionReplaySamplingRate(100f)
                .setTouchPrivacy(TouchPrivacy.SHOW)
                .setImagePrivacy(ImagePrivacy.MASK_LARGE_ONLY)
                .setTextAndInputPrivacy(TextAndInputPrivacy.MASK_SENSITIVE_INPUTS)
                .addExtensionSupport(ComposeExtensionSupport())
                .addExtensionSupport(MaterialExtensionSupport()), context)

Compose 개인정보 보호 재정의

Compose 페이지는 Modifier를 통해 Session Replay의 개인정보 보호 구성을 재정의할 수 있습니다:

  • sessionReplayHide(Boolean): 지정된 Compose 노드 숨기기
  • sessionReplayImagePrivacy(ImagePrivacy): 이미지 개인정보 보호 수준 재정의
  • sessionReplayTextAndInputPrivacy(TextAndInputPrivacy): 텍스트 및 입력 개인정보 보호 수준 재정의
  • sessionReplayTouchPrivacy(TouchPrivacy): 터치 개인정보 보호 수준 재정의

현재 제한 사항

  • Compose 리플레이는 의미 노드와 컴포넌트 매핑에 의존하므로 픽셀 단위 복원을 보장하지 않습니다.
  • 현재 일반적인 텍스트, 입력 상자, 이미지, 버튼, 스위치, 슬라이더, 라디오 버튼, 체크박스, Tab 및 컨테이너 유형 컴포넌트의 리플레이를 지원합니다.
  • Brush 배경은 현재 지원되지 않습니다. 예를 들어 선형 그라데이션, 방사형 그라데이션 등의 배경은 원래 그라데이션 효과대로 복원되지 않습니다. 핵심 시연 영역에는 단색 배경을 우선 사용하는 것이 좋습니다.

코드 및 구성 참조

문서 평가

이 페이지가 도움이 되었나요?