AWS X-Ray
개발자 안내서

AWS X-Ray SDK for Python

Python용 X-Ray SDK는 트레이스 데이터를 생성하여 X-Ray 데몬으로 전송하기 위한 클래스 및 메서드를 제공하는 Python 웹 애플리케이션용 라이브러리입니다. 트레이스 데이터는 애플리케이션이 처리하는 수신 HTTP 요청, 그리고 애플리케이션이 AWS SDK, HTTP 클라이언트 또는 SQL 데이터베이스 커넥터를 사용하여 다운스트림 서비스에 하는 호출에 대한 정보를 포함합니다. 또한 수동으로 세그먼트를 생성하고 디버그 정보를 주석 및 메타데이터에 추가할 수도 있습니다.

pip로 SDK를 다운로드할 수 있습니다.

$ pip install aws-xray-sdk

참고

Python용 X-Ray SDK은 오픈 소스 프로젝트입니다. 프로젝트를 따르고 GitHub(github.com/aws/aws-xray-sdk-python)에서 문제 및 풀 요청을 제출할 수 있습니다.

Django 또는 Flask를 사용하는 경우 SDK 미들웨어를 애플리케이션에 추가하는 것부터 시작하여 수신 요청을 추적합니다. 미들웨어는 각 트레이스 요청에 대한 세그먼트를 생성하고, 응답이 전송되면 세그먼트를 완료합니다. 세그먼트가 열려 있는 동안에는 SDK 클라이언트의 메서드를 이용해 정보를 세그먼트에 추가하고 하위 세그먼트를 만들어 다운스트림 호출을 트레이스할 수 있습니다. 또한 SDK는 세그먼트가 열려 있는 동안 애플리케이션에서 발생하는 예외를 자동으로 기록합니다. 다른 애플리케이션의 경우 세그먼트를 수동으로 만들 수 있습니다.

계측되는 애플리케이션 또는 서비스에 의해 호출되는 Lambda 함수의 경우, Lambda는 트레이스 헤더를 읽고 샘플링된 요청을 자동으로 추적합니다. 그 밖의 함수의 경우 수신 요청을 샘플링 및 추적하도록 Lambda를 구성합니다. 어느 경우든, Lambda는 세그먼트를 생성하여 X-Ray SDK에 제공합니다.

참고

Lambda에서 X-Ray SDK는 선택 사항입니다. 이를 함수에 사용하지 않는 경우 여전히 서비스 맵에 Lambda 서비스용 노드와 각 Lambda 함수용 노트 하나가 포함됩니다. SDK를 추가하면 함수 코드를 계측하여 Lambda에 의해 기록되는 함수 세그먼트에 하위 세그먼트를 추가할 수 있습니다. 자세한 내용은 AWS Lambda와 AWS X-Ray를 참조하십시오.

Lambda에서 구성된 Python 함수의 예는 작업자 단원을 참조하십시오.

다음으로 Python용 X-Ray SDK를 사용하여 애플리케이션의 라이브러리를 패치함으로써 다운스트림 호출을 구성합니다. SDK는 다음 라이브러리를 지원합니다.

지원되는 라이브러리

  • botocore, boto3 - AWS SDK for Python (Boto) 클라이언트를 구성합니다.

  • pynamodb - Amazon DynamoDB 클라이언트의 PynamoDB 버전을 구성합니다.

  • aiobotocore, aioboto3 - SDK for Python 클라이언트의 asyncio 통합 버전을 구성합니다.

  • requests, aiohttp - 상위 HTTP 클라이언트를 구성합니다.

  • httplib, http.client - 하위 HTTP 클라이언트와 이러한 클라이언트를 사용하는 상위 라이브러리를 구성합니다.

  • sqlite3 - SQLite 클라이언트를 구성합니다.

  • mysql-connector-python - MySQL 클라이언트를 구성합니다.

애플리케이션이 AWS, SQL 데이터베이스 또는 기타 HTTP 서비스를 호출할 떄마다 SDK는 하위 세그먼트에 호출에 대한 정보를 레코딩합니다. 서비스에서 액세스하는 AWS 서비스와 리소스는 서비스 맵에 다운스트림 노드로 표시되기 때문에 개별 연결의 오류와 병목 문제를 쉽게 확인할 수 있습니다.

SDK를 이용하게 되면 레코더 및 미들웨어를 구성하여 SDK 동작을 사용자 지정합니다. 플러그인을 추가해 애플리케이션을 실행하는 컴퓨팅 리소스에 대한 데이터를 기록하고, 샘플링 규칙을 정의해 샘플링 동작을 구성하고, 로그 레벨을 설정해 애플리케이션 로그의 SDK에서 표시되는 정보 수준을 조절할 수 있습니다.

요청에 대한 추가 정보와 애플리케이션이 주석 및 메타데이터에서 하는 작업을 기록합니다. 주석은 필터 표현식과 함께 사용할 수 있도록 인덱싱된 단순한 키 값 쌍이기 때문에, 특정 데이터를 포함한 트레이스를 검색할 수 있습니다. 메타데이터 항목은 제한이 적으며 JSON으로 직렬화할 수 있는 모든 객체와 어레이를 기록할 수 있습니다.

주석 및 메타데이터

주석 및 메타데이터는 X-Ray SDK를 사용하여 세그먼트에 추가하는 임의의 텍스트입니다. 주석은 필터 표현식에서 사용하기 위해 인덱싱됩니다. 메타데이터는 인덱싱되지 않지만 X-Ray 콘솔 또는 API를 사용하여 원시 세그먼트에서 볼 수 있습니다. X-Ray에 대한 읽기 액세스가 부여된 사용자는 누구나 이 데이터를 볼 수 있습니다.

코드에 구성된 클라이언트가 많이 있다면, 구성된 클라이언트로 만든 각 요청의 하위 세그먼트를 대량으로 보관하는 요청 세그먼트 하나를 만들 수 있습니다. 사용자 지정 하위 세그먼트의 클라이언트 호출을 래핑해 하위 세그먼트를 조직하고 그룹화할 수 있습니다. 전체 함수 또는 코드 섹션에 대한 사용자 지정 하위 세그먼트를 생성할 수 있습니다. 그런 다음 상위 세그먼트에 모든 것을 적는 대신 하위 세그먼트에 메타데이터 및 주석을 레코딩할 수 있습니다.

SDK의 클래스 및 메서드에 대한 참조 문서는 AWS X-Ray SDK for Python API Reference를 참조하십시오.

요구 사항

Python용 X-Ray SDK는 다음 언어 및 라이브러리 버전을 지원합니다.

  • Python – 2.7, 3.4 이상

  • Django - 1.10 이상

  • Flask - 0.10 이상

  • aiohttp – 2.3.0 이상

  • AWS SDK for Python (Boto) - 1.4.0 이상

  • botocore - 1.5.0 이상

종속성 관리

Python용 X-Ray SDK는 pip에서 제공됩니다.

  • 패키지 - aws-xray-sdk

SDK를 requirements.txt 파일에 종속성으로 추가합니다.

예 requirements.txt

aws-xray-sdk==1.0 boto3==1.4.4 botocore==1.5.55 Django==1.11.3

Elastic Beanstalk를 사용하여 애플리케이션을 배포하는 경우 Elastic Beanstalk는 requirements.txt의 모든 패키지를 자동으로 설치합니다.

이 페이지에서: