이 페이지에서

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.

실험 Node.js SDK

npmv1.13.628.4 kB gzip

Amplitude Experiment의 서버 측 Node.js SDK 구현에 대한 공식 문서입니다.

이 문서에는 원격 및 로컬 평가에 대한 섹션이 별도로 제공됩니다.

원격 평가

원격 평가를 사용하여 사용자의 변형 가져오기를 구현합니다.

설치

Node 버전 호환성

Node 서버 SDK는 Node 10 이상에서 작동합니다.

npm install --save @amplitude/experiment-node-server

빠른 시작

  1. 실험 클라이언트 초기화
  2. 사용자를 위한 변형 가져오기
  3. 플래그 변형에 액세스
js
import { Experiment } from '@amplitude/experiment-node-server';
// (1) Initialize the experiment client
const experiment = Experiment.initializeRemote('<DEPLOYMENT_KEY>', {
    fetchTimeoutMillis: 500,
    fetchRetries: 1,
    fetchRetryBackoffMinMillis: 0,
    fetchRetryTimeoutMillis: 500,
});
// (2) Fetch variants for a user
const user = {
    user_id: 'user@company.com',
    device_id: 'abcdefg',
    user_properties: {
        'premium': true,
    },
};
const variants = experiment.fetchV2(user);
// (3) Access a flag's variant
const variant = variants['YOUR-FLAG-KEY'];
if (variant?.value === 'on') {
    // Flag is on
} else {
    // Flag is off
}

원격 초기화

서버 시작 시 서버에서 SDK 클라이언트를 초기화합니다.apiKey 매개변수에 전달하는 배포 키 인수는 분석 이벤트를 전송하는 동일한 프로젝트 내에 있어야 합니다.

js
initializeRemote(apiKey: string, config?: RemoteEvaluationConfig): RemoteEvaluationClient

시간 초과 및 재시도 구성

** 기본 시간 초과 및 재시도 구성 옵션은 대부분의 서버 환경에서 너무 큽니다**. 성능 요구 사항에 가장 적합하도록 시간 초과 및 재시도 옵션을 구성하십시오. 원격 평가 성능이 너무 느리면 로컬 평가를 사용하는 것을 고려하십시오.

js
import { Experiment } from '@amplitude/experiment-node-server';
const experiment = Experiment.initializeRemote('<DEPLOYMENT_KEY>', config: {
    fetchTimeoutMillis: 500,
    fetchRetries: 1,
    fetchRetryBackoffMinMillis: 0,
    fetchRetryTimeoutMillis: 500,
});

구성

초기화 시 SDK 클라이언트를 구성합니다.

EU 데이터 센터

Amplitude의 EU 데이터 센터를 사용하는 경우, 초기화 시 serverZone 옵션을 구성하십시오.

가져오기

사용자의 변형을 가져오고 결과를 반환합니다. 원격으로 평가 함수는 SDK 클라이언트를 초기화하는 데 사용된 배포와 관련된 플래그에 대해 사용자를 평가합니다.

js
fetchV2(user: ExperimentUser, fetchOptions?: FetchOptions): Promise<Variants>

FetchOptions

js
const user = {
    user_id: 'user@company.com',
    device_id: 'abcdefg',
    user_properties: {
        'premium': true,
    },
};
const variants = await experiment.fetchV2(user);

사용자의 변형을 가져온 후에는 특정 플래그의 변형에 액세스할 수도 있습니다.

js
const variant = variants['YOUR-FLAG-KEY'];
if (variant?.value === 'on') {
    // Flag is on
} else {
    // Flag is off
}

지역 평가

로컬 평가를 사용하여 사용자에 대한 변형 평가를 구현합니다. 로컬 평가를 사용하려는 경우 장단점을 이해해야 합니다.

설치

npm또는 yarn을 사용하여 Node.js 서버 SDK를 설치하십시오.

npm install --save @amplitude/experiment-node-server

빠른 시작

  1. 로컬 평가 클라이언트를 초기화합니다.
  2. 로컬 평가 클라이언트를 시작합니다.
  3. 사용자를 평가합니다.
js
import { Experiment } from '@amplitude/experiment-node-server';
// (1) Initialize the local evaluation client with a server deployment key.
const experiment = Experiment.initializeLocal('<DEPLOYMENT_KEY>', {
  // (Recommended) Enable local evaluation cohort targeting.
  cohortSyncConfig: {
    apiKey: '<API_KEY>',
    secretKey: '<SECRET_KEY>'
  }
});
// (2) Start the local evaluation client.
await experiment.start();
// (2) Evaluate a user.
const user = { device_id: 'abcdefg' };
const variants = experiment.evaluateV2(user);

로컬 초기화

로컬 평가 클라이언트를 초기화합니다.

서버 배포 키

로컬 평가 플래그 구성에 액세스하려면 서버 배포 키를 사용하여 로컬 평가 클라이언트를 초기화해야 합니다.

js
initializeLocal(apiKey: string, config?: LocalEvaluationConfig): LocalEvaluationClient

플래그 스트리밍

streamUpdates의구성을 사용하여 flagConfigPollingIntervalMillis밀리초마다 폴링하는 대신 플래그 구성 업데이트가 SDK로 푸시되도록 합니다(기본값 false). 저장 후 SDK가 업데이트를 받는 데 걸리는 시간은 일반적으로 1초 미만입니다. 스트리밍에 실패할 경우 SDK는 폴링으로 폴백합니다. 폴백을 위해 flagConfigPollingIntervalMillis 구성도 구성하십시오.

구성

초기화 시 SDK 클라이언트를 구성할 수 있습니다.

EU 데이터 센터

Amplitude의 EU 데이터 센터를 사용하는 경우, 초기화 시 serverZone 옵션을 구성하십시오.

LocalEvaluationConfig

할당설정

ExposureConfig

CohortSyncConfig

시작

로컬 평가 클라이언트를 시작하여 평가를 위한 로컬 평가 모드 플래그 구성을 미리 가져오고 구성된 간격에 따라 플래그 구성 폴러를 시작합니다.

js
start(): Promise<void>

evaluateV2()를 호출하기 전에 플래그 구성을 사용할 준비가 되었는지 확인하려면 start()의 결과를 기다려야 합니다.

js
await experiment.start();

평가

start()에서 미리 가져온 플래그를 사용하여 평가 로직을 실행합니다. evaluate에 사용자 객체 인수를 지정해야 합니다. 플래그 변형의 특정 하위 집합만 필요한 경우 선택적으로 플래그 키 배열을 전달할 수 있습니다.

노출 추적

노출 추적을 활성화하려면 exposureConfig을 설정하십시오. 그런 다음 evaluateV2()을 호출할 때 EvaluateOptions의 tracksExposure을 true(으)로 설정하십시오.

js
evaluateV2(user: ExperimentUser, flagKeys?: string[], options?: EvaluateOptions): Record<string, Variant>
js
// The user to evaluate
const user = { device_id: 'abcdefg' };
// Evaluate all flag variants
const allVariants = experiment.evaluateV2(user);
// Evaluate a specific subset of flag variants
const specificVariants = experiment.evaluateV2(user, [
  'my-local-flag-1',
  'my-local-flag-2',
]);

평가 옵션

로컬 평가 코호트 타겟팅

버전 1.13.4부터 로컬 평가 SDK 클라이언트는 로컬 평가 타겟팅을 위한 코호트 다운로드를 지원합니다. 이 지원을 활성화하려면 초기화 시 분석 apiKey 및 secretKey와 함께 cohortSyncConfig 옵션을 구성해야 합니다.

js
const experiment = Experiment.initializeLocal('<DEPLOYMENT_KEY>', {
  // (Recommended) Enable local evaluation cohort targeting.
  cohortSyncConfig: {
    apiKey: '<API_KEY>',
    secretKey: '<SECRET_KEY>'
  }
});

서비스의 메모리 부족을 초래할 수 있는 대규모 코호트 다운로드를 방지하려면 maxCohortSize 구성을 고려하십시오. SDK는 너무 큰 코호트를 다운로드하지 않습니다.

사용자 지정 로깅

logLevel 구성을 통해 로그 세부 정보를 제어하거나 LoggerProvider 인터페이스를 구현하여 자체 로거를 통합하십시오.

로그 수준

  • Verbose: 자세한 디버깅 로그
  • Debug: 개발 및 문제 해결 로그
  • Info: 일반 정보
  • Warn: 경고
  • Error: 오류(기본값)
  • Disable: 로그 없음

사용자 지정 로거

사용자 고유의 로깅 솔루션을 사용하기 위해 LoggerProvider 인터페이스를 구현하십시오.

ts
import { Experiment, LogLevel, LoggerProvider } from '@amplitude/experiment-node-server';
class MyCustomLogger implements LoggerProvider {
  verbose(message, ...optionalParams) {
    // Implement verbose logging
  }
  debug(message, ...optionalParams) {
    // Implement debug logging
  }
  info(message, ...optionalParams) {
    // Implement info logging
  }
  warn(message, ...optionalParams) {
    // Implement warn logging
  }
  error(message, ...optionalParams) {
    // Implement error logging
  }
}
// Initialize with custom logger
const experiment = Experiment.initializeLocal(
  '<DEPLOYMENT_KEY>',
  {
    logLevel: LogLevel.Debug,
    loggerProvider: new MyCustomLogger()
  }
);

이전 버전과의 호환성

debug 구성 필드는 여전히 지원됩니다. true로 설정된 경우 logLevel를 Debug로 재정의합니다.

Amplitude 쿠키에 액세스

클라이언트 측에서 Amplitude 애널리틱스 SDK를 사용하는 경우, Node.js 서버 SDK는 Amplitude ID 쿠키를 구문 분석하고 상호 작용할 수 있는 편리한 함수를 포함하는 AmplitudeCookie 클래스를 제공합니다. 다음을 수행해야 할 경우 서버측 렌더링(SSR) 사용 사례에 이 클래스를 사용하십시오.

  • 서버에서 렌더링된 코드와 클라이언트 측 코드 간에 일관된 기기 ID를 유지합니다.
  • 페이지가 렌더링되기 전에 사용자의 Amplitude ID에 액세스하십시오.
  • 쿠키가 아직 존재하지 않을 때 서버에 쿠키를 생성하고 설정합니다.

클래스는 클라이언트가 아직 장치 ID를 생성하지 않은 경우에도 서버의 장치 ID가 클라이언트에 설정된 장치 ID와 일치하도록 보장합니다.

js
import { AmplitudeCookie } from '@amplitude/experiment-node-server';
import { v4 as uuidv4 } from 'uuid';
// Get the cookie name for the Amplitude API key
// For Browser SDK 2.0 cookies, pass true as second parameter:
// const ampCookieName = AmplitudeCookie.cookieName('amplitude-api-key', true);
const ampCookieName = AmplitudeCookie.cookieName('amplitude-api-key');
let deviceId = null;
// Try to get device ID from existing cookie
if (req.cookies[ampCookieName]) {
  deviceId = AmplitudeCookie.parse(req.cookies[ampCookieName]).device_id;
  // For Browser SDK 2.0: AmplitudeCookie.parse(req.cookies[ampCookieName], true).device_id;
}
// If no device ID found, generate a new one and set the cookie
if (!deviceId) {
  deviceId = uuidv4();
  const ampCookieValue = AmplitudeCookie.generate(deviceId);
  // For Browser SDK 2.0: AmplitudeCookie.generate(deviceId, true);
  res.cookie(ampCookieName, ampCookieValue, {
    domain: '.your-domain.com', // this should be the same domain used by the Amplitude JS SDK
    httpOnly: false,
    secure: false
  });
}

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