세션 리플레이 Android 플러그인

앱이 이미 Amplitude로 계측되어 있는 경우 Android SDK 플러그인을 사용하여 세션 리플레이를 설치하세요. 제품 내 분석에 다른 공급자를 사용하는 경우 독립형 구현을 대신 사용하십시오.

세션 리플레이는 앱의 뷰 트리에 대한 변경 사항을 캡처합니다. 뷰 트리에는 기본 뷰와 모든 하위 뷰가 재귀적으로 포함됩니다. 그런 다음 세션 리플레이는 이러한 변경 사항을 재생하여 비디오와 같은 리플레이를 구성합니다.

예를 들어 세션이 시작될 때 세션 리플레이는 앱의 뷰 트리의 전체 스냅샷을 캡처합니다. 사용자가 앱과 상호작용할 때 세션 리플레이는 뷰에 대한 각 변경 사항을 diff로 캡처합니다. 그런 다음 세션 리플레이는 각 차이를 순차적으로 원본 뷰 트리에 적용하여 세션의 재생을 구성합니다.

세션 리플레이에는 최대 길이가 없습니다.

시작하기 전에

사용하는 방법은 사용하는 Amplitude Android SDK의 버전에 따라 다릅니다.

지원되는 Android 버전

세션 리플레이는 최소 SDK 21 minSdk = 21의 Android 5.0까지 지원합니다. Android Studio의 Google 배포 데이터에 따르면 전 세계 Android 기기의 99.6% 이상을 지원합니다.

빠른 시작

// Install latest version from Maven Central
implementation("com.amplitude:plugin-session-replay-android:0.33.0")
// You will also need the Amplitude Analytics SDK if it's not already installed
implementation("com.amplitude:analytics-android:[1.29.0,2.0.0)")

import com.amplitude.android.Amplitude
import com.amplitude.android.Configuration
import com.amplitude.android.plugins.SessionReplayPlugin
// Initialize Amplitude Analytics SDK instance
val amplitude = Amplitude(
    Configuration(
        apiKey = API_KEY,
        context = applicationContext
    )
)
// Create and Install Session Replay Plugin
// Recording will be handled automatically
val sessionReplayPlugin = SessionReplayPlugin(sampleRate = 1.0)
amplitude.add(sessionReplayPlugin)

구성

세션 리플레이 플러그인을 초기화할 때 다음 옵션을 전달하십시오.

사용자 지정 세션 ID

Android 버전 0.26.4 이상용 세션 리플레이는 setCustomSessionId 메서드를 통해 문자열 세션 ID(예: UUID)를 지원합니다. 프로젝트에서 Amplitude 대신 사용자 정의 이벤트 속성을 사용하여 세션을 정의하는 경우 사용자 정의 세션 ID를 사용하십시오session_id.

사용자 지정 세션 ID를 설정할 때, 이 값은 플러그인이 Amplitude SDK에서 데이터 동기화하는 세션 ID보다 우선합니다. 오버라이드를 지우고 Amplitude 세션 ID 사용을 재개하려면 null를 전달하십시오.

// Keep a reference to the plugin to set the custom session ID
val sessionReplayPlugin = SessionReplayPlugin(sampleRate = 1.0)
sessionReplayPlugin.setCustomSessionId("ef197fc7-a46f-4e6c-a77f-8d90c17065c0")
amplitude.add(sessionReplayPlugin)
// Whenever your custom session changes
sessionReplayPlugin.setCustomSessionId(newCustomSessionId)

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

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

원격 구성

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

화면상의 데이터 마스킹

세션 리플레이 SDK는 사용자 입력, 텍스트 및 기타 보기 구성 요소를 마스킹하는 네 가지 방법을 제공합니다.

마스크 수준

Android용 세션 리플레이는 PrivacyConfig(maskLevel = MaskLevel.MEDIUM)와 함께 privacyConfig 옵션을 통해 설정되는 세 가지 수준의 마스킹을 지원합니다. 기본 수준은 medium입니다.

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

레이아웃 XML의 개인정보 보호 태그

이 옵션을 응용 프로그램의 레이아웃 XML에 사용하십시오.

세션 리플레이 SDK의 개인정보 보호 방법

SessionReplay 클래스를 가져온 다음 애플리케이션 코드에서 아래 메서드 중 하나를 호출하십시오.

import com.amplitude.android.sessionreplay.SessionReplay

Jetpack Compose의 개인정보 보호 수정자

컴포저블의 경우 레이아웃 XML 태그 또는 SessionReplay 메서드 대신 개인정보 보호 수정자를 사용하십시오. 이러한 수정자를 사용하려면 버전 0.21.0 이상의 세션 리플레이 Android SDK 또는 플러그인이 필요합니다.

com.amplitude.android.sessionreplay.compose에서 필요한 수정자를 가져온 다음, 이를 컴포저블의 수정자 체인에 추가하십시오.

import com.amplitude.android.sessionreplay.compose.ampMask
import com.amplitude.android.sessionreplay.compose.ampUnmask
import com.amplitude.android.sessionreplay.compose.ampBlock

// Mask text that Session Replay captures by default
Text(
    text = "Account number: 123456789",
    modifier = Modifier.ampMask(),
)
// Unmask an input field that Session Replay masks by default
TextField(
    value = username,
    onValueChange = { username = it },
    modifier = Modifier.ampUnmask(),
)
// Block a composable and everything it contains
Box(modifier = Modifier.ampBlock()) {
    Text("Session Replay doesn't capture this content")
}

개인정보 보호 수정자는 해당 수정자를 추가하는 컴포저블 및 그 안에 중첩된 모든 항목에 적용됩니다. 중첩된 컴포저블에 자체 개인정보 보호 수정자가 설정되어 있으면 해당 수정자가 그 컴포저블과 하위 요소에 우선 적용됩니다.

사용자 옵트아웃

세션 리플레이 플러그인은 Android SDK의 optOut 설정을 따르며, 자체적으로 사용자 옵트아웃을 지원하지 않습니다.

// Set optOut on the Amplitude SDK
val amplitude = Amplitude(Configuration(
    apiKey = API_KEY,
    optOut = true,
    /* other configuration */
))
amplitude.add(SessionReplayPlugin(/* session replay options */))

EU 데이터 레지던시

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

// Set serverZone on the Amplitude SDK
val amplitude = Amplitude(Configuration(
    apiKey = API_KEY,
    serverZone = ServerZone.EU,
    /*, other configuration */
))
amplitude.add(SessionReplayPlugin(/* session replay options */))

샘플링 비율

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

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

// This configuration samples 1% of all sessions
amplitude.add(SessionReplayPlugin(sampleRate = 0.01))

리플레이 수집 비활성화

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

• 사용자가 앱을 떠납니다.
• sessionReplayPlugin.stop()을(를) 호출하십시오.
• amplitude.remove(sessionReplayPlugin)를 사용하여 SDK에서 플러그인을 제거합니다.

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

사용자가 앱의 제한되지 않은 영역으로 돌아왔을 때 재생 수집을 다시 활성화하려면 sessionReplayPlugin.start()를 호출하십시오.

특정 화면만 캡처하려면 플러그인이 시작될 때 시작되지 않도록 autoStart = false를 사용하여 초기화한 다음, 사용자가 해당 화면에 들어오거나 나갈 때 start() 및 stop()를 호출하십시오.

// Add the plugin without starting capture
val sessionReplayPlugin = SessionReplayPlugin(sampleRate = 1.0, autoStart = false)
amplitude.add(sessionReplayPlugin)
// Start capture when the user enters a screen you want to record
sessionReplayPlugin.start()
// Stop capture when the user leaves that screen
sessionReplayPlugin.stop()

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

import com.amplitude.android.Amplitude
import com.amplitude.android.Configuration
import com.amplitude.android.plugins.SessionReplayPlugin
// Your existing initialization logic with Android SDK
val amplitude = Amplitude(Configuration(apiKey = API_KEY /*, ... other configuration */))
if (nonEUCountryFlagEnabled) {
  // Create and Install Session Replay Plugin
  val sessionReplayPlugin = SessionReplayPlugin(sampleRate = 0.5)
  amplitude.add(sessionReplayPlugin)
}

WebView 및 MapView 지원 (베타 버전)

기본적으로 세션 리플레이는 캡처에서 웹 뷰와 맵 뷰를 차단합니다. 이러한 구성 요소의 캡처를 활성화하려면 화면 데이터 마스크에 설명된 설정을 사용하십시오.

웹 뷰 세션 리플레이는 렌더링된 페이지에 JavaScript를 삽입합니다. 이를 활성화하기 위해 SDK는 마스킹되지 않은 웹 뷰에서 javaScriptEnabled를 true로 설정합니다.

로그 기록

세션 리플레이는 Android 애플리케이션의 로그 기록을 지원합니다. 로그 기록을 활성화하려면 recordLog(level, message, timestamp) API를 통해 로그 메시지를 전송하고 세션 리플레이를 초기화할 때 recordLogOptions 매개 변수로 제한을 설정하세요.

import com.amplitude.android.plugins.SessionReplayPlugin
import com.amplitude.android.sessionreplay.config.RecordLogLevel
import com.amplitude.android.sessionreplay.config.RecordLogOptions
val sessionReplayPlugin = SessionReplayPlugin(
    recordLogOptions = RecordLogOptions(
        logCountThreshold = 2000,
        maxMessageLength = 4000
    )
)
amplitude.add(sessionReplayPlugin)
sessionReplayPlugin.recordLog(RecordLogLevel.Error, "This is an error log")
// You can also create custom log levels
sessionReplayPlugin.recordLog(RecordLogLevel("debug"), "This is a debug log")

세션 리플레이는 미리 정의된 로그 수준(Error, Warn, Log)과 사용자 지정 로그 수준을 지원합니다. 임의의 문자열 값을 RecordLogLevel(...)에 전달하여 사용자 지정 로그 수준을 생성합니다.

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

Timber

Timber를 사용하는 경우 이를 사용자 지정 트리와 통합할 수 있습니다.

import com.amplitude.android.plugins.SessionReplayPlugin
import com.amplitude.android.sessionreplay.config.RecordLogLevel
import timber.log.Timber
class AmplitudeLogRecordTree(private val plugin: SessionReplayPlugin) : Timber.Tree() {
    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
        val recordLevel = when (priority) {
            android.util.Log.ERROR -> RecordLogLevel.Error
            android.util.Log.WARN -> RecordLogLevel.Warn
            android.util.Log.INFO -> RecordLogLevel.Log
            android.util.Log.DEBUG -> RecordLogLevel("debug")
            android.util.Log.VERBOSE -> RecordLogLevel("verbose")
            else -> return
        }
        plugin.recordLog(recordLevel, message)
    }
}
val sessionReplayPlugin = SessionReplayPlugin()
amplitude.add(sessionReplayPlugin)
Timber.plant(AmplitudeLogRecordTree(sessionReplayPlugin))

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

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

보관 기간

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

DSAR API

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

데이터 삭제

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

봇 필터

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

세션 리플레이 저장 공간

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

SDK는 리플레이 데이터를 로컬에 저장합니다. 재시도 횟수와 저장 공간 제한 내에서 일시적인 업로드 실패 시 재시도합니다.

Amplitude는 각 앱 종료 시 서버로 세션 데이터를 전송하도록 Amplitude SDK 구성(기본값)에서 flushEventsOnClose = true 설정을 권장합니다.

Jetpack Compose 지원 (알파)

세션 리플레이는 Android 애플리케이션용 Jetpack Compose를 지원합니다. 이 기능은 현재 알파 버전입니다. Jetpack Compose를 세션 리플레이 기능과 함께 사용하려면 버전 0.20.4 이상의 세션 리플레이 Android SDK 또는 플러그인을 사용해야 합니다.

컴포저블에서 세션 리플레이가 캡처하는 내용을 제어하려면 Jetpack Compose의 개인정보 보호 수정자를 사용하세요. Compose에서 마스킹을 사용하려면 0.21.0 이상이 필요합니다.

알려진 제한 사항

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

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

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

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

• 세션 리플레이는 다음 Android 뷰를 캡처할 수 없습니다.

  • 캔버스 뷰

여러 Amplitude 인스턴스

세션 리플레이는 Amplitude SDK의 단일 인스턴스에 연결하는 것을 지원합니다. 응용 프로그램에 두 개 이상의 인스턴스가 장착되어 있는 경우 프로젝트와 가장 관련이 있는 인스턴스에서 세션 리플레이를 시작하십시오.

문제 해결

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

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

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

Amplitude에서 세션 리플레이가 나타나지 않습니다.

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

• 연결 끊킴
• 앱 프로세스가 종료되거나 보류 중인 리플레이 데이터가 업로드되기 전에 SDK를 종료하는 경우입니다.
• 샘플링

연결 끊킴

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

샘플링

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

세션 리플레이 처리 오류

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

• API 키 또는 기기 ID가 일치하지 않습니다. 이 문제는 세션 리플레이 및 표준 이벤트 계측이 서로 다른 API 키 또는 장치 ID를 사용하는 경우 발생할 수 있습니다.
• 세션 리플레이가 잘못된 프로젝트를 참조합니다.
• 짧은 세션. 초기화 후 몇 초 이내에 사용자가 페이지를 이탈하면 SDK가 리플레이 데이터를 업로드할 시간이 부족할 수 있습니다.
• 페이지 계측. 사용자가 방문하는 모든 페이지에 세션 리플레이 기능이 구현되지 않은 경우 해당 세션이 제대로 캡처되지 않을 수 있습니다.
• 설정된 리텐션 기간(기본값: 90일)이 지난 리플레이.

문제 리포트

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

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

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

캡처된 세션에는 제한된 정보가 포함됨

Amplitude는 세션 리플레이가 세션을 캡처할 때 자동으로 [Amplitude] Replay Captured 이벤트를 생성합니다. 구현에서 이 이벤트가 표시되지 않는 경우, 리플레이가 퍼널 분석, 세그멘테이션 또는 여정 분석 차트와 같은 Amplitude의 분석 도구에 제대로 표시되지 않을 수 있습니다. 세션 리플레이 홈 페이지 또는 사용자 프로필 페이지에서 세션 리플레이를 계속 확인할 수 있습니다.

이 이벤트가 나타나지 않을 수 있는 이유는 다음과 같습니다.

• 사용자가 선택 해제되었거나 현재 sampleRate에 해당되는 샘플 세트에 속하지 않습니다. 더 많은 세션을 캡처하려면 sampleRate을 늘립니다.
• 세션에 대한 optOut 구성을 활성화했습니다. optOut 및 sampleRate 설정에 세션이 포함되어 있는지 확인하십시오.
• 앱이 Android SDK 이외의 방법을 사용하여 이벤트를 계측합니다. Android용 세션 리플레이 독립형 SDK 사용을 고려해 보십시오.

이러한 설정을 확인했지만 여전히 이벤트가 표시되지 않는 경우 Amplitude 서포트에 문의하십시오.

재생 길이와 세션 길이가 일치하지 않습니다.

일부 시나리오에서는 재생 시간이 [Amplitude] Start Session 및 [Amplitude] End Session 이벤트 사이의 시간을 초과할 수 있습니다. 이 상황은 [Amplitude] End Session 이벤트가 발생한 후 사용자가 앱을 닫았지만 Android SDK 및 세션 리플레이 플러그인이 이벤트를 처리하기 전에 발생합니다. 사용자가 앱을 다시 사용하면 SDK와 플러그인이 이벤트를 처리하여 재생과 함께 Amplitude로 전송합니다. 이 시나리오를 확인하려면 End Session Client Event Time와 Client Upload Time 사이의 불일치를 확인하십시오.

세션 재생이 Amplitude에 나타나지 않습니다.

세션 재생은 다음과 같은 이유로 Amplitude에 나타나지 않을 수 있습니다.

• 연결성 부족. 앱이 인터넷에 액세스할 수 있는지 확인한 후 다시 시도하십시오.
• 앱을 종료하기 전에 녹화를 플러시하지 못했습니다.
• 현재 세션에서 Android SDK를 통해 전송된 이벤트가 없습니다.
• 누락된 [Amplitude] Replay Captured 이벤트입니다. 캡처된 세션에 제한된 정보가 포함되어 있는지 검토하십시오.
• 샘플링

샘플링

세션 리플레이의 기본 sampleRate는 0입니다. 속도를 더 높은 숫자로 업데이트하십시오. 자세한 내용은 샘플링 속도를 참조하십시오.

세션 리플레이 처리 오류

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

• API 키 또는 장치 ID가 일치하지 않습니다. 이 불일치는 세션 리플레이와 표준 이벤트 계측이 서로 다른 API 키 또는 장치 ID를 사용할 때 발생합니다.
• 세션 리플레이가 잘못된 프로젝트를 참조합니다.
• 짧은 세션. 사용자가 초기화 후 몇 초 이내에 앱을 닫으면 SDK가 리플레이 데이터를 업로드할 시간이 없을 수 있습니다.
• 페이지 계측. 사용자가 방문하는 모든 페이지에 세션 리플레이를 구현하지 않은 경우 세션이 제대로 캡처되지 않을 수 있습니다.
• 설정된 리텐션 기간(기본값은 90일)보다 오래된 리플레이.