API Gateway X-Ray 추적 비활성화

API Gateway REST API의 X-Ray 추적이 꺼져 있으면 요청 경로와 지연 원인 분석이 어려울 수 있습니다.

설명

API Gateway REST API 스테이지에서 X-Ray 추적이 꺼져 있으면 요청 지연이나 오류가 발생한 구간을 분석하기 어려울 수 있습니다. 분산 추적은 여러 서비스의 호출 흐름을 연결하지만, 샘플링되므로 모든 요청을 기록하는 감사 로그를 대신하지는 않습니다.

잠재적 영향

  • 서비스 간 지연과 오류의 원인을 파악하는 데 시간이 더 걸릴 수 있습니다.
  • 장애 대응과 성능 분석에 필요한 요청 흐름 정보가 부족할 수 있습니다.

해결 방법

추적이 필요한 REST API 스테이지에 xray_tracing_enabled = true를 설정하세요. 필요한 X-Ray 권한과 샘플링 설정을 확인하고 로그, 메트릭과 함께 사용하세요. 배포 후 실제 추적 데이터가 수집되는지 확인하세요.

예시

REST API 스테이지 설정의 발췌입니다. 참조하는 API와 배포는 별도로 구성하세요.

변경 전

hcl
resource "aws_api_gateway_stage" "example" {
  stage_name           = "prod"
  rest_api_id          = aws_api_gateway_rest_api.test.id
  deployment_id        = aws_api_gateway_deployment.test.id
  xray_tracing_enabled = false
}

변경 후

hcl
resource "aws_api_gateway_stage" "example" {
  stage_name           = "prod"
  rest_api_id          = aws_api_gateway_rest_api.test.id
  deployment_id        = aws_api_gateway_deployment.test.id
  xray_tracing_enabled = true
}

변경 후에는 스테이지의 X-Ray 추적을 켭니다. 전체 백엔드 흐름을 보려면 연동 서비스의 추적 설정도 함께 확인하세요.

참조