세션 리플레이 Android 독립형 SDK

이 문서에서는 독립형 SDK를 사용하여 Android용 세션 리플레이를 설치하는 방법을 설명합니다. 제품 내 분석을 위해 Amplitude 이외의 공급자를 사용하는 경우, 이 옵션을 선택하십시오. 앱에서 이미 Amplitude Android SDK를 사용하고 있는 경우, 세션 리플레이 Android SDK 플러그인을 대신 사용하십시오.

시작하기 전에

세션 리플레이 독립형 SDK를 사용하려면 다음이 필요합니다.

1. 사용자의 애플리케이션은 Android 기반입니다.
2. 타임스탬프 또는 SDK에 전달할 수 있는 사용자 지정 문자열 세션 ID를 사용하여 세션을 추적합니다. 세션 식별자가 변경될 때마다 SDK에 알립니다.
3. SDK에 장치 ID를 제공할 수 있습니다.
4. 독립형 SDK에 전달하는 Session ID 및 Device ID는 Amplitude에 이벤트 속성으로 전송되는 항목과 일치합니다.

독립형 SDK는 세션 관리 기능을 제공하지 않습니다. 애플리케이션 또는 타사 연동 기능은 Session ID 및 Device ID에 대한 변경 사항을 적용하여 SDK를 업데이트해야 합니다.

지원되는 Android 버전

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

빠른 시작

최신 버전의 세션 리플레이 SDK를 프로젝트 종속성에 추가하십시오.

implementation("com.amplitude:session-replay-android:0.33.0")

애플리케이션 코드를 구성합니다.

1. 리플레이 수집을 시작하려면 val sessionReplay = SessionReplay() 객체를 생성합니다. API 키, 세션 식별자 및 장치 식별자를 전달합니다.
2. 세션 또는 기기 식별자가 변경되면 sessionReplay.setSessionId 또는 sessionReplay.setDeviceId를 사용하여 새 값을 Amplitude에 전달하십시오. 문자열 세션 ID의 경우 sessionReplay.setCustomSessionId을 대신 사용하십시오. 사용자 지정 세션 ID를 참조하십시오.
3. 세션 리플레이 데이터를 Amplitude로 전송하려면 sessionReplay.flush를 호출하십시오. 앱이 종료되거나 백그라운드로 이동하기 전에 항상 flush를 호출하십시오. 세션이 길어질 경우 메모리 사용량이 높아지지 않도록 flush를 자주 호출하십시오(알파).

import com.amplitude.android.sessionreplay.SessionReplay
import com.example.ThirdPartyAnalytics
// Initialize the standalone session replay SDK
val sessionReplay = SessionReplay(
    apiKey = "api-key",
    context = applicationContext,
    deviceId = "device-id",
    sessionId = Date().time,
    sampleRate = 1.0,
)
// Handle session ID change
// Whenever the session ID changes
ThirdPartyAnalytics.setSessionId(sessionId)
// Update the session ID in session replay
sessionReplay.setSessionId(ThirdPartyAnalytics.getSessionId())
// Handle device ID change
// When the device ID changes
ThirdPartyAnalytics.setDeviceId(deviceId)
//Update the device ID in session replay
sessionReplay.setDeviceId(ThirdPartyAnalytics.getDeviceId())
// Send session replay data to the server
// This should always be called before app exit
sessionReplay.flush()

구성

세션 리플레이 SDK를 초기화할 때 다음 구성 옵션을 전달하십시오.

사용자 지정 세션 ID

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

생성자는 숫자 sessionId만 허용합니다. 문자열 값을 사용하려면 -1를 sessionId(으)로 전달한 다음 setCustomSessionId를 호출하십시오. 유효한 세션 ID를 설정할 때까지 세션 리플레이는 캡처되지 않습니다.

val sessionReplay = SessionReplay(
    apiKey = API_KEY,
    context = applicationContext,
    deviceId = "device-id",
    sessionId = -1,
    sampleRate = 1.0,
)
// Set a string session ID instead of the numeric sessionId
sessionReplay.setCustomSessionId("ef197fc7-a46f-4e6c-a77f-8d90c17065c0")
// Whenever your custom session changes
sessionReplay.setCustomSessionId(ThirdPartyAnalytics.getCustomSessionId())

숫자 sessionId와 사용자 지정 세션 ID는 동일한 기본 값에 대한 두 가지 뷰이며, SDK는 이를 문자열로 저장합니다.

• setSessionId를 호출하면 현재 사용자 지정 세션 ID가 숫자 값으로 바뀝니다. 사용자 지정 세션 ID를 사용할 경우 세션이 변경될 때마다 setCustomSessionId를 setSessionId 대신 호출하십시오.
• 저장된 값이 숫자가 아닐 경우 getSessionId는 -1를 반환합니다. 현재 값을 읽으려면 getCustomSessionId를 호출하십시오.
• 다른 값을 설정하면 현재 재생이 종료되고 새 재생이 시작됩니다.

세션 리플레이가 사용자 정의 세션을 안정적으로 일치시키려면 사용자 정의 세션 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")
}

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

사용자 옵트아웃

세션 리플레이는 옵트아웃 구성 옵션을 제공합니다. Amplitude가 세션 리플레이를 수집하지 못하도록 초기화 중에 optOut = true을(를) 전달하세요. 예를 들면 다음과 같습니다.

// Pass a boolean value to indicate a users opt-out status
val sessionReplay = SessionReplay(
    apiKey = API_KEY,
    optOut = true,
    /* other session replay options */
)

EU 데이터 레지던시

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

// Set serverZone to EU
val sessionReplay = SessionReplay(
    apiKey = API_KEY,
    serverZone = ServerZone.EU,
    /* other session replay options */
)

샘플링 비율

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

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

// This configuration samples 1% of all sessions
val sessionReplay = SessionReplay(
    apiKey = API_KEY,
    sampleRate = 0.01,
    /* other session replay options */
)

리플레이 수집 비활성화

세션 리플레이가 시작된 후 다음 중 하나가 발생할 때까지 앱에서 실행됩니다:

• 사용자가 앱을 떠납니다.
• sessionReplay.stop()을(를) 호출하십시오.
• 인스턴스를 제거하기 위해 sessionReplay.shutdown()를 호출합니다.

사용자가 앱의 제한된 영역에 있는 동안 리플레이 수집을 일시 중지하려면, 해당 영역으로 이동하기 전에 sessionReplay.stop()를 호출하십시오. 돌아오면 sessionReplay.start()에 전화하여 재개하십시오. 두 메서드는 동일한 인스턴스에서 작동합니다.

세션 리플레이를 완전히 해제하려면 sessionReplay.shutdown()를 호출한 다음 새 인스턴스를 생성하여 다시 시작하십시오.

특정 화면만 캡처하려면 앱 실행 시 자동으로 시작되지 않도록 autoStart = false를 사용하여 세션 리플레이를 초기화한 다음, 사용자가 해당 화면에 들어오거나 나갈 때 start() 및 stop()를 호출하십시오.

val sessionReplay = SessionReplay(
    apiKey = API_KEY,
    context = applicationContext,
    deviceId = "device-id",
    sessionId = Date().time,
    autoStart = false,
)
// Start capture when the user enters a screen you want to record
sessionReplay.start()
// Stop capture when the user leaves that screen
sessionReplay.stop()

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

import com.amplitude.android.sessionreplay.SessionReplay
import com.example.ThirdPartyAnalytics
val sessionReplay = SessionReplay(
    apiKey = API_KEY,
    deviceId = "device-id",
    sessionId = Date().time,
    sampleRate = 1.0,
    /* other session replay options */
)

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

Jetpack Compose 지원 (알파)

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

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

알려진 제한 사항

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

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

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

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

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

  • 캔버스 뷰

문제 해결

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

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

일부 시나리오에서는 리플레이 길이가 [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 버전
• 관련된 모든 오류 메시지 또는 로그