기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다. # Ruby로 작업 **참고** 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)을 참조하세요. Ruby 애플리케이션을 계측하여 트레이스를 X-Ray로 전송하는 방법에는 두 가지가 있습니다. + [AWS Distro for OpenTelemetry Ruby](xray-ruby-opentel-sdk.md) - [AWS Distro for OpenTelemetry Collector](https://aws-otel.github.io/docs/getting-started/collector)를 통해 상관관계가 있는 지표 및 트레이스를 Amazon CloudWatch AWS X-Ray및 Amazon OpenSearch Service를 비롯한 여러 AWS 모니터링 솔루션으로 전송하기 위한 오픈 소스 라이브러리 세트를 제공하는 AWS 배포입니다. + [AWS X-Ray SDK for Ruby](xray-sdk-ruby.md) - X-Ray [데몬을 통해 트레이스를 생성하고 X-Ray](xray-daemon.md)로 전송하기 위한 라이브러리 세트입니다. 자세한 내용은 [AWS Distro for OpenTelemetry와 X-Ray SDKs 중에서 선택](xray-instrumenting-your-app.md#xray-instrumenting-choosing) 단원을 참조하십시오. # AWS Distro for OpenTelemetry Ruby Ruby용 OpenTelemetry AWS 배포판 (ADOT)을 사용하면 애플리케이션을 한 번 계측하여 상호 관련된 지표와 추적을 Amazon CloudWatch, AWS X-Ray, Amazon OpenSearch Service를 포함한 여러 AWS 모니터링 솔루션으로 전송할 수 있습니다. ADOT와 함께 X-Ray를 사용하려면 두 가지 구성 요소가 필요합니다. X-Ray와 함께 사용할 수 있는 *OpenTelemetry SDK*와 X-Ray와 함께 사용할 수 있는 *OpenTelemetry Collector를 위한 AWS 배포판*입니다. 시작하려면 [Ruby용 OpenTelemetry AWS 배포판 설명서](https://aws-otel.github.io/docs/getting-started/ruby-sdk)를 참조하십시오. AWS X-Ray 및 다른 AWS 서비스 버전과 함께 OpenTelemetry AWS 배포판을 사용하는 방법에 대한 자세한 내용은 [OpenTelemetry용 AWS 배포판](https://aws-otel.github.io/) 또는 [OpenTelemetry용 AWS 배포판 설명서](https://aws-otel.github.io/docs/introduction)를 참조하십시오. 언어 지원 및 사용법에 대한 자세한 내용은 [Github의 AWS 관찰성](https://github.com/aws-observability)을 참조하세요. # AWS X-Ray SDK for Ruby **참고** 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)을 참조하세요. X-Ray SDK는 트레이스 데이터를 생성하고 X-Ray 대몬(daemon)에 보내기 위한 클래스 및 메서드를 제공하는 Ruby 웹 애플리케이션용 라이브러리 집합입니다. 추적 데이터에는 애플리케이션에서 제공하는 수신 HTTP 요청과 애플리케이션이 AWS SDK, HTTP 클라이언트 또는 활성 레코드 클라이언트를 사용하여 다운스트림 서비스에 수행하는 호출에 대한 정보가 포함됩니다. 또한 수동으로 세그먼트를 생성하고 디버그 정보를 주석 및 메타데이터에 추가할 수도 있습니다. gemfile에 추가하고 `bundle install`를 실행하면 SDK를 다운로드할 수 있습니다. **Example Gemfile** ``` gem 'aws-sdk' ``` Rails를 사용하는 경우 들어오는 요청을 추적하기 위해 먼저 [X-Ray SDK 미들웨어를 추가](xray-sdk-ruby-middleware.md)하세요. 요청 필터는 [세그먼트](xray-concepts.md#xray-concepts-segments)를 생성합니다. 세그먼트가 열려 있는 동안에는 SDK 클라이언트의 메서드를 이용해 정보를 세그먼트에 추가하고 하위 세그먼트를 만들어 다운스트림 호출을 트레이스할 수 있습니다. 또한 SDK는 세그먼트가 열려 있는 동안 애플리케이션에서 발생하는 예외를 자동으로 기록합니다. 다른 애플리케이션의 경우 [세그먼트를 수동으로 만들](xray-sdk-ruby-middleware.md#xray-sdk-ruby-middleware-manual) 수 있습니다. 그런 다음 연결된 라이브러리를 패치하도록 [레코더를 구성](xray-sdk-ruby-patching.md)하여 X-Ray SDK를 사용하여 AWS SDK for Ruby, HTTP 및 SQL 클라이언트를 계측합니다. 계측된 클라이언트를 사용하여 다운스트림 AWS 서비스 또는 리소스를 호출할 때마다 SDK는 하위 세그먼트에 호출에 대한 정보를 기록합니다. 서비스 내에서 액세스하는 AWS 서비스 리소스는 트레이스 맵에 다운스트림 노드로 표시되어 개별 연결에서 오류 및 제한 문제를 식별하는 데 도움이 됩니다. SDK를 이용하게 되면 [레코더를 구성](xray-sdk-ruby-configuration.md)하여 SDK 동작을 사용자 지정합니다. 플러그인을 추가해 애플리케이션을 실행하는 컴퓨팅 리소스에 대한 데이터를 기록하고, 샘플링 규칙을 정의해 샘플링 동작을 구성하고, 로거를 제공하여 애플리케이션 로그의 SDK에서 표시되는 정보 수준을 조절할 수 있습니다. 요청에 대한 추가 정보와 애플리케이션이 [주석 및 메타데이터](xray-sdk-ruby-segment.md)에서 하는 작업을 기록합니다. 주석은 [필터 표현식](xray-console-filters.md)과 함께 사용할 수 있도록 인덱싱된 단순한 키 값 쌍이기 때문에, 특정 데이터를 포함한 트레이스를 검색할 수 있습니다. 메타데이터 항목은 제한이 적으며 JSON으로 직렬화할 수 있는 모든 객체와 어레이를 기록할 수 있습니다. **주석 및 메타데이터** 주석 및 메타데이터는 X SDK를 사용하여 세그먼트에 추가하는 임의의 텍스트입니다. 주석은 필터 표현식에서 사용하기 위해 인덱싱됩니다. 메타데이터는 인덱싱되지 않지만 X-Ray 콘솔 또는 API를 사용하여 원시 세그먼트에서 볼 수 있습니다. X-Ray에 대한 읽기 액세스가 부여된 사용자는 누구나 이 데이터를 볼 수 있습니다. 코드에 구성된 클라이언트가 많이 있다면, 구성된 클라이언트로 만든 각 직접 호출의 하위 세그먼트를 대량으로 보관하는 요청 세그먼트 하나를 만들 수 있습니다. [사용자 지정 하위 세그먼트](xray-sdk-ruby-subsegments.md)의 클라이언트 호출을 래핑해 하위 세그먼트를 조직하고 그룹화할 수 있습니다. 전체 함수나 특정 코드 부분에 대한 사용자 지정 하위 세그먼트를 만들고, 상위 세그먼트에 모든 것을 적는 대신 하위 세그먼트에 메타데이터와 주석을 기록할 수 있습니다. SDK의 클래스 및 메서드에 대한 참조 문서는 [AWS X-Ray SDK for Ruby API Reference](https://docs.aws.amazon.com/xray-sdk-for-ruby/latest/reference)를 참조하십시오. ## 요구 사항 X-Ray SDK는 Ruby 2.3 이상이 필요하며 다음 라이브러리와 호환됩니다: + AWS SDK for Ruby 버전 3.0 이상 + Rails 버전 5.1 이상 # Ruby용 X-Ray SDK 구성 **참고** 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)을 참조하세요. Ruby용 X-Ray SDK에는 전역 레코더를 제공하는 `XRay.recorder`라는 클래스가 있습니다. 수신 HTTP 호출에 대해 세그먼트를 생성하는 미들웨어를 사용자 지정하도록 전역 레코더를 구성할 수 있습니다. **Topics** + [서비스 플러그인](#xray-sdk-ruby-configuration-plugins) + [샘플링 규칙](#xray-sdk-ruby-configuration-sampling) + [로깅](#xray-sdk-ruby-configuration-logging) + [코드의 레코더 구성](#xray-sdk-ruby-configuration-code) + [Rails를 사용한 레코더 구성](#xray-sdk-ruby-middleware-configuration-rails) + [환경 변수](#xray-sdk-ruby-configuration-envvars) ## 서비스 플러그인 `plugins`을 사용하여 애플리케이션을 호스팅하는 서비스에 대한 정보를 기록할 수 있습니다. **플러그인** + Amazon EC2 – `ec2`이 인스턴스 ID와 가용 영역을 추가합니다. + Elastic Beanstalk – `elastic_beanstalk`이 환경 이름, 버전 레이블 및 배포 ID를 추가합니다. + Amazon ECS — `ecs`이 컨테이너 ID를 추가합니다. ![\[Segment - Scorekeep overview showing Elastic Beanstalk and EC2 deployment details.\]](http://docs.aws.amazon.com/ko_kr/xray/latest/devguide/images/scorekeep-PUTrules-segment-resources-python09.png) 플러그인을 사용하려면 레코더로 전달하는 구성 객체에서 해당 플러그인을 지정합니다. **Example main.rb – 플러그인 구성** ``` my_plugins = %I[ec2 elastic_beanstalk] config = { plugins: my_plugins, name: 'my app', } XRay.recorder.configure(config) ``` 또한 코드에 설정된 값보다 우선하는 [환경 변수](#xray-sdk-ruby-configuration-envvars)를 사용하여 레코더를 구성할 수 있습니다. SDK는 플러그인 설정을 사용하여 세그먼트에 `origin` 필드를 설정하기도 합니다. 이는 애플리케이션을 실행하는 AWS 리소스 유형을 나타냅니다. 여러 플러그인을 사용하는 경우 SDK는 ElasticBeanstalk> EKS> ECS> EC2 순서로 확인하여 오리진을 결정합니다. ## 샘플링 규칙 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 서비스를 통해 관리되는 대신, 레코더의 각 인스턴스별로 독립적으로 적용된다는 것입니다. 호스트를 많이 배포할수록 고정 속도가 크게 증대하기 때문에 기록되는 데이터의 양을 제어하기가 어려워집니다. 백업 규칙을 구성하려면 레코더로 전달하는 구성 객체에서 문서에 대한 해시를 정의합니다. **Example main.rb – 백업 규칙 구성** ``` require 'aws-xray-sdk' my_sampling_rules = { version: 1, default: { fixed_target: 1, rate: 0.1 } } config = { sampling_rules: my_sampling_rules, name: 'my app', } XRay.recorder.configure(config) ``` 샘플링 규칙을 독립적으로 저장하려면 별도 파일에 해시를 정의하고 파일이 애플리케이션으로 해시를 가져오도록 합니다. **Example config/sampling-rules.rb** ``` my_sampling_rules = { version: 1, default: { fixed_target: 1, rate: 0.1 } } ``` **Example main.rb – 파일의 샘플링 규칙** ``` require 'aws-xray-sdk' require 'config/sampling-rules.rb' config = { sampling_rules: my_sampling_rules, name: 'my app', } XRay.recorder.configure(config) ``` 로컬 규칙만 사용하려면 샘플링 규칙을 요청하고 `LocalSampler`를 구성합니다. **Example main.rb – 로컬 샘플링 규칙** ``` require 'aws-xray-sdk' require 'aws-xray-sdk/sampling/local/sampler' config = { sampler: LocalSampler.new, name: 'my app', } XRay.recorder.configure(config) ``` 또한 샘플링을 비활성하하고 모든 수신 요청을 구성하도록 전역 레코더를 구성할 수 있습니다. **Example main.rb – 샘플링 비활성화** ``` require 'aws-xray-sdk' config = { sampling: false, name: 'my app', } XRay.recorder.configure(config) ``` ## 로깅 기본적으로 레코더는 정보 레벨 이벤트를 `$stdout`로 출력합니다. 레코더로 전달하는 구성 객체에서 [로거](https://ruby-doc.org/stdlib-2.4.2/libdoc/logger/rdoc/Logger.html)를 정의하여 로깅을 사용자 정의할 수 있습니다. **Example main.rb – 로깅** ``` require 'aws-xray-sdk' config = { logger: my_logger, name: 'my app', } XRay.recorder.configure(config) ``` 디버그 로그를 사용하여 [수동으로 하위 세그먼트를 생성](xray-sdk-ruby-subsegments.md)할 때 미완료 하위 세그먼트와 같은 문제를 식별할 수 있습니다. ## 코드의 레코더 구성 `XRay.recorder`에 대한 `configure` 메서드에서 추가 설정을 사용할 수 있습니다. + `context_missing` – 열려 있는 세그먼트가 없는 경우 구성된 코드가 데이터를 기록하려고 할 때 발생하는 예외를 방지하려면 `LOG_ERROR`로 설정합니다. + `daemon_address` – X-Ray 대몬(daemon) 리스너의 호스트와 포트를 설정합니다. + `name` – SDK가 세그먼트에 사용하는 서비스 이름을 설정합니다. + `naming_pattern` – [동적 이름 지정](xray-sdk-ruby-middleware.md#xray-sdk-ruby-middleware-naming)을 사용하려면 도메인 이름 패턴을 설정합니다. + `plugins` – [플러그인](#xray-sdk-ruby-configuration-plugins)을 사용하여 애플리케이션의 AWS 리소스에 대한 정보를 기록합니다. + `sampling` – 샘플링을 비활성화하려면 `false`로 설정합니다. + `sampling_rules` – [샘플링 규칙](#xray-sdk-ruby-configuration-sampling)이 포함된 해시를 설정합니다. **Example main.rb – 컨텍스트 누락 예외 비활성화** ``` require 'aws-xray-sdk' config = { context_missing: 'LOG_ERROR' } XRay.recorder.configure(config) ``` ## Rails를 사용한 레코더 구성 Rails 프레임워크를 사용하는 경우 `app_root/initializers` 아래의 Ruby 파일을 사용하여 전역 레코더의 옵션을 구성할 수 있습니다. X-Ray SDK는 Rails와 함께 사용할 수 있는 추가 구성 키를 지원합니다. + `active_record` – Active Record 데이터베이스 트랜잭션에 대한 하위 세그먼트를 기록하려면 `true`로 설정합니다. 이름이 `Rails.application.config.xray`인 구성 객체에서 사용 가능한 설정을 구성합니다. **Example config/initializers/aws\$1xray.rb** ``` Rails.application.config.xray = { name: 'my app', patch: %I[net_http aws_sdk], active_record: true } ``` ## 환경 변수 환경 변수를 사용하여 Ruby용 X-Ray SDK를 구성할 수 있습니다. SDK는 다음 변수를 지원합니다: + `AWS_XRAY_TRACING_NAME` – SDK가 세그먼트에 사용할 서비스 이름을 설정합니다. 서블릿 필터의 [세그먼트 이름 지정 전략](xray-sdk-ruby-middleware.md#xray-sdk-ruby-middleware-naming)에 설정한 서비스 이름을 재정의합니다. + `AWS_XRAY_DAEMON_ADDRESS` – X-Ray 대몬(daemon) 리스너의 호스트와 포트를 설정합니다. 기본적으로 SDK는 `127.0.0.1:2000`에 트레이스 데이터를 보냅니다. [다른 포트에서 수신 대기](xray-daemon-configuration.md)하도록 대몬(daemon)을 구성한 경우 또는 다른 호스트에서 실행 중인 경우 이 변수를 사용합니다. + `AWS_XRAY_CONTEXT_MISSING` – 열려 있는 세그먼트가 없는 경우 구성된 코드가 데이터를 기록하려고 할 때 발생하는 예외를 방지하려면 `RUNTIME_ERROR`로 설정합니다. **유효한 값** + `RUNTIME_ERROR`— 런타임 예외가 발생합니다. + `LOG_ERROR` – 오류를 기록하고 계속합니다 (기본값). + `IGNORE_ERROR`— 오류를 무시하고 계속합니다. 열린 요청이 없을 때 실행되는 시작 코드 또는 새 스레드를 생성하는 코드에서 계측된 클라이언트를 사용하려고 하는 경우 누락된 세그먼트 또는 하위 세그먼트와 관련된 오류가 발생할 수 있습니다. 환경 변수는 코드에 설정된 값을 재정의합니다. # Ruby 미들웨어용 X-Ray SDK로 수신 요청 추적하기 **참고** 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)을 참조하세요. X-Ray SDK를 사용하여 애플리케이션이 Amazon EC2 AWS Elastic Beanstalk또는 Amazon ECS의 EC2 인스턴스에서 처리하는 수신 HTTP 요청을 추적할 수 있습니다. Rails를 사용하는 경우 Rails 미들웨어를 사용하여 수신 HTTP 요청을 구성합니다. 미들웨어를 애플리케이션에 추가하고 세그먼트 이름을 구성하면 Ruby용 X-Ray SDK는 샘플링된 각 요청에 대해 세그먼트를 생성합니다. 추가 구성에 의해 생성된 모든 세그먼트는 HTTP 요청 및 응답에 대한 정보를 제공하는 요청 레벨 세그먼트의 하위 세그먼트가 됩니다. 이 정보에는 요청의 시간, 메서드 및 배치가 포함됩니다. 각 세그먼트에는 서비스 맵 안에서 애플리케이션을 식별하는 이름이 있습니다. 이 세그먼트의 이름이 정적으로 지정되도록 하거나, 수신 요청의 호스트 헤더를 기반으로 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`입니다. ## rails 미들웨어 사용 미들웨어를 사용하려면 필요한 [railtie](http://api.rubyonrails.org/classes/Rails/Railtie.html)를 포함하도록 gemfile을 업데이트합니다. **Example Gemfile - rails** ``` gem 'aws-xray-sdk', require: ['aws-xray-sdk/facets/rails/railtie'] ``` 또한 미들웨어를 사용하려면 트레이스 맵에서 애플리케이션을 나타내는 이름을 사용하여 [레코더를 구성](xray-sdk-ruby-configuration.md#xray-sdk-ruby-middleware-configuration-rails)해야 합니다. **Example config/initializers/aws\$1xray.rb** ``` Rails.application.config.xray = { name: 'my app' } ``` ## 수동으로 코드 구성 Rails를 사용하지 않는 경우 세그먼트를 수동으로 생성합니다. 수신되는 각 요청에 대해 세그먼트를 생성하거나 패치된 HTTP 또는 AWS SDK 클라이언트 주위에 세그먼트를 생성하여 레코더가 하위 세그먼트를 추가할 컨텍스트를 제공할 수 있습니다. ``` # Start a segment segment = XRay.recorder.begin_segment 'my_service' # Start a subsegment subsegment = XRay.recorder.begin_subsegment 'outbound_call', namespace: 'remote' # Add metadata or annotation here if necessary my_annotations = { k1: 'v1', k2: 1024 } segment.annotations.update my_annotations # Add metadata to default namespace subsegment.metadata[:k1] = 'v1' # Set user for the segment (subsegment is not supported) segment.user = 'my_name' # End segment/subsegment XRay.recorder.end_subsegment XRay.recorder.end_segment ``` ## 세그먼트 이름 지정 전략 구성 AWS X-Ray 는 *서비스 이름을* 사용하여 애플리케이션을 식별하고 애플리케이션이 사용하는 다른 애플리케이션, 데이터베이스, 외부 APIs 및 AWS 리소스와 구분합니다. X-Ray SDK는 수신 요청에 대한 세그먼트를 생성할 때 해당 세그먼트의 [이름 필드](xray-api-segmentdocuments.md#api-segmentdocuments-fields)에 애플리케이션의 서비스 이름을 기록합니다. X-Ray SDK는 HTTP 요청 헤더의 호스트 이름 뒤에 세그먼트를 지정할 수 있습니다. 그러나 이 헤더가 위조되면 서비스 맵에 예기치 않은 노드가 발생할 수 있습니다. 위조된 호스트 헤더가 포함된 요청으로 인해 SDK가 잘못된 세그먼트 이름을 지정하는 현상을 방지하려면 들어오는 요청의 기본 이름을 지정해야 합니다. 애플리케이션이 여러 도메인의 요청을 처리하는 경우, 동적 이름 지정 전략을 사용하여 이를 세그먼트 이름에 반영하도록 SDK를 구성할 수 있습니다. 동적 이름 지정 전략을 사용하면 SDK가 예상 패턴과 일치하는 요청에 호스트 이름을 사용하고, 그렇지 않은 요청에 기본 이름을 적용할 수 있습니다. 예를 들어, 하나의 애플리케이션이 세 개의 하위 도메인 (`www.example.com`, `api.example.com`, `static.example.com`) 에 요청을 전송할 수 있습니다. `*.example.com` 패턴으로 동적 이름 지정 전략을 사용하여 각 하위도메인의 세그먼트를 서로 다른 이름으로 표시하면 서비스 맵에 서비스 노드가 세 개 생깁니다. 이 패턴에 맞지 않는 호스트 이름의 요청이 애플리케이션에 수신되면, 사용자가 지정한 대체 이름의 네 번째 노드가 서비스 맵에 표시됩니다. 모든 요청 세그먼트에 같은 이름을 사용하려면 [이전 섹션](#xray-sdk-ruby-middleware-rails)에 나온 것처럼 레코더를 구성할 때 애플리케이션 이름을 지정합니다. 동적 이름 지정 전략은 호스트 이름이 일치해야 하는 패턴 및 HTTP 요청의 호스트 이름이 패턴과 일치하지 않는 경우 사용할 기본 이름을 정의합니다. 세그먼트 이름을 동적으로 지정하려면 config 해시에서 이름 지정 패턴을 지정합니다. **Example main.rb – 동적 이름 지정** ``` config = { naming_pattern: '*mydomain*', name: 'my app', } XRay.recorder.configure(config) ``` 패턴에서 '\$1'를 사용하여 문자열을 일치시키거나 '?'를 사용하여 단일 문자를 일치시킬 수 있습니다. **참고** 코드에 정의한 기본 서비스 이름을 `AWS_XRAY_TRACING_NAME` [환경 변수](xray-sdk-ruby-configuration.md#xray-sdk-ruby-configuration-envvars)를 사용하여 재정의할 수 있습니다. # 다운스트림 호출 구성을 위해 라이브러리 패치 **참고** 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)을 참조하세요. 다운스트림 호출을 구성하려면 Ruby용 X-Ray SDK를 사용하여 애플리케이션이 사용하는 라이브러리를 패치합니다. Ruby용 X-Ray SDK는 다음 라이브러리를 패치할 수 있습니다. **지원되는 라이브러리** + `[net/http](https://ruby-doc.org/stdlib-2.4.2/libdoc/net/http/rdoc/Net/HTTP.html)` – HTTP 클라이언트를 구성합니다. + `[aws-sdk](https://aws.amazon.com/sdk-for-ruby)` - AWS SDK for Ruby 클라이언트를 계측합니다. 패치된 라이브러리를 사용하면 Ruby용 X-Ray SDK는 직접 호출에 대한 하위 세그먼트를 생성하고 요청 및 응답의 정보를 기록합니다. SDK가 SDK 미들웨어 또는 `XRay.recorder.begin_segment` 호출에서 하위 세그먼트를 생성하려면 세그먼트를 사용할 수 있어야 합니다. 라이브러리를 패치하려면 X-Ray 레코더에 전달하는 구성 객체에서 해당 라이브러리를 지정합니다. **Example main.rb – 라이브러리 패치** ``` require 'aws-xray-sdk' config = { name: 'my app', patch: %I[net_http aws_sdk] } XRay.recorder.configure(config) ``` # Ruby용 X-Ray AWS SDK를 사용하여 SDK 호출 추적 **참고** 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)을 참조하세요. 애플리케이션이를 호출 AWS 서비스 하여 데이터를 저장하거나, 대기열에 쓰거나, 알림을 보내면 Ruby용 X-Ray SDK는 [하위 세그먼트](xray-sdk-ruby-subsegments.md)에서 다운스트림 호출을 추적합니다. 해당 서비스(예: Amazon S3 버킷 또는 Amazon SQS 대기열) 내에서 액세스하는 추적 AWS 서비스 및 리소스는 X-Ray 콘솔의 추적 맵에 다운스트림 노드로 표시됩니다. Ruby용 X-Ray SDK는 라이브러리를 패치할 때 모든 AWS SDK 클라이언트를 자동으로 계측합니다. [`aws-sdk`](xray-sdk-ruby-patching.md) 개별 클라이언트를 구성할 수는 없습니다. 모든 서비스의 경우, X-Ray 콘솔에서 호출된 API의 이름을 볼 수 있습니다. 서비스 하위 집합에 대해서는 X-Ray SDK가 세그먼트에 정보를 추가하여 서비스 맵에서 추가 세분화를 제공합니다. 예를 들어 계측된 DynamoDB 클라이언트에서 직접 호출을 생성하는 경우 SDK가 특정 테이블을 대상으로 한 직접 호출에 대해 테이블 이름을 세그먼트에 추가합니다. 콘솔에서, 각 테이블이 개별 노드로 서비스 맵에 표시되고, 특정 테이블을 대상으로 하지 않은 직접 호출에 대해 일반 DynamoDB 노드가 표시됩니다. **Example 항목을 저장하기 위한 DynamoDB 직접 호출에 대한 하위 세그먼트** ``` { "id": "24756640c0d0978a", "start_time": 1.480305974194E9, "end_time": 1.4803059742E9, "name": "DynamoDB", "namespace": "aws", "http": { "response": { "content_length": 60, "status": 200 } }, "aws": { "table_name": "scorekeep-user", "operation": "UpdateItem", "request_id": "UBQNSO5AEM8T4FDA4RQDEB94OVTDRVV4K4HIRGVJF66Q9ASUAAJG", } } ``` 명명된 리소스에 액세스할 때 다음 서비스를 호출할 경우 서비스 맵에 추가 노드가 생성됩니다. 특정 리소스를 대상으로 하지 않는 경우 서비스를 직접 호출하면 해당 서비스에 대한 일반 노드가 생성됩니다. + **Amazon DynamoDB** – 테이블 이름 + **Amazon Simple Storage Service** –버킷 및 키 이름 + **Amazon Simple Queue Service** – 대기열 이름 # X-Ray SDK를 사용하여 사용자 지정 하위 세그먼트 생성 **참고** 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)을 참조하세요. 하위 세그먼트는 추적의 [세그먼트](xray-concepts.md#xray-concepts-segments)를 확장하여 요청을 처리하기 위해 완료된 작업에 대한 세부 정보를 표시합니다. 계측되는 클라이언트에서 직접 호출할 때마다, X-Ray SDK는 하위 세그먼트 안에 생성된 정보를 기록합니다. 추가 하위 세그먼트를 생성하여 다른 하위 세그먼트를 그룹화하거나, 코드 섹션의 성능을 평가하거나, 주석 및 메타데이터를 기록할 수 있습니다. 하위 세그먼트를 관리하려면 `begin_subsegment` 및 `end_subsegment` 메서드를 사용합니다. ``` subsegment = XRay.recorder.begin_subsegment name: 'annotations', namespace: 'remote' my_annotations = { id: 12345 } subsegment.annotations.update my_annotations XRay.recorder.end_subsegment ``` 함수에 대한 하위 세그먼트를 생성하려면 `XRay.recorder.capture` 호출에 함수를 래핑합니다. ``` XRay.recorder.capture('name_for_subsegment') do |subsegment| resp = myfunc() # myfunc is your function subsegment.annotations.update k1: 'v1' resp end ``` 하위 세그먼트를 세그먼트 또는 다른 하위 세그먼트 내에서 생성하면 X-Ray SDK가 해당 하위 세그먼트에 대해 ID를 생성하고 시작 시간 및 종료 시간을 기록합니다. **Example 메타데이터가 포함된 하위 세그먼트** ``` "subsegments": [{ "id": "6f1605cd8a07cb70", "start_time": 1.480305974194E9, "end_time": 1.4803059742E9, "name": "Custom subsegment for UserModel.saveUser function", "metadata": { "debug": { "test": "Metadata string from UserModel.saveUser" } }, ``` # Ruby용 X-Ray SDK로 세그먼트에 주석 및 메타데이터 추가하기 **참고** 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)을 참조하세요. 주석 및 메타데이터와 함께 요청, 환경 또는 애플리케이션에 대한 추가 정보를 기록할 수 있습니다. X-Ray SDK에서 생성하는 세그먼트 또는 사용자가 생성하는 사용자 지정 하위 세그먼트에 주석 및 메타데이터를 추가할 수 있습니다. **주석**은 문자열, 숫자 또는 부울 값과 결합한 키-값 페어입니다. 주석은 [필터 표현식](xray-console-filters.md)에서 사용하기 위해 인덱싱됩니다. 주석은 콘솔의 트레이스를 그룹화할 때 사용할 데이터를 기록하거나 [https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSummaries.html](https://docs.aws.amazon.com/xray/latest/api/API_GetTraceSummaries.html) API를 직접 호출할 때 사용하세요. **메타데이터**는 객체 및 목록을 포함한 모든 유형의 값을 가질 수 있는 키-값 페어지만, 필터 표현식에 사용할 수 있도록 인덱싱되지는 않습니다. 트레이스에 저장하고 싶지만 검색에는 사용하지 않을 추가 데이터는 메타데이터를 사용하여 기록하십시오. 세그먼트에는 주석과 메타데이터 외에 [사용자 ID 문자열](#xray-sdk-ruby-segment-userid)도 기록할 수 있습니다. 사용자 ID는 세그먼트의 별도 필드에 기록되면 검색용으로 인덱스되지 않습니다. **Topics** + [Ruby용 X-Ray SDK로 주석 기록하기](#xray-sdk-ruby-segment-annotations) + [Ruby용 X-Ray SDK로 메타데이터 기록하기](#xray-sdk-ruby-segment-metadata) + [Ruby용 X-Ray SDK로 사용자 ID 기록하기](#xray-sdk-ruby-segment-userid) ## Ruby용 X-Ray SDK로 주석 기록하기 주석을 사용하여 검색용으로 인덱싱할 정보를 세그먼트나 하위 세그먼트에 기록하십시오. **주석 요구 사항** + **키** - X-Ray 주석의 키는 최대 500자의 영숫자를 포함할 수 있습니다. 점이나 마침표(.) 이외의 공백이나 기호를 사용할 수 없습니다. + **값** - X-Ray 주석의 값은 최대 1,000자의 유니코드 문자를 포함할 수 있습니다. + **주석** 수 - 트레이스당 최대 50개의 주석을 사용할 수 있습니다. **주석 기록 방법** 1. `xray_recorder`에서 현재 세그먼트나 하위 세그먼트의 참조를 가져오십시오. ``` require 'aws-xray-sdk' ... document = XRay.recorder.current_segment ``` 또는 ``` require 'aws-xray-sdk' ... document = XRay.recorder.current_subsegment ``` 1. 해시 값을 사용해 `update`를 호출합니다. ``` my_annotations = { id: 12345 } document.annotations.update my_annotations ``` 다음은 점이 포함된 주석 키를 사용하여 `update`를 직접 호출하는 방법을 보여주는 예제입니다. ``` my_annotations = { testkey.test: 12345 } document.annotations.update my_annotations ``` SDK는 세그먼트 문서의 `annotations` 객체에 주석을 키-값 페어로 기록합니다. 같은 키로 `add_annotations`을 두 번 직접 호출하면 같은 세그먼트나 하위 세그먼트에 기록했던 값을 덮어씁니다. 특정 값을 포함한 주석이 있는 트레이스를 찾으려면 `annotation[key]` 키워드를 [필터 표현식](xray-console-filters.md)에 사용하십시오. ## Ruby용 X-Ray SDK로 메타데이터 기록하기 메타데이터를 이용해 검색용으로 인덱싱하지 않아도 되는 정보를 세그먼트나 하위 세그먼트에 기록하십시오. 메타데이터 값은 문자열, 숫자, 부울 또는 JSON 객체나 어레이에 직렬화할 수 있는 모든 객체가 될 수 있습니다. **메타데이터 기록 방법** 1. `xray_recorder`에서 현재 세그먼트나 하위 세그먼트의 참조를 가져오십시오. ``` require 'aws-xray-sdk' ... document = XRay.recorder.current_segment ``` 또는 ``` require 'aws-xray-sdk' ... document = XRay.recorder.current_subsegment ``` 1. 문자열 키, 부울, 숫자, 문자열 또는 객체 값 및 문자열 네임스페이스와 함께 `metadata`를 직접 호출합니다. ``` my_metadata = { my_namespace: { key: 'value' } } subsegment.metadata my_metadata ``` 같은 키로 `metadata`을 두 번 직접 호출하면 같은 세그먼트나 하위 세그먼트에 기록했던 값을 덮어씁니다. ## Ruby용 X-Ray SDK로 사용자 ID 기록하기 사용자 ID를 요청 세그먼트에 기록하여 요청을 보낸 사용자를 식별합니다. **사용자 ID 기록 방법** 1. `xray_recorder`에서 현재 세그먼트에 대한 참조를 가져옵니다. ``` require 'aws-xray-sdk' ... document = XRay.recorder.current_segment ``` 1. 세그먼트의 사용자 필드를 요청을 보낸 사용자의 문자열 ID로 설정합니다. ``` segment.user = 'U12345' ``` 컨트롤러에서 사용자를 설정하면 애플리케이션이 요청을 처리하는 순간부터 사용자 ID를 기록할 수 있습니다. 사용자 ID의 트레이스를 찾으려면, `user` 키워드를 [필터 표현식](xray-console-filters.md)에 적용하십시오.