기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# Node.js용 X-Ray SDK 구성
<a name="xray-sdk-nodejs-configuration"></a>

**참고**  
X-Ray SDK/데몬 유지 관리 공지 - 2026년 2월 25일에 AWS X-Ray SDKs/데몬은 유지 관리 모드로 전환되며, 여기서 AWS 는 보안 문제만 해결하도록 X-Ray SDK 및 데몬 릴리스를 제한합니다. 지원 일정에 대한 자세한 내용은 [X-Ray SDK 및 데몬 지원 타임라인](xray-sdk-daemon-timeline.md) 섹션을 참조하세요. OpenTelemetry로 마이그레이션하는 것이 좋습니다. OpenTelemetry로 마이그레이션하는 방법에 대한 자세한 내용은 [X-Ray 계측에서 OpenTelemetry 계측으로 마이그레이션](https://docs.aws.amazon.com/xray/latest/devguide/xray-sdk-migration.html)을 참조하세요.

애플리케이션이 실행되는 서비스에 대한 정보를 포함하거나, 기본 샘플링 동작을 수정하거나 요청에 적용되는 샘플링 규칙을 특정 경로에 추가하도록 플러그인을 사용하여 Node.js용 X-Ray SDK를 구성할 수 있습니다.

**Topics**
+ [서비스 플러그인](#xray-sdk-nodejs-configuration-plugins)
+ [샘플링 규칙](#xray-sdk-nodejs-configuration-sampling)
+ [로깅](#xray-sdk-nodejs-configuration-logging)
+ [X-Ray 대몬(daemon) 주소](#xray-sdk-nodejs-configuration-daemon)
+ [환경 변수](#xray-sdk-nodejs-configuration-envvars)

## 서비스 플러그인
<a name="xray-sdk-nodejs-configuration-plugins"></a>

`plugins`을 사용하여 애플리케이션을 호스팅하는 서비스에 대한 정보를 기록할 수 있습니다.

**플러그인**
+ Amazon EC2 — `EC2Plugin`은 인스턴스 ID, 가용 영역 및 CloudWatch Logs 그룹을 추가합니다.
+ Elastic Beanstalk – `ElasticBeanstalkPlugin`이 환경 이름, 버전 레이블 및 배포 ID를 추가합니다.
+ Amazon ECS — `ECSPlugin`이 컨테이너 ID를 추가합니다.

플러그인을 사용하려면 `config` 메서드를 사용하여 Node.js용 X-Ray SDK 클라이언트를 구성합니다.

**Example app.js - 플러그인**  

```
var AWSXRay = require('aws-xray-sdk');
AWSXRay.config([AWSXRay.plugins.EC2Plugin,AWSXRay.plugins.ElasticBeanstalkPlugin]);
```

SDK는 플러그인 설정을 사용하여 세그먼트에 `origin` 필드를 설정하기도 합니다. 이는 애플리케이션을 실행하는 AWS 리소스 유형을 나타냅니다. 여러 플러그인을 사용하는 경우 SDK는 ElasticBeanstalk> EKS> ECS> EC2 순서로 확인하여 오리진을 결정합니다.

## 샘플링 규칙
<a name="xray-sdk-nodejs-configuration-sampling"></a>

SDK는 X-Ray 콘솔에서 정의하는 샘플링 규칙을 사용하여 기록할 요청을 결정합니다. 기본 규칙은 매초 첫 번째 요청을 추적하고, 모든 서비스에서 추가 요청의 5%를 X-Ray로 추적 전송합니다. [X-Ray 콘솔에서 추가 규칙을 생성](xray-console-sampling.md)하여 각 애플리케이션에 대해 기록되는 데이터의 양을 사용자 지정합니다.

SDK는 사용자 지정 규칙을 정의된 순서대로 적용합니다. 요청이 여러 사용자 지정 규칙과 일치하는 경우 SDK는 첫 번째 규칙만 적용합니다.

**참고**  
SDK가 샘플링 규칙을 가져오기 위해 X-Ray에 연결할 수 없는 경우, 매초 첫 번째 요청과 호스트당 추가 요청의 5%에 대한 기본 로컬 규칙으로 되돌아갑니다. 호스트가 샘플링 API를 직접 호출할 수 있는 권한이 없거나, X-Ray 대몬(daemon)에 연결할 수 없을 경우 이러한 상황이 발생할 수 있고 이 대몬(daemon)은 SDK에서 수행한 API 직접 호출에 대한 TCP 프록시 역할을 합니다.

JSON 문서에서 샘플링 규칙을 불러오도록 SDK를 구성할 수도 있습니다. SDK는 X-Ray 샘플링을 사용할 수 없을 경우 로컬 규칙을 백업으로 사용하거나, 로컬 규칙을 전용으로 사용할 수 있습니다.

**Example sampling-rules.json**  

```
{
  "version": 2,
  "rules": [
    {
      "description": "Player moves.",
      "host": "*",
      "http_method": "*",
      "url_path": "/api/move/*",
      "fixed_target": 0,
      "rate": 0.05
    }
  ],
  "default": {
    "fixed_target": 1,
    "rate": 0.1
  }
}
```

이 예에서는 하나의 사용자 지정 규칙과 기본 규칙을 정의합니다. 사용자 지정 규칙은 최소 추적 요청 수 없이 5% 샘플링 비율을 `/api/move/` 아래 경로에 적용합니다. 기본 규칙은 매초 최초 요청과 추가 요청의 10%를 추적합니다.

로컬로 규칙의 정의할 때의 단점은 고정 대상이 X-Ray 서비스를 통해 관리되는 대신, 레코더의 각 인스턴스별로 독립적으로 적용된다는 것입니다. 호스트를 많이 배포할수록 고정 속도가 크게 증대하기 때문에 기록되는 데이터의 양을 제어하기가 어려워집니다.

에서는 샘플링 속도를 수정할 수 AWS Lambda없습니다. 구성된 서비스가 함수를 호출하는 경우 해당 서비스에서 샘플링한 요청을 생성한 호출이 Lambda에 의해 기록됩니다. 활성 추적이 활성화되고 트레이스 헤더가 없는 경우 Lambda에서 샘플링 결정을 내립니다.

백업 규칙을 구성하려면 `setSamplingRules`를 사용하여 파일에서 샘플링 규칙을 로드하도록 Node.js용 X-Ray SDK에 지정합니다.

**Example app.js - 파일의 샘플링 규칙**  

```
var AWSXRay = require('aws-xray-sdk');
AWSXRay.middleware.setSamplingRules('sampling-rules.json');
```

또한 코드에서 규칙을 정의하여 객체로 `setSamplingRules`에 전달할 수도 있습니다.

**Example app.js - 객체의 샘플링 규칙**  

```
var AWSXRay = require('aws-xray-sdk');
var rules = {
  "rules": [ { "description": "Player moves.", "service_name": "*", "http_method": "*", "url_path": "/api/move/*", "fixed_target": 0, "rate": 0.05 } ],
  "default": { "fixed_target": 1, "rate": 0.1 },
  "version": 1
  }

AWSXRay.middleware.setSamplingRules(rules);
```

로컬 규칙만 사용하려면 `disableCentralizedSampling`를 호출합니다.

```
AWSXRay.middleware.disableCentralizedSampling()
```

## 로깅
<a name="xray-sdk-nodejs-configuration-logging"></a>

 SDK의 출력을 기록하려면 `AWSXRay.setLogger(logger)`를 호출합니다. 여기서 `logger`는 표준 로깅 메서드(`warn`, `info` 등)를 제공하는 객체입니다.

기본적으로 SDK는 콘솔 객체의 표준 메서드를 사용하여 콘솔에 오류 메시지를 기록합니다. 내장 로거의 로그 수준은 `AWS_XRAY_DEBUG_MODE` 또는 `AWS_XRAY_LOG_LEVEL` 환경 변수를 사용하여 설정할 수 있습니다. 유효한 로그 수준 값 목록은 [환경 변수](#xray-sdk-nodejs-configuration-envvars)를 참조하십시오.

로그에 다른 형식이나 대상을 제공하려는 경우 아래와 같이 로거 인터페이스의 자체 구현을 SDK에 제공할 수 있습니다. 이 인터페이스를 구현하는 모든 객체를 사용할 수 있습니다. 즉, Winston과 같은 다양한 로깅 라이브러리를 사용하여 SDK에 직접 전달할 수 있습니다.

**Example app.js – 로깅**  

```
var AWSXRay = require('aws-xray-sdk');

// Create your own logger, or instantiate one using a library.
var logger = {
  error: (message, meta) => { /* logging code */ },
  warn: (message, meta) => { /* logging code */ },
  info: (message, meta) => { /* logging code */ },
  debug: (message, meta) => { /* logging code */ }
}

AWSXRay.setLogger(logger);
AWSXRay.config([AWSXRay.plugins.EC2Plugin]);
```

다른 구성 메서드를 실행하기 전에 `setLogger`를 호출하여 해당 작업의 출력을 캡처하도록 합니다.

## X-Ray 대몬(daemon) 주소
<a name="xray-sdk-nodejs-configuration-daemon"></a>

X-Ray 대몬(daemon)이 `127.0.0.1:2000` 이외의 다른 포트 또는 호스트를 수신 대기하는 경우 추적 데이터를 다른 주소로 전송하도록 Node.js용 X-Ray SDK를 구성할 수 있습니다.

```
AWSXRay.setDaemonAddress('host:port');
```

호스트를 이름 또는 IPv4 주소로 지정할 수 있습니다.

**Example app.js - 데몬 주소**  

```
var AWSXRay = require('aws-xray-sdk');
AWSXRay.setDaemonAddress('daemonhost:8082');
```

다른 포트에서 TCP와 UDP를 수신 대기하도록 데몬을 구성한 경우 데몬 주소 설정에서 둘 다 지정할 수 있습니다.

**Example app.js - 개별 포트의 데몬 주소**  

```
var AWSXRay = require('aws-xray-sdk');
AWSXRay.setDaemonAddress('tcp:daemonhost:8082 udp:daemonhost:8083');
```

`AWS_XRAY_DAEMON_ADDRESS` [환경 변수](#xray-sdk-nodejs-configuration-envvars)를 사용하여 데몬 주소를 설정할 수도 있습니다.

## 환경 변수
<a name="xray-sdk-nodejs-configuration-envvars"></a>

환경 변수를 사용하여 Node.js용 X-Ray SDK를 구성할 수 있습니다. SDK는 다음 변수를 지원합니다.
+ `AWS_XRAY_CONTEXT_MISSING` – 열려 있는 세그먼트가 없는 경우 구성된 구성된 코드가 데이터를 기록하려고 할 때 발생하는 예외를 방지하려면 `RUNTIME_ERROR`로 설정합니다.

**유효한 값**
  + `RUNTIME_ERROR`— 런타임 예외가 발생합니다.
  + `LOG_ERROR` – 오류를 기록하고 계속합니다 (기본값).
  + `IGNORE_ERROR`— 오류를 무시하고 계속합니다.

  열린 요청이 없을 때 실행되는 시작 코드 또는 새 스레드를 생성하는 코드에서 계측된 클라이언트를 사용하려고 하는 경우 누락된 세그먼트 또는 하위 세그먼트와 관련된 오류가 발생할 수 있습니다.
+ `AWS_XRAY_DAEMON_ADDRESS` – X-Ray 대몬(daemon) 리스너의 호스트와 포트를 설정합니다. 기본적으로 SDK는 추적 데이터(UDP)와 샘플링(TCP) 모두에 `127.0.0.1:2000`을 사용합니다. [다른 포트에서 수신 대기](xray-daemon-configuration.md)하도록 대몬(daemon)을 구성한 경우 또는 다른 호스트에서 실행 중인 경우 이 변수를 사용합니다.

**형식**
  + **동일한 포트** – `address:port`
  + **다른 포트** – `tcp:address:port udp:address:port`
+ `AWS_XRAY_DEBUG_MODE` – `debug` 수준에서 로그를 콘솔에 출력하도록 SDK를 구성하려면 `TRUE`로 설정합니다.
+ `AWS_XRAY_LOG_LEVEL ` – 기본 로거의 로그 수준을 설정합니다. 유효한 값은 `debug`, `info`, `warn`, `error` 및 `silent`입니다. AWS\$1XRAY\$1DEBUG\$1MODE가 `TRUE`로 설정된 경우 이 값은 무시됩니다.
+ `AWS_XRAY_TRACING_NAME` – SDK가 세그먼트에 사용할 서비스 이름을 설정합니다. [Express 미들웨어에 설정한](xray-sdk-nodejs-middleware.md) 세그먼트 이름을 재정의합니다.