메인 콘텐츠로 건너뛰기

기본 설정

import { LynxTracer } from "@lynx/sdk";

const lynx = new LynxTracer({
  clientId: "support-api",
  endpoint: "https://lynx.example.com",
  apiKey: process.env.LYNX_API_KEY,
  workspaceId: "workspace_123",
  environment: "production",
  appVersion: "1.4.0",
});

수집 옵션

옵션기본값설명
sampleRate1수집할 run의 비율입니다. 0부터 1까지 설정할 수 있습니다.
captureInputtrue입력 payload를 수집합니다.
captureOutputtrue출력 payload를 수집합니다.
captureMode"smart""full", "metadata-only", "smart" 중 하나를 사용합니다.
maxPayloadLength5000직렬화된 payload의 최대 길이입니다.

전송 옵션

const lynx = new LynxTracer({
  clientId: "support-api",
  endpoint: "https://lynx.example.com",
  apiKey: process.env.LYNX_API_KEY,
  delivery: {
    mode: "BACKGROUND",
    timeoutMs: 1000,
    flushOnRunEnd: false,
    flushIntervalMs: 3000,
    batchSize: 50,
    maxQueueSize: 1000,
    overflowStrategy: "DROP_OLDEST",
  },
  circuitBreaker: {
    enabled: true,
    failureThreshold: 3,
    cooldownMs: 30000,
  },
});

환경 변수

기본 lynx export는 환경 변수에서 설정을 읽습니다.
import { lynx } from "@lynx/sdk";
변수설명
LYNX_CLIENT_ID클라이언트 또는 서비스 이름입니다.
LYNX_ENDPOINTLynx 서버 URL입니다.
LYNX_API_KEY수집 API key입니다.
LYNX_WORKSPACE_ID기본 workspace ID입니다.
LYNX_AGENT_ID기본 agent ID입니다.
LYNX_SAMPLE_RATE0부터 1까지의 sampling rate입니다.
LYNX_CAPTURE_INPUT입력 수집 여부입니다.
LYNX_CAPTURE_OUTPUT출력 수집 여부입니다.
LYNX_CAPTURE_MODEfull, metadata-only, smart 중 하나입니다.
LYNX_MAX_PAYLOAD_LENGTHpayload 최대 문자 수입니다.
LYNX_APP_VERSION애플리케이션 버전 메타데이터입니다.
LYNX_DEPLOYMENT_ID배포 ID 메타데이터입니다.
LYNX_ENVIRONMENT실행 환경 메타데이터입니다.
LYNX_POLICY_VERSION정책 버전 메타데이터입니다.
LYNX_DELIVERY_MODEBLOCKING 또는 BACKGROUND입니다.
LYNX_DELIVERY_TIMEOUT_MS전송 타임아웃입니다. 단위는 millisecond입니다.
LYNX_DELIVERY_FLUSH_ON_RUN_ENDtrue 또는 false입니다.
LYNX_DELIVERY_FLUSH_INTERVAL_MS백그라운드 flush 주기입니다.
LYNX_DELIVERY_BATCH_SIZEflush를 유도하는 batch size입니다.
LYNX_DELIVERY_MAX_QUEUE_SIZE큐에 보관할 수 있는 최대 이벤트 수입니다.
LYNX_DELIVERY_OVERFLOW_STRATEGYDROP_OLDEST 또는 DROP_NEWEST입니다.
LYNX_CIRCUIT_BREAKER_ENABLEDtrue 또는 false입니다.
LYNX_CIRCUIT_BREAKER_FAILURE_THRESHOLD서킷 브레이커를 열기 전까지 허용할 연속 실패 횟수입니다.
LYNX_CIRCUIT_BREAKER_COOLDOWN_MS서킷 브레이커 cooldown 시간입니다.