[AWS] X-Ray

#AWS

[원본 링크]

X-ray는 AWS에서 제공하는 Trace 수집 및 관리 시스템이다.
API 단위 같은 개별 Trace(Transaction) 단위의 관측을 외부 APM 없이 AWS 내에서 자체적으로 관리할 수 있게 해준다.

이런거다.

그리고 OpenTelemetry 기반으로 만들어진 거라서, 다른 Otel 도구들과 어느 정도 호환된다.

비용

가격은 그냥 적당한 편이다. DataDog 같은 강도들에 비하면 싸고, 직접 구축해서 쓰는 것에 비하면 비싸다.
https://aws.amazon.com/ko/cloudwatch/pricing/

기록 관점에서 보면 100만개당 $5가 나간다. Trace가 많다면 금방 비용이 늘어날 것이다.

무료 사용량도 좀 있다.

기본

콘솔에서 X-ray를 확인하려면 Cloudwatch 섹션의 하위 탭으로 볼 수 있다.

그리고 저 X-ray 그룹은 최상위 필터 단위라고 할 수 있다. 보통 서비스 이름 같은걸 저기에 박는데, 이건 AWS CLI를 통해 만들어줘야 한다.

aws xray create-group \
  --region ap-northeast-2 \
  --group-name just-test-api \
  --filter-expression 'service("just-test-api")'

앱 에이전트 구성 (docker compose)

앱에서 Trace를 적재하게 하려면 전용 Otel SDK를 붙이는 것이 권장되는 방법이다.
X-ray 전용 에이전트 구성이 있긴 한데, deprecated된 상태라서 권장하진 않는다.

먼저 otel collector를 정의한다. 이게 x-ray를 보내는 책임을 가진다.
config 파일을 만들고

vim otel-collector-config.yaml

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318

processors:
  batch/traces:

exporters:
  awsxray:
    region: ${env:AWS_REGION}

service:
  pipelines:
    traces:
      receivers: [otlp]
      processors: [batch/traces]
      exporters: [awsxray]

이를 기반으로 otel collector를 정의한다.

services:
...
  adot-collector:
    image: public.ecr.aws/aws-observability/aws-otel-collector:latest
    command: ["--config=/etc/otel-agent-config.yaml"]
    environment:
      AWS_PROFILE: ${AWS_PROFILE:-...-dev}
      AWS_REGION: ${AWS_REGION:-ap-northeast-2}
      AWS_CONFIG_FILE: /home/aoc/.aws/config
      AWS_SHARED_CREDENTIALS_FILE: /home/aoc/.aws/credentials
    volumes:
      # ADOT image runs as the non-root `aoc` user (HOME=/home/aoc).
      - ${HOME}/.aws:/home/aoc/.aws:ro
      - ./otel-collector-config.yaml:/etc/otel-agent-config.yaml:ro
    ports:
      - "4317:4317"
      - "4318:4318"
    restart: unless-stopped

그리고 메인 앱에서는 otel collector의 경로로 찔러서 trace를 떠넘기면 된다.
다음은 node.js/express의 구성 예시다.

import { NodeSDK } from '@opentelemetry/sdk-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { AWSXRayIdGenerator } from '@opentelemetry/id-generator-aws-xray';
import { AWSXRayPropagator } from '@opentelemetry/propagator-aws-xray';

export const telemetrySdk = new NodeSDK({
  serviceName: process.env.OTEL_SERVICE_NAME ?? 'just-test-api',
  traceExporter: new OTLPTraceExporter({
    url: process.env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
      ?? 'http://localhost:4318/v1/traces',
  }),
  idGenerator: new AWSXRayIdGenerator(),
  textMapPropagator: new AWSXRayPropagator(),
  instrumentations: [getNodeAutoInstrumentations()],
});

telemetrySdk.start();