세션 리플레이 Android 미들웨어

Early Access SDK

알파 릴리즈 버전인 이 SDK는 버그가 있을 수 있으며 충돌을 일으킬 수 있습니다. 프로덕션에서 활성화하기 전에 제어된 환경에서 앱을 철저하게 테스트하십시오. 개발자 미리 보기 SDK의 모범 사례에 대한 자세한 내용은 SDK 유지 관리 및 지원을 참조하십시오.

이 문서에서는 Android SDK 미들웨어를 사용하여 세션 리플레이를 설치하는 방법을 설명합니다. 앱이 이미 (유지 관리) Amplitude SDK를 사용하는 경우, 이 옵션을 사용하십시오.

앱에서 이미 (최신) Amplitude Android SDK를 사용하고 있는 경우, 세션 리플레이 Android SDK 플러그인을 사용하십시오.

제품 내 분석을 위해 Amplitude 이외의 공급자를 사용하는 경우, 독립형 구현을 선택하십시오.

세션 리플레이 및 성능

Amplitude는 세션 리플레이가 설치된 Android 앱의 성능에 미치는 영향을 최소화하기 위해 다음의 방식을 통해 세션 리플레이를 구축했습니다:

  • 기본 사용자 인터페이스 스레드가 차단되지 않도록 리플레이 데이터를 비동기적으로 캡처하고 처리합니다. 메인 스레드는 뷰 계층 구조를 분석해야 하지만, 스냅샷 캡처 스케줄링 및 추가 처리는 백그라운드로 오프로드합니다.
  • 배치 및 경량 압축을 사용하여 네트워크 연결 횟수와 대역폭을 줄입니다.
  • 뷰 계층 구조 처리 최적화. 계층 구조 처리에 문제가 발생하면 Amplitude에 문의하십시오.

시작하기 전에

세션 리플레이 미들웨어의 요구사항은 다음과 같습니다.

  1. 애플리케이션은 Android를 대상으로 합니다.
  2. (유지 보수) Amplitude Android SDK 버전 2.40.1 이상을 사용해야 합니다.
  3. SDK에 장치 ID를 제공할 수 있습니다.

지원되는 Android 버전

세션 리플레이는 Android 5.0까지 지원하며, 최소 SDK는 21 minSdk = 21입니다. Android Studio에서 Google의 배포 데이터에 따르면 이 기능은 글로벌 Android 기기의 99.6% 이상을 지원해야 합니다.

빠른 시작

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

kotlin
// Install latest version from Maven Central
implementation("com.amplitude:middleware-session-replay-android:0.26.1")
// You will also need the (maintenance) Amplitude Analytics SDK if it's not already installed
implementation("com.amplitude:android-sdk:[2.40.1,3.0.0)")

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

kotlin
import com.amplitude.api.Amplitude
import com.amplitude.api.SessionReplayMiddleware
// Initialize (maintenance) Amplitude Analytics SDK instance
val amplitude = Amplitude.getInstance()
    .initialize(this, AMPLITUDE_API_KEY)
    // Replay events will be flushed on close as well
    // If setFlushEventsOnClose(false) you must call flush() manually
    .setFlushEventsOnClose(true)
// Create Session Replay Middleware
val sessionReplayMiddleware = SessionReplayMiddleware(amplitude, sampleRate = 1.0)
// Add session replay middleware
// Recording will be handled automatically
amplitude.addEventMiddleware(sessionReplayMiddleware)
// Track events
amplitude.logEvent("Setup (maintenance) Amplitude Android SDK with session replay!")
// Send replay events to the server
amplitude.uploadEvents()
// You can also call flush() on the middleware directly to only send replay events
// sessionReplayMiddleware.flush()
// Always flush before app exit (onPause)
// override fun Activity.onPause() { sessionReplayMiddleware.flush() }

구성

세션 리플레이 미들웨어를 초기화할 때 다음 옵션을 전달하십시오.

화면상의 데이터 마스킹

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

마스크 수준

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

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

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

애플리케이션의 레이아웃 XML에서 이 옵션을 사용하십시오.

세션 리플레이 SDK의 개인정보 보호 메서드

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

kotlin
import com.amplitude.android.sessionreplay.SessionReplay

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

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

com.amplitude.android.sessionreplay.compose에서 필요한 수정자를 가져온 다음 컴포저블의 수정자 체인에 추가합니다.

kotlin
import com.amplitude.android.sessionreplay.compose.ampMask
import com.amplitude.android.sessionreplay.compose.ampUnmask
import com.amplitude.android.sessionreplay.compose.ampBlock
kotlin
// 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 설정을 따르며 사용자 옵트아웃을 자체적으로 지원하지 않습니다.

kotlin
import com.amplitude.api.Amplitude
import com.amplitude.api.SessionReplayMiddleware
// Set optOut on the Amplitude SDK
val amplitude = Amplitude.getInstance()
        .initialize(this, AMPLITUDE_API_KEY)
        .setOptOut(true)
amplitude.addEventMiddleware(SessionReplayMiddleware(amplitude, /* session replay options */))

EU 데이터 상주

세션 리플레이는 EU 데이터 센터를 사용하는 Amplitude 고객에게 제공됩니다. 초기화 중에 serverZone 구성 옵션을 EU(으)로 설정하십시오. 예를 들면 다음과 같습니다.

kotlin
import com.amplitude.api.Amplitude
import com.amplitude.api.SessionReplayMiddleware
// Set serverZone on the Amplitude SDK
val amplitude = Amplitude.getInstance()
        .initialize(this, AMPLITUDE_API_KEY)
        .setServerZone(AmplitudeServerZone.EU)
amplitude.addEventMiddleware(SessionReplayMiddleware(amplitude, /* session replay options */))

리플레이 업로드를 프록시로 전송

리플레이 업로드를 자체 서버를 통해 라우팅하려면 버전 0.33.0 이상SessionReplayMiddleware.Builder에서 사용할 수 있는 설정을 serverUrl사용하십시오. 프록시 요구 사항을 확인하려면 프록시 세션 리플레이 요청으로 이동하십시오.

kotlin
import com.amplitude.api.SessionReplayMiddleware
val sessionReplayMiddleware = SessionReplayMiddleware.Builder(amplitude)
    .sampleRate(1.0)
    .serverUrl("https://replay.yourdomain.com/sessions/v2/track")
    .build()
amplitude.addEventMiddleware(sessionReplayMiddleware)

샘플링 속도

기본적으로 세션 리플레이는 재생을 위해 세션의 0%를 캡처합니다. SDK의 sampleRate 구성 옵션을 사용하여 캡처할 세션의 비율을 설정합니다.

수동 및 동적 샘플링, 할당량 계획 및 할당량 계정에 대해서는 세션 리플레이 샘플링 구성으로 이동하십시오.

kotlin
// This configuration samples 1% of all sessions
amplitude.addEventMiddleware(SessionReplayMiddleware(amplitude, sampleRate = 0.01))

리플레이 수집 비활성화

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

  • 사용자가 앱을 떠납니다.
  • sessionReplayMiddleware.stop()을(를) 호출하십시오.

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

참조를 유지하십시오

SessionReplayMiddleware 인스턴스에 대한 참조를 유지하십시오: val sessionReplayMiddleware = SessionReplayMiddleware(/* session replay options */).

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

특정 화면만 캡처하려면 실행 시 시작되지 않도록 미들웨어를 autoStart = false로 초기화한 다음, 사용자가 해당 화면에 들어오고 나갈 때 start() 및 stop()를 호출하십시오.

kotlin
// Add the middleware without starting capture
val sessionReplayMiddleware = SessionReplayMiddleware(amplitude, sampleRate = 1.0, autoStart = false)
amplitude.addEventMiddleware(sessionReplayMiddleware)
// Start capture when the user enters a screen you want to record
sessionReplayMiddleware.start()
// Stop capture when the user leaves that screen
sessionReplayMiddleware.stop()

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

kotlin
import com.amplitude.api.Amplitude
import com.amplitude.api.SessionReplayMiddleware
// Your existing initialization logic with Android SDK
val amplitude = Amplitude.getInstance().initialize(this, AMPLITUDE_API_KEY)
if (nonEUCountryFlagEnabled) {
  // Create and Install Session Replay Middleware
  val sessionReplayMiddleware = SessionReplayMiddleware(amplitude, sampleRate = 0.5)
  amplitude.addEventMiddleware(sessionReplayMiddleware)
}

WebView 및 MapView 지원(베타)

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

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

로그 기록

가용성

로그 기록은 세션 리플레이 Android 0.22.0 이후 버전부터 사용할 수 있습니다.

세션 리플레이는 Android 애플리케이션에서 로그 기록을 지원합니다. 로그 기록을 활성화하려면 세션 리플레이를 초기화하는 동안 recordLog(level, message, timestamp) API를 통해 로그 메시지를 전송하고 recordLogOptions 매개 변수를 통해 제한을 구성하십시오.

kotlin
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를 사용하는 경우 사용자 지정 트리와 통합할 수 있습니다.

kotlin
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 구성(기본값)에서 amplitude.setFlushEventsOnClose(true)를 설정할 것을 권장합니다.

Jetpack Compose 지원 (알파)

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

세션 리플레이가 컴포저블에서 캡처하는 내용을 제어하려면 Jetpack Compose에서 개인정보 보호 모디파이어를 사용하십시오. Compose의 마스킹 지원을 사용하려면 0.21.0 이상의 버전이 필요합니다.

알려진 제한 사항

세션 리플레이를 구현할 때는 다음과 같은 제한 사항에 유의하십시오.

  • 세션 리플레이는 여러 프로젝트에 걸쳐 단일 사용자의 재생을 함께 연결하지 않습니다. 예를 들면 다음과 같습니다.

    • 여러 앱을 각각 세션 리플레이가 활성화된 상태로 별도의 Amplitude 프로젝트로 계측합니다.
    • 알려진 사용자가 한 앱에서 시작한 다음 다른 앱으로 전환합니다.
    • Amplitude는 두 세션을 모두 캡처합니다.
    • 각 세션의 재생은 해당 호스트 프로젝트에서 볼 수 있습니다.
  • 조직에서 사용자 정의 세션 정의를 사용하는 경우 사용자 세션 차트에 세션 재생이 표시되지 않습니다.

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

    • Canvas 뷰

이 내용이 도움이 되었나요?

For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

이 페이지에서