Node.js용 X-Ray SDK로 수신 요청 추적하기

X-Ray SDK를 사용하여 Express 및 Restify 애플리케이션이 Amazon EC2, AWS Elastic Beanstalk 또는 Amazon ECS의 EC2 인스턴스에서 처리하는 수신 HTTP 요청을 트레이스할 수 있습니다.

Node.js용 X-Ray SDK는 Express 및 Restify 프레임워크를 사용하는 애플리케이션을 위한 미들웨어를 제공합니다. 애플리케이션에 X-Ray 미들웨어를 추가하면 Node.js용 X-Ray SDK가 샘플링된 각 요청에 대해 세그먼트를 생성합니다. 이 세그먼트에는 HTTP 요청의 시간, 메서드 및 배치가 포함됩니다. 추가로 구성하면 이 세그먼트의 하위 세그먼트가 생성됩니다.

참고

AWS Lambda 함수의 경우, Lambda는 샘플링되는 각 요청마다 세그먼트 하나를 생성합니다. 자세한 정보는 AWS Lambda 그리고 AWS X-Ray 섹션을 참조하세요.

각 세그먼트에는 서비스 맵 안에서 애플리케이션을 식별하는 이름이 있습니다. 이 세그먼트의 이름이 정적으로 지정되도록 하거나, 수신 요청의 호스트 헤더를 기반으로 SDK가 동적으로 이름을 지정하도록 구성할 수 있습니다. 동적 이름 지정을 사용하면 요청의 도메인 이름에 따라 그룹을 추적하고 이름이 예상 패턴과 일치하지 않을 경우(예: 호스트 헤더가 위조된 경우) 기본 이름을 적용할 수 있습니다.

전달된 요청

로드 밸런서 또는 기타 중개자가 애플리케이션으로 요청을 전달하는 경우, X-Ray는 IP 패킷 내 소스 IP가 아니라 요청의 X-Forwarded-For 헤더로부터 클라이언트 IP를 가져옵니다. 전달된 요청에 대해 기록된 클라어언트 IP는 위조될 수 있으므로 신뢰하면 안 됩니다.

요청이 전달되면 SDK는 세그먼트에 추가 필드를 설정하여 이를 나타냅니다. 세그먼트에 x_forwarded_for로 설정된 true 필드가 포함된 경우 클라이언트 IP는 HTTP 요청의 X-Forwarded-For 헤더로부터 가져옵니다.

메시지 핸들러는 다음 정보를 포함하는 http 블록을 이용해 각 수신 요청에 대한 세그먼트를 생성합니다.

• HTTP 메서드 – GET, POST, PUT, DELETE 등.

• 클라이언트 주소 – 요청을 전송한 클라이언트의 IP 주소.

• 응답 코드 – 완료된 요청의 HTTP 응답 코드.

• 시간 – 시작 시간(요청 수신) 및 종료 시간(응답 전송).

• 유저 에이전트 — 요청에서 가져온 user-agent입니다.

• 콘텐츠 길이 — 응답의 content-length입니다.

Express를 사용하여 수신 요청 추적

Express 미들웨어를 사용하려면 SDK 클라이언트를 시작하고 express.openSegment 함수가 반환하는 미들웨어를 사용하여 경로를 정의합니다.

예 app.js - Express

var app = express();

var AWSXRay = require('aws-xray-sdk');
app.use(AWSXRay.express.openSegment('MyApp'));

app.get('/', function (req, res) {
  res.render('index');
});

app.use(AWSXRay.express.closeSegment());

경로를 정의한 후, express.closeSegment의 출력을 사용하여 Node.js용 X-Ray SDK가 반환한 오류를 모두 처리합니다.

Restify를 사용하여 수신 요청 추적

Restify 미들웨어를 사용하려면 SDK 클라이언트를 시작하고 enable을 실행합니다. Restify 서버 및 세그먼트 이름을 전달합니다.

예 app.js - Restify

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

var restify = require('restify');
var server = restify.createServer();
AWSXRayRestify.enable(server, 'MyApp'));

server.get('/', function (req, res) {
  res.render('index');
});

세그먼트 이름 지정 전략 구성

AWS X-Ray는 서비스 이름을 사용하여 사용자의 애플리케이션을 식별하고, 이를 다른 애플리케이션, 데이터베이스, 외부 API, 사용자의 애플리케이션에서 사용하는 AWS 리소스와 구별합니다. X-Ray SDK는 수신 요청에 대한 세그먼트를 생성할 때 해당 세그먼트의 이름 필드에 애플리케이션의 서비스 이름을 기록합니다.

X-Ray SDK는 HTTP 요청 헤더의 호스트 이름 뒤에 세그먼트를 지정할 수 있습니다. 그러나 이 헤더가 위조되면 서비스 맵에 예기치 않은 노드가 발생할 수 있습니다. 위조된 호스트 헤더가 포함된 요청으로 인해 SDK가 잘못된 세그먼트 이름을 지정하는 현상을 방지하려면 들어오는 요청의 기본 이름을 지정해야 합니다.

애플리케이션이 여러 도메인의 요청을 처리하는 경우, 동적 이름 지정 전략을 사용하여 이를 세그먼트 이름에 반영하도록 SDK를 구성할 수 있습니다. 동적 이름 지정 전략을 사용하면 SDK가 예상 패턴과 일치하는 요청에 호스트 이름을 사용하고, 그렇지 않은 요청에 기본 이름을 적용할 수 있습니다.

예를 들어, 하나의 애플리케이션이 세 개의 하위 도메인 (www.example.com, api.example.com, static.example.com) 에 요청을 전송할 수 있습니다. *.example.com 패턴으로 동적 이름 지정 전략을 사용하여 각 하위도메인의 세그먼트를 서로 다른 이름으로 표시하면 서비스 맵에 서비스 노드가 세 개 생깁니다. 이 패턴에 맞지 않는 호스트 이름의 요청이 애플리케이션에 수신되면, 사용자가 지정한 대체 이름의 네 번째 노드가 서비스 맵에 표시됩니다.

모든 요청 세그먼트에 같은 이름을 사용하려면, 이전 단원에 나온 것처럼 미들웨어를 초기화할 때 애플리케이션 이름을 지정하십시오.

참고

코드에 정의한 기본 서비스 이름을 AWS_XRAY_TRACING_NAME 환경 변수를 사용하여 재정의할 수 있습니다.

동적 이름 지정 전략은 호스트 이름이 일치해야 하는 패턴 및 HTTP 요청의 호스트 이름이 패턴과 일치하지 않는 경우 사용할 기본 이름을 정의합니다. 동적으로 세그먼트의 이름을 지정하려면 AWSXRay.middleware.enableDynamicNaming을 사용합니다.

예 app.js – 동적 세그먼트 이름

요청의 호스트 이름이 *.example.com 패턴과 일치하는 경우 호스트 이름을 사용합니다. 그렇지 않은 경우 MyApp을 사용합니다.

var app = express();

var AWSXRay = require('aws-xray-sdk');
app.use(AWSXRay.express.openSegment('MyApp'));
AWSXRay.middleware.enableDynamicNaming('*.example.com');
        
app.get('/', function (req, res) {
  res.render('index');
});

app.use(AWSXRay.express.closeSegment());