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.
실험 Ruby SDK
Amplitude Experiment의 서버 측 Ruby SDK 구현에 대한 공식 문서입니다.
이 문서는 원격 및 로컬 평가를 위해 두 섹션으로 나뉘어져 있습니다.
원격 평가
원격 평가를 사용하여 사용자의 변형 가져오기를 구현합니다.
설치
Ruby 버전 호환성
Ruby 서버 SDK는 Ruby 2.0 이상에서 작동합니다.
번들러 또는 gem을 직접 사용하여 Ruby 서버 SDK를 설치하십시오.
gem 'amplitude-experiment'
빠른 시작
require 'amplitude-experiment'
# (1) Initialize the experiment client
experiment = AmplitudeExperiment.initialize_remote('<DEPLOYMENT_KEY>', AmplitudeExperiment::RemoteEvaluationConfig.new)
# (2) Fetch variants for a user
user = AmplitudeExperiment::User.new(
user_id: 'user@company.com',
device_id: 'abcdefg',
user_properties: {
'premium' => true
}
)
variants = experiment.fetch_v2(user)
# (3) Access a flag's variant
variant = variants['YOUR-FLAG-KEY']
unless variant.nil?
if variant.value == 'on'
# Flag is on
else
# Flag is off
end
end
초기화
서버 시작 시 서버에서 SDK 클라이언트를 초기화합니다.apiKey 매개변수에 전달하는 배포 키 인수는 분석 이벤트를 전송하는 동일한 프로젝트 내에 있어야 합니다.
initialize_remote(apiKey, config = nil) : Client
시간 초과 및 재시도 구성
성능 요구 사항에 가장 적합한 시간 초과 및 재시도 옵션을 구성하십시오.
experiment = AmplitudeExperiment.initialize_remote('<DEPLOYMENT_KEY>', AmplitudeExperiment::RemoteEvaluationConfig.new)
구성
초기화 시 SDK 클라이언트를 구성할 수 있습니다.
EU 데이터 센터
Amplitude의 EU 데이터 센터를 사용하고 있는 경우, 초기화 시 server_zone 옵션을 구성하십시오.
| 이름 | 설명 | 기본값 |
|---|---|---|
debug | true이면 로거 수준을 DEBUG로 설정합니다. | false |
logger | SDK 로깅을 위한 사용자 지정 로거 인스턴스입니다. | ERROR 레벨의 기본 로거 |
server_zone | 사용할 Amplitude 데이터 센터입니다. ServerZone::US 또는 ServerZone::EU | ServerZone::US |
server_url | 변형을 가져올 호스트입니다. | https://api.lab.amplitude.com |
fetch_timeout_millis | 변형을 가져오는 데 필요한 시간 초과(밀리초)입니다. 이 시간 초과는 초기 요청에만 적용되며 후속 재시도에는 적용되지 않습니다 | 10000 |
fetch_retries | 변형 가져오기 요청이 실패할 경우 시도할 재시도 횟수입니다. | 0 |
fetch_retry_backoff_min_millis | 변형 가져오기 요청이 실패한 이후의 최소한(초기) 백오프입니다. SDK는 fetchRetryBackoffScalar에 따라 이 지연을 조정합니다. | 500 |
fetch_retry_backoff_max_millis | 재시도 간의 최대 백오프입니다. 스케일링된 백오프가 최대값보다 커지면 SDK는 모든 후속 요청에 대해 최대값을 사용합니다. | 10000 |
fetch_retry_backoff_scalar | 최소 백오프를 기하급수적으로 확장합니다. | 1.5 |
fetch_retry_timeout_millis | 변형 가져오기를 재시도하기 위한 요청 시간 초과입니다. | 10000 |
가져오기
사용자의 변형을 가져오고 결과를 반환합니다. 원격으로 평가 함수는 SDK 클라이언트를 초기화하는 데 사용된 배포와 관련된 플래그에 대해 사용자를 평가합니다.
fetch_v2(user: AmplitudeExperiment::User, fetch_options: AmplitudeExperiment::FetchOptions = nil) : Variants
FetchOptions
| 이름 | 설명 | 기본값 |
|---|---|---|
tracks_exposure | 이 가져오기 요청에 대한 노출 이벤트를 추적할지 여부입니다. nil인 경우 서버의 기본 동작을 사용합니다(노출을 추적하지 않음). | nil |
tracks_assignment | 이 가져오기 요청에 대한 할당 이벤트를 추적할지 여부입니다. nil인 경우 서버의 기본 동작을 사용합니다(트랙 할당 수행). | nil |
user = AmplitudeExperiment::User.new(
user_id: 'user@company.com',
device_id: 'abcdefg',
user_properties: {
'premium' => true
}
)
variants = experiment.fetch_v2(user)
사용자의 변형을 가져온 후에는 특정 플래그의 변형에 액세스할 수도 있습니다.
variant = variants['YOUR-FLAG-KEY']
unless variant.nil?
if variant.value == 'on'
# Flag is on
else
# Flag is off
end
end
비동기식 가져오기
fetch 메서드는 동기식입니다. 비동기적으로 가져오려면 fetch_async 메서드를 사용할 수 있습니다.
fetch_async_v2(user: AmplitudeExperiment::User, fetch_options: AmplitudeExperiment::FetchOptions = nil, &callback)
experiment.fetch_async_v2(user) do |_, variants|
variant = variants['sdk-ci-test']
unless variant.nil?
if variant.value == 'on'
# Flag is on
else
# Flag is off
end
end
end
지역 평가
로컬 평가를 사용하여 사용자에 대한 변형 평가를 구현합니다. 로컬 평가를 사용하려는 경우 장단점을 이해해야 합니다.
설치
Ruby Server SDK의 로컬 평가 기능을 설치합니다.
운영 체제 및 아키텍처 지원
로컬 평가 패키지는 다음과 같은 운영 체제 및 아키텍처를 지원합니다(OS/ARCH):
지원됨
- darwin/amd64
- darwin/arm64
- linux/amd64
- 리눅스/arm64
로컬 평가 패키지는 현재 알파인 리눅스를 지원하지 않습니다.
다른 OS/Arch 지원이 필요하다면 GitHub에 이슈를 제출하거나 experiment@amplitude.com으로 이메일을 보내주십시오.
번들러 또는 gem을 직접 사용하여 Ruby 서버 SDK를 설치하십시오.
Ruby 버전 호환성
Ruby 서버 SDK는 Ruby 2.0 이상에서 작동합니다.
gem 'amplitude-experiment'
빠른 시작
require 'amplitude-experiment'
# (1) Initialize the local evaluation client with a server deployment key.
experiment = AmplitudeExperiment.initialize_local('DEPLOYMENT_KEY',
# (Recommended) Enable local evaluation cohort targeting.
AmplitudeExperiment::LocalEvaluationConfig.new(
cohort_sync_config: AmplitudeExperiment::CohortSyncConfig.new(
api_key: 'API_KEY',
secret_key: 'SECRET_KEY'
)
)
)
# (2) Start the local evaluation
experiment.start
# (3) Evaluate a user
user = AmplitudeExperiment::User.new(
user_id: 'user@company.com',
device_id: 'abcdefg',
user_properties: {
'premium' => true
}
)
variants = experiment.evaluate_v2(user)
variant = variants['YOUR-FLAG-KEY']
unless variant.nil?
if variant.value == 'on'
# Flag is on
else
# Flag is off
end
end
초기화
로컬 평가 클라이언트를 초기화합니다.
AmplitudeExperiment.initialize_local(api_key)
플래그 폴링 간격
flag_config_polling_interval_millis 구성 설정을 사용하여 수정 후 플래그 구성이 업데이트되는 데 걸리는 시간을 결정합니다(기본값 30초).
구성
초기화 시 SDK 클라이언트를 구성할 수 있습니다.
EU 데이터 센터
Amplitude의 EU 데이터 센터를 사용하는 경우, 초기화 시 server_zone 옵션을 구성하십시오.
LocalEvaluationConfig
| 이름 | 설명 | 기본값 |
|---|---|---|
server_zone | 사용할 Amplitude 데이터 센터입니다. ServerZone::US 또는 ServerZone::EU | ServerZone::US |
server_url | 플래그 구성을 가져올 호스트입니다. | https://api.lab.amplitude.com |
bootstrap | 플래그 키와 플래그 구성의 매핑을 사용하여 클라이언트를 부트스트랩 | {} |
flag_config_polling_interval_millis | start 호출 후 업데이트된 플래그 구성을 폴링하는 간격 | 30000 |
debug | true이면 로거 수준을 DEBUG로 설정합니다. | false |
logger | SDK 로깅을 위한 사용자 지정 로거 인스턴스입니다. | ERROR 레벨의 기본 로거 |
assignment_config | 더 이상 사용되지 않습니다. 평가 후 할당 이벤트를 자동으로 추적하기 위한 구성입니다. | nil |
exposure_config | 평가 후 노출 이벤트를 추적하기 위한 구성입니다. | nil |
cohort_sync_config | 로컬 평가 코호트 타겟팅을 위해 코호트 다운로드를 활성화하는 구성입니다. | nil |
할당설정
api_key- 설명: 분석 API 키이며 실험 배포 키가 아닙니다.
- 기본값: 필수
cache_capacity- 설명: 할당 캐시에 저장되는 할당의 최대 수
- 기본값:
65536
flush_queue_size- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 이벤트 수가
flush_queue_size에 도달하면 버퍼가 플러시됩니다. - 기본값:
200
- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 이벤트 수가
flush_interval_millis- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 버퍼는
flush_interval_millis밀리초마다 플러시됩니다. - 기본값:
10 seconds
- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 버퍼는
flush_max_retries- 설명: 요청이 오류를 반환할 때 클라이언트가 이벤트를 재시도하는 횟수입니다.
- 기본값:
12
logger- 설명: Amplitude 클라이언트에서 사용하는 로거 인스턴스입니다.
- 기본값: 기본 Ruby 로거
min_id_length- 설명:
user_id및device_id의 최소 길이. - 기본값:
5
- 설명:
callback- 설명:
- 클라이언트 수준의 콜백 함수. 세 가지 매개변수를 사용합니다.
- event: 이벤트 인스턴스
- code: HTTP 응답 코드 정수
- message: 문자열 메시지입니다.
- 기본값:
nil
- 설명:
server_zone- 설명: 프로젝트의 서버 영역입니다.
EU및US을 지원합니다. EU 데이터 보관의 경우EU로 변경하십시오. - 기본값:
US
- 설명: 프로젝트의 서버 영역입니다.
server_url- 설명: 실험에서 이벤트를 전송하는 API 엔드포인트 URL입니다.
server_zone및use_batch에 의해 자동으로 선택됩니다. 이 필드를nil대신 문자열 값으로 설정하면 SDK는server_zone및use_batch을 무시하고 문자열 값을 사용합니다. - 기본값:
https://api2.amplitude.com/2/httpapi
- 설명: 실험에서 이벤트를 전송하는 API 엔드포인트 URL입니다.
use_batch- 설명: 배치 API를 사용할 것인지 여부입니다. 기본적으로 SDK는 기본
serverUrl을 사용합니다. - 기본값:
False
- 설명: 배치 API를 사용할 것인지 여부입니다. 기본적으로 SDK는 기본
storage_provider- 설명: 스토리지 버퍼에 이벤트를 보관하기 위해 스토리지 인스턴스를 생성하는 데 사용됩니다. 스토리지 버퍼의 이벤트가 전송되기를 기다리고 있습니다.
- 기본값:
InMemoryStorageProvider
opt_out- 설명: 옵트아웃 옵션입니다.
True로 설정된 경우 클라이언트는 이벤트를 처리하거나 전송하지 않습니다. - 기본값:
False
- 설명: 옵트아웃 옵션입니다.
ExposureConfig
api_key- 설명: 분석 API 키이며 실험 배포 키가 아닙니다.
- 기본값: 필수
cache_capacity- 설명: 노출 캐시에 저장된 최대 노출 수
- 기본값:
65536
flush_queue_size- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 이벤트 수가
flush_queue_size에 도달하면 버퍼가 플러시됩니다. - 기본값:
200
- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 이벤트 수가
flush_interval_millis- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 버퍼는
flush_interval_millis밀리초마다 플러시됩니다. - 기본값:
10 seconds
- 설명: 이벤트는 버퍼에서 대기하며, 실험은 이를 일괄 전송합니다. 버퍼는
flush_max_retries- 설명: 요청이 오류를 반환할 때 클라이언트가 이벤트를 재시도하는 횟수입니다.
- 기본값:
12
logger- 설명: Amplitude 클라이언트에서 사용하는 로거 인스턴스입니다.
- 기본값: 기본 Ruby 로거
min_id_length- 설명:
user_id및device_id의 최소 길이. - 기본값:
5
- 설명:
callback- 설명:
- 클라이언트 수준의 콜백 함수. 세 가지 매개변수를 사용합니다.
- event: 이벤트 인스턴스
- code: HTTP 응답 코드 정수
- message: 문자열 메시지입니다.
- 기본값:
nil
- 설명:
server_zone- 설명: 프로젝트의 서버 영역입니다.
EU및US을 지원합니다. EU 데이터 보관의 경우EU로 변경하십시오. - 기본값:
US
- 설명: 프로젝트의 서버 영역입니다.
server_url- 설명: 실험에서 이벤트를 전송하는 API 엔드포인트 URL입니다.
server_zone및use_batch에 의해 자동으로 선택됩니다. 이 필드를nil대신 문자열 값으로 설정하면 SDK는server_zone및use_batch을 무시하고 문자열 값을 사용합니다. - 기본값:
https://api2.amplitude.com/2/httpapi
- 설명: 실험에서 이벤트를 전송하는 API 엔드포인트 URL입니다.
use_batch- 설명: 배치 API를 사용할 것인지 여부입니다. 기본적으로 SDK는 기본
serverUrl을 사용합니다. - 기본값:
False
- 설명: 배치 API를 사용할 것인지 여부입니다. 기본적으로 SDK는 기본
storage_provider- 설명: 스토리지 버퍼에 이벤트를 보관하기 위해 스토리지 인스턴스를 생성하는 데 사용됩니다. 스토리지 버퍼의 이벤트가 전송되기를 기다리고 있습니다.
- 기본값:
InMemoryStorageProvider
opt_out- 설명: 옵트아웃 옵션입니다.
True로 설정된 경우 클라이언트는 이벤트를 처리하거나 전송하지 않습니다. - 기본값:
False
- 설명: 옵트아웃 옵션입니다.
CohortSyncConfig
| 이름 | 설명 | 기본값 |
|---|---|---|
api_key | 분석 API 키이며 실험 배포 키가 아닙니다. | 필수 |
secret_key | 분석 비밀 키 | 필수 |
max_cohort_size | SDK가 다운로드할 수 있는 코호트의 최대 크기입니다. SDK는 이 크기보다 큰 코호트를 다운로드하지 않습니다. | 2147483647 |
cohort_polling_interval_millis | 코호트 업데이트를 위해 Amplitude를 폴링하는 간격(밀리초 단위)입니다(최소 60000). | 60000 |
cohort_server_url | 코호트 데이터를 가져올 원본인 코호트 서버 엔드포인트입니다. EU 데이터 센터를 사용하려면 server_zone로EU 설정하십시오. 이 값을 설정하면 server_zone 기본값보다 우선하여 적용됩니다. | https://cohort-v2.lab.amplitude.com |
시작
로컬 평가 클라이언트를 시작하여 평가를 위한 로컬 평가 모드 플래그 구성을 미리 가져오고 구성된 간격에 따라 플래그 구성 폴러를 시작합니다.
start
evaluate()를 호출하기 전에 플래그 구성을 사용할 준비가 되었는지 확인하려면 start의 결과를 기다려야 합니다.
experiment.start
평가
start에서 미리 가져온 플래그를 사용하여 평가 로직을 실행합니다. evaluate에 사용자 객체 인수를 지정해야 합니다. 플래그 변형의 특정 하위 집합만 필요한 경우 선택적으로 플래그 키 배열을 전달할 수 있습니다.
노출 추적
노출 추적을 활성화하려면 exposure_config을 설정하십시오. 그런 다음 evaluate_v2()을 호출할 때 EvaluateOptions의 tracks_exposure을 true(으)로 설정하십시오.
evaluate_v2(user: AmplitudeExperiment::User, flag_keys: Array[String] = [], options: AmplitudeExperiment::EvaluateOptions = nil) : Hash[String, Variant]
# The user to evaluate
user = AmplitudeExperiment::User.new(user_id: 'test-user')
# Evaluate all flag variants
all_variants = experiment.evaluate_v2(user)
# Evaluate a specific subset of flag variants
specific_variants = experiment.evaluate_v2(user, ["<FLAG_KEY_1>", "<FLAG_KEY_2>"])
# Access a variant
variant = all_variants["<FLAG_KEY>"]
if variant.value == 'on':
# Flag is on
else:
# Flag is off
end
평가 옵션
| 이름 | 설명 | 기본값 |
|---|---|---|
tracks_exposure | true인 경우 SDK는 평가된 변형에 대한 노출 이벤트를 추적합니다. | false |
로컬 평가 코호트 타겟팅
버전 1.5.0부터 로컬 평가 SDK 클라이언트는 로컬 평가 타겟팅을 위한 코호트 다운로드를 지원합니다. 이 지원을 활성화하려면 초기화 시 분석 api_key 및 secret_key와 함께 cohort_sync_config 옵션을 구성해야 합니다.
experiment = AmplitudeExperiment.initialize_local('DEPLOYMENT_KEY',
# (Recommended) Enable local evaluation cohort targeting.
AmplitudeExperiment::LocalEvaluationConfig.new(
cohort_sync_config: AmplitudeExperiment::CohortSyncConfig.new(
api_key: 'API_KEY',
secret_key: 'SECRET_KEY'
)
)
)
사용자 지정 로깅
로깅 동작을 제어하기 위해 고유한 로거 인스턴스를 제공합니다.
사용자 지정 로거
사용자 지정 로거 인스턴스를 RemoteEvaluationConfig 또는 LocalEvaluationConfig에 전달하십시오.
require 'logger'
require 'amplitude-experiment'
# Create a custom logger
custom_logger = Logger.new('experiment.log')
custom_logger.level = Logger::WARN
custom_logger.formatter = proc do |severity, datetime, progname, msg|
"#{datetime}: #{severity} - #{msg}\n"
end
# Remote evaluation with custom logger
remote_config = AmplitudeExperiment::RemoteEvaluationConfig.new(
logger: custom_logger
)
experiment = AmplitudeExperiment.initialize_remote('DEPLOYMENT_KEY', remote_config)
# Provide Local evaluation with your Rails logger
local_config = AmplitudeExperiment::LocalEvaluationConfig.new(
logger: Rails.logger
)
experiment = AmplitudeExperiment.initialize_local('DEPLOYMENT_KEY', local_config)
기본 로거를 사용한 디버그 플래그
# Without custom logger, debug=false uses ERROR level
config = AmplitudeExperiment::RemoteEvaluationConfig.new(
debug: false
)
# Default logger level is ERROR
# Without custom logger, debug=true uses DEBUG level
config = AmplitudeExperiment::RemoteEvaluationConfig.new(
debug: true
)
# Default logger level is DEBUG
사용자 지정 로거를 제공하면 SDK는 debug플래그를 무시하며 로거는 구성된 수준을 유지합니다.
custom_logger = Logger.new($stdout)
custom_logger.level = Logger::WARN
# Custom logger maintains its WARN level regardless of debug flag
config = AmplitudeExperiment::RemoteEvaluationConfig.new(
logger: custom_logger,
debug: true
)
# Logger level stays WARN (debug flag is ignored)
Amplitude 쿠키에 액세스
클라이언트 측에서 Amplitude 애널리틱스 SDK를 사용하는 경우, Ruby 서버 SDK는 Amplitude ID 쿠키를 구문 분석하고 상호 작용할 수 있는 편리한 함수를 포함하는 AmplitudeCookie 클래스를 제공합니다. 이 기능은 특히 클라이언트가 아직 장치 ID를 생성하지 않은 경우 서버의 장치 ID가 클라이언트에 설정된 장치 ID와 일치하는지 확인하는 데 유용합니다.
require 'amplitude-experiment'
require 'securerandom'
# Get the cookie name for the Amplitude API key
# Use new_format: true for Browser SDK 2.0 cookies
amp_cookie_name = AmplitudeExperiment::AmplitudeCookie.cookie_name('amplitude-api-key')
# For Browser SDK 2.0: AmplitudeExperiment::AmplitudeCookie.cookie_name('amplitude-api-key', new_format: true)
device_id = nil
# Try to get device ID from existing cookie
unless cookies[amp_cookie_name].nil?
device_id = AmplitudeExperiment::AmplitudeCookie.parse(cookies[amp_cookie_name]).device_id
# For Browser SDK 2.0: AmplitudeExperiment::AmplitudeCookie.parse(cookies[amp_cookie_name], new_format: true).device_id
end
# If no device ID found, generate a new one and set the cookie
if device_id.nil?
device_id = SecureRandom.uuid
amp_cookie_value = AmplitudeExperiment::AmplitudeCookie.generate(device_id)
# For Browser SDK 2.0: AmplitudeExperiment::AmplitudeCookie.generate(device_id, new_format: true)
cookies[amp_cookie_name] = {
value: amp_cookie_value,
domain: '.your-domain.com', # this should be the same domain used by the Amplitude JS SDK
httponly: false,
secure: false
}
end
이 내용이 도움이 되었나요?