Go용 AWS X-Ray SDK

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

go get을 사용하여 해당 GitHub 리포지토리에서 SDK를 다운로드합니다.

$ go get -u github.com/aws/aws-xray-sdk-go/... 

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

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

참고

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

다음으로 클라이언트를 AWS 함수에 대한 호출로 래핑합니다. 이 단계를 통해 X-Ray가 모든 클라이언트 메서드에 대한 호출을 구성할 수 있습니다. 또한 SQL 데이터베이스에 대한 호출을 구성할 수 있습니다.

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

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

주석 및 메타데이터

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

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

요구 사항

Go용 X-Ray SDK를 사용하려면 Go 1.9 이상이 필요합니다.

SDK는 컴파일 및 실행 시간 시 다음 라이브러리에 의존합니다.

• Go용 AWS SDK 버전 1.10.0 이상

이러한 종속성은 SDK의 README.md 파일에서 선언됩니다.

참조 문서

SDK를 다운로드했으면 문서를 로컬에서 빌드하고 호스트하여 웹 브라우저에서 봅니다.

참조 문서를 보려면

1. $GOPATH/src/github.com/aws/aws-xray-sdk-go(Linux 또는 Mac) 디렉터리 또는 %GOPATH%\src\github.com\aws\aws-xray-sdk-go(Windows) 폴더로 이동

2. godoc 명령을 실행합니다.

   $ godoc -http=:6060

3. http://localhost:6060/pkg/github.com/aws/aws-xray-sdk-go/에서 브라우저 열기