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.
세션 리플레이 Android 미들웨어
얼리 액세스 SDK
이 SDK는 알파 릴리스로서 버그를 포함하고 있거나 충돌을 일으킬 수 있습니다. 프로덕션에서 활성화하기 전에 제어된 환경에서 앱을 철저히 테스트하세요. 개발자 미리 보기 SDK의 모범 사례에 대한 자세한 내용은 SDK 유지 관리 및 지원을 참조하십시오.
이 문서에서는 Android SDK 미들웨어를 사용하여 세션 리플레이를 설치하는 방법을 설명합니다. 앱이 이미 (유지 관리) Amplitude SDK를 사용하는 경우, 이 옵션을 사용하십시오.
앱에서 이미 (최신) Amplitude Android SDK를 사용하고 있는 경우, 세션 리플레이 Android SDK 플러그인을 사용하십시오.
제품 내 분석을 위해 Amplitude 이외의 공급자를 사용하는 경우, 독립형 구현을 선택하십시오.
세션 리플레이 및 성능
Amplitude는 다음을 통해 설치된 Android 앱의 성능에 미치는 영향을 최소화하기 위해 세션 리플레이 기능을 구축했습니다.
- 주 사용자 인터페이스 스레드를 차단하지 않도록 리플레이 데이터를 비동기적으로 캡처 및 처리합니다. 뷰 계층 구조는 메인 스레드에서 분석해야 하지만, 스냅샷 캡처 예약과 추가 처리는 백그라운드에서 수행됩니다.
- 배치 및 경량 압축을 사용하여 네트워크 연결 수와 대역폭을 줄입니다.
- 뷰 계층 구조 처리 최적화. 계층 구조 처리에 문제가 있으면 Amplitude에 문의하십시오.
시작하기 전에
세션 리플레이 미들웨어의 요구사항은 다음과 같습니다.
- 애플리케이션은 Android를 대상으로 합니다.
- (유지 보수) Amplitude Android SDK 버전
2.40.1이상을 사용해야 합니다. - SDK에 장치 ID를 제공할 수 있습니다.
지원되는 Android 버전
세션 리플레이는 최소 SDK 21 minSdk = 21의 Android 5.0까지 지원합니다. Android Studio의 Google 배포 데이터에 따르면 전 세계 Android 기기의 99.6% 이상을 지원합니다.
빠른 시작
최신 버전의 세션 리플레이 미들웨어를 프로젝트 종속성에 추가하십시오.
// 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)")
애플리케이션 코드를 구성합니다.
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() }
구성
세션 리플레이 미들웨어를 초기화할 때 다음 옵션을 전달하십시오.
| 옵션 | 유형 | 필수 | 기본값 | 설명 |
|---|---|---|---|---|
amplitude | AmplitudeClient | 예 | 해당 없음 | 연결할 유지 관리 Amplitude SDK 클라이언트 인스턴스입니다. |
sampleRate | Number | 아니요 | 0.0 | Amplitude가 재생 수집을 위해 선택하는 세션 수를 제어합니다. 예를 들어 0.4처럼 0과 1 사이의 소수를 사용하면 많은 수의 세션에 대해 40%의 세션을 선택하게 됩니다. |
enableRemoteConfig | Boolean | 아니요 | true | 이 세션 리플레이 인스턴스에 대한 원격 구성을 활성화하거나 비활성화합니다. |
privacyConfig | PrivacyConfig | 아니요 | PrivacyConfig() | 마스크되는 뷰를 제어하는 개인정보 보호 설정입니다. PrivacyConfig(maskLevel = MaskLevel.MEDIUM)를 사용하여 마스크 수준을 설정합니다. 마스크 수준을 참조하십시오. |
autoStart | Boolean | 아니요 | true | 미들웨어가 초기화될 때 자동으로 화면 캡처를 시작합니다. |
bandwidthLimitBytes | Int? | 아니요 | null | 고급옵션. 종량제(예: 셀룰러) 연결에서의 바이트 단위 일일 업로드 제한입니다. |
storageLimitMB | Int? | 아니요 | null | 고급옵션. 로컬 스토리지 제한(MB)입니다. |
recordLogOptions.logCountThreshold | Int | 아니요 | 1000 | 세션당 최대 로그 수입니다. |
recordLogOptions.maxMessageLength | Int | 아니요 | 2000 | 로그 메시지의 최대 길이입니다. |
화면상의 데이터 마스킹
세션 리플레이 SDK는 사용자 입력, 텍스트 및 기타 보기 구성 요소를 마스킹하는 네 가지 방법을 제공합니다.
마스크 수준
Android용 세션 리플레이는 PrivacyConfig(maskLevel = MaskLevel.MEDIUM)와 함께 privacyConfig 옵션을 통해 설정되는 세 가지 수준의 마스킹을 지원합니다. 기본 수준은 medium입니다.
이 옵션은 세션 리플레이 구성에서 사용하십시오.
| 마스크 수준 | 설명 |
|---|---|
light | 암호, 이메일 및 전화번호 입력 필드를 숨깁니다. SDK 0.26.2 이상에서는 light 수준에서도 민감한 자동 채우기 힌트(신용카드 번호, 만료일, 보안 코드, 이름, 사용자 이름, 우편 주소 및 코드)가 설정된 모든 필드를 마스킹합니다. 자동 완성 힌트 감지 기능을 사용하려면 Android 8.0(API 26) 이상이 필요합니다. middleware-session-replay-android 아티팩트를 포함한 이전 버전에서는 위의 입력 필드 유형만 마스킹합니다. |
medium (기본값) | light 설정에 포함된 모든 항목과 편집 가능한 모든 텍스트 필드(EditText)를 포함합니다. |
conservative | medium 수준에 포함된 모든 항목과 모든 텍스트 뷰(TextView)를 포함합니다. |
레이아웃 XML의 개인정보 보호 태그
이 옵션을 응용 프로그램의 레이아웃 XML에 사용하십시오.
| 보기 | 설명 |
|---|---|
<EditText> | 세션 리플레이는 기본적으로 모든 텍스트 입력 필드를 마스크합니다. 사용자가 입력 필드에 텍스트를 입력하면 세션 리플레이는 텍스트 대신 별표(*)를 캡처합니다. 텍스트 입력의 마스크를 해제하려면 amp-unmask 태그를 추가하십시오. 예시: <EditText android:tag="amp-unmask" android:text="Unmask this">. |
<TextView> | 입력 요소가 아닌 요소 내의 텍스트를 마스크하려면 amp-mask 태그를 추가하십시오. 예를 들어 <TextView android:tag="amp-mask" android:text="Mask this"/>. 마스크가 적용되면 세션 리플레이는 마스크된 텍스트를 일련의 별표로 캡처합니다. |
| 텍스트가 아닌 요소 | 텍스트가 아닌 요소를 차단하려면 amp-block 태그를 추가하십시오. 예를 들어, <ImageView android:tag="amp-block"/>입니다. 세션 리플레이는 차단된 요소를 동일한 크기의 위치 지정자로 대체합니다. |
<WebView> | 웹 뷰의 마스크를 해제하려면 amp-unmask 태그를 추가하십시오. 예를 들어, <WebView android:tag="amp-unmask"/>와 같습니다. |
세션 리플레이 SDK의 개인정보 보호 방법
SessionReplay 클래스를 가져온 다음 애플리케이션 코드에서 아래 메서드 중 하나를 호출하십시오.
import com.amplitude.android.sessionreplay.SessionReplay
| 방법 | 설명 |
|---|---|
unmask(view: View) | 뷰의 마스크를 수동으로 해제하려면 SessionReplay.unmask(view)를 호출하십시오. 여기서 view는 마스크된 뷰에 대한 참조입니다. |
mask(view: View) | 입력 필드가 아닌 뷰의 텍스트를 마스크하려면 SessionReplay.mask(view)를 호출하십시오. 여기서 view는 마스크하려는 뷰에 대한 참조입니다. 마스크가 적용되면 세션 리플레이는 마스크된 텍스트를 일련의 별표로 캡처합니다. |
block(view: View) | 텍스트가 아닌 뷰를 차단하려면 SessionReplay.block(view)을 호출하십시오. 여기서 view는 차단하려는 뷰에 대한 참조입니다. 세션 리플레이 기능은 차단된 뷰를 동일한 크기의 위치 표시자로 대체합니다. |
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
| 수정자 | 설명 |
|---|---|
Modifier.ampMask() | Text 컴포저블의 콘텐츠처럼 세션 리플레이가 기본적으로 캡처하는 텍스트를 마스크합니다. 세션 리플레이는 마스크된 텍스트를 일련의 별표로 캡처합니다. |
Modifier.ampUnmask() | 세션 리플레이가 기본적으로 마스킹하는 컴포저블(예: TextField)의 마스킹을 해제합니다. |
Modifier.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 설정을 따르며 사용자 옵트아웃을 자체적으로 지원하지 않습니다.
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로 설정하십시오. 예를 들어:
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%를 수집하도록 설정되어 있습니다. SDK의 sampleRate 구성 옵션을 사용하여 캡처할 세션의 비율을 설정합니다.
수동 및 동적 샘플링, 할당량 계획 및 할당량 계산에 대한 자세한 내용은 세션 리플레이 샘플링 구성을 참조하세요.
// 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()를 호출하십시오.
// 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 실험과 같은 기능 플래그 제품을 사용하여 위치와 같은 기준에 따라 리플레이 수집을 활성화하거나 비활성화할 수도 있습니다. 예를 들어, 특정 사용자 그룹을 대상으로 하는 기능 플래그를 생성하고 이를 초기화 논리에 추가합니다.
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로 설정합니다.
로그 기록
이용 가능 여부
로그 기록 기능은 세션 리플레이 Android0.22.0 이상 버전에서 사용할 수 있습니다.세션 리플레이는 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 구성(기본값)에서 amplitude.setFlushEventsOnClose(true)를 설정할 것을 권장합니다.
Jetpack Compose 지원 (알파)
세션 리플레이는 Android 애플리케이션용 Jetpack Compose를 지원합니다. 이 기능은 현재 알파 버전입니다. Jetpack Compose를 세션 리플레이 기능과 함께 사용하려면 버전 0.20.4 이상의 세션 리플레이 Android SDK 또는 플러그인을 사용해야 합니다.
컴포저블에서 세션 리플레이가 캡처하는 내용을 제어하려면 Jetpack Compose의 개인정보 보호 수정자를 사용하세요. Compose에서 마스킹을 사용하려면 0.21.0 이상이 필요합니다.
알려진 제한 사항
세션 리플레이 구현 시 다음 제한 사항을 염두에 두십시오.
세션 리플레이는 여러 프로젝트에 걸쳐 있는 동일 사용자의 리플레이를 하나로 연결하여 재생하지 않습니다. 예를 들어:
- 여러 앱을 별도의 Amplitude 프로젝트로 계측할 수 있으며 각 프로젝트에서 세션 리플레이 기능이 활성화되어 있습니다.
- 식별된 사용자는 한 앱에서 시작한 다음 다른 앱으로 전환합니다.
- Amplitude는 두 세션을 모두 캡처합니다.
- 각 세션의 리플레이는 해당 호스트 프로젝트에서 확인할 수 있습니다.
조직에서 사용자 세션 정의를 사용하는 경우 사용자 세션 차트에는 세션 리플레이가 표시되지 않습니다.
세션 리플레이는 다음 Android 뷰를 캡처할 수 없습니다.
- 캔버스 뷰
이 내용이 도움이 되었나요?