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

# Ruby용 X-Ray SDK로 세그먼트에 주석 및 메타데이터 추가하기
<a name="xray-sdk-ruby-segment"></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)을 참조하세요.

주석 및 메타데이터와 함께 요청, 환경 또는 애플리케이션에 대한 추가 정보를 기록할 수 있습니다. 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로 주석 기록하기
<a name="xray-sdk-ruby-segment-annotations"></a>

주석을 사용하여 검색용으로 인덱싱할 정보를 세그먼트나 하위 세그먼트에 기록하십시오.

**주석 요구 사항**
+ **키** - 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로 메타데이터 기록하기
<a name="xray-sdk-ruby-segment-metadata"></a>

메타데이터를 이용해 검색용으로 인덱싱하지 않아도 되는 정보를 세그먼트나 하위 세그먼트에 기록하십시오. 메타데이터 값은 문자열, 숫자, 부울 또는 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 기록하기
<a name="xray-sdk-ruby-segment-userid"></a>

사용자 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)에 적용하십시오.