X-Ray SDK for Python을 사용하여 세그먼트에 주석 및 메타데이터 추가

주석 및 메타데이터와 함께 요청, 환경 또는 애플리케이션에 대한 추가 정보를 기록할 수 있습니다. 주석과 메타데이터를 X-Ray에서 SDK 생성하는 세그먼트나 사용자가 만든 사용자 지정 하위 세그먼트에 추가할 수 있습니다.

주석은 문자열, 숫자 또는 부울 값과 결합한 키-값 페어입니다. 주석은 필터 표현식에서 사용하기 위해 인덱싱됩니다. 콘솔에서 또는 를 호출할 때 트레이스를 그룹화하는 데 사용할 데이터를 주석을 사용하여 기록할 수 있습니다. GetTraceSummariesAPI

메타데이터는 객체 및 목록을 포함한 모든 유형의 값을 가질 수 있는 키-값 페어지만, 필터 표현식에 사용할 수 있도록 인덱싱되지는 않습니다. 트레이스에 저장하고 싶지만 검색에는 사용하지 않을 추가 데이터는 메타데이터를 사용하여 기록하십시오.

세그먼트에는 주석과 메타데이터 외에 사용자 ID 문자열도 기록할 수 있습니다. 사용자는 세그먼트의 별도 필드에 IDs 기록되며 검색에 사용할 수 있도록 인덱싱됩니다.

SDKPython용 X-Ray를 사용하여 주석 기록하기

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

주석 요구 사항

• 키 — X-Ray 주석의 키는 최대 500자의 영숫자를 포함할 수 있습니다. 점이나 마침표 (.) 이외의 공백이나 기호는 사용할 수 없습니다.

• 값 — X-Ray 주석의 값은 최대 1,000개의 유니코드 문자를 포함할 수 있습니다.

• 주석 수 — 트레이스당 최대 50개의 주석을 사용할 수 있습니다.

주석 기록 방법

1. xray_recorder에서 현재 세그먼트나 하위 세그먼트의 참조를 가져오십시오.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

   또는

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_subsegment()

2. 문자열 키, 부울, 숫자 또는 문자열 값으로 put_annotation을 호출합니다.

   document.put_annotation("mykey", "my value");

   다음 예제는 점과 부울, 숫자 또는 문자열 값이 포함된 String 키를 putAnnotation 사용하여 호출하는 방법을 보여줍니다.

   document.putAnnotation("testkey.test", "my value");

또는 put_annotation에서 xray_recorder 방법을 사용할 수 있습니다. 이 방법은 현재의 하위 세그먼트나 열려있는 하위 세그먼트가 없을 경우 해당 세그먼트에서 레코드 주석을 기록합니다.

xray_recorder.put_annotation("mykey", "my value");

주석을 세그먼트 문서의 annotations 개체에 키-값 쌍으로 SDK 기록합니다. 같은 키로 put_annotation을 두 번 호출하면 같은 세그먼트나 하위 세그먼트에 기록했던 값을 덮어씁니다.

특정 값을 포함한 주석이 있는 트레이스를 찾으려면 annotation[key] 키워드를 필터 표현식에 사용하십시오.

SDKPython용 X-Ray를 사용하여 메타데이터 기록하기

메타데이터를 이용해 검색용으로 인덱싱하지 않아도 되는 정보를 세그먼트나 하위 세그먼트에 기록하십시오. 메타데이터 값은 문자열, 숫자, 불리언 또는 객체나 배열로 직렬화할 수 있는 모든 JSON 객체일 수 있습니다.

메타데이터 기록 방법

1. xray_recorder에서 현재 세그먼트나 하위 세그먼트의 참조를 가져오십시오.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

   또는

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_subsegment()

2. 문자열 키, 부울, 숫자, 문자열 또는 객체 값 및 문자열 네임스페이스와 함께 put_metadata를 호출합니다.

   document.put_metadata("my key", "my value", "my namespace");

   또는

   키와 값만 이용해 put_metadata를 호출합니다.

   document.put_metadata("my key", "my value");

또는 put_metadata에서 xray_recorder 방법을 사용할 수 있습니다. 이 방법은 현재의 하위 세그먼트나 열려있는 하위 세그먼트가 없을 경우 해당 세그먼트에서 메타데이터를 기록합니다.

xray_recorder.put_metadata("my key", "my value");

네임스페이스를 지정하지 않으면 네임스페이스가 사용됩니다. SDK default 같은 키로 put_metadata을 두 번 호출하면 같은 세그먼트나 하위 세그먼트에 기록했던 값을 덮어씁니다.

SDKPython용 X-Ray를 IDs 사용하여 녹화하는 사용자

요청 IDs 세그먼트에 사용자를 기록하여 요청을 보낸 사용자를 식별합니다.

사용자 기록하기 IDs

1. xray_recorder에서 현재 세그먼트에 대한 참조를 가져옵니다.

   from aws_xray_sdk.core import xray_recorder
   ...
   document = xray_recorder.current_segment()

2. 요청을 보낸 사용자의 문자열 ID로 setUser를 호출합니다.

   document.set_user("U12345");

컨트롤러에서 set_user를 호출하면 애플리케이션이 요청을 처리하는 순간부터 사용자 ID를 기록할 수 있습니다.

사용자 ID의 트레이스를 찾으려면, user 키워드를 필터 표현식에 적용하십시오.