X-Ray SDK for Java を使用して AWS SDK 呼び出しをトレースする

アプリケーションで AWS のサービスへの呼び出しを行い、データの保存、キューへの書き込み、または通知の送信を行う場合、X-Ray SDK for Java によってサブセグメントの呼び出しダウンストリームが追跡されます。これらのサービス (たとえば、Amazon S3 バケットまたは Amazon SQS キュー) 内でアクセスするトレースされている AWS のサービスおよびリソースは、X-Ray コンソールのサービスマップではダウンストリームノードとして表示されます。

aws-sdk および aws-sdk-instrumentor サブモジュールをビルドに含めると、X-Ray SDK for Java では自動的にすべての AWS SDK クライアントを計測します。Instrumentor サブモジュールを含めない場合は、一部のクライアントを計測して他を除外できます。

個別のクライアントを計測するには、aws-sdk-instrumentor サブモジュールをビルドから削除し、サービスのクライアントビルダーを使用して XRayClient を TracingHandler として AWS SDK クライアントに追加します。

たとえば、AmazonDynamoDB を計測するには、トレースハンドラーを AmazonDynamoDBClientBuilder に渡します。

例 MyModel.java - DynamoDB クライアント

import com.amazonaws.xray.AWSXRay;
import com.amazonaws.xray.handlers.TracingHandler;

...
public class MyModel {
  private AmazonDynamoDB client = AmazonDynamoDBClientBuilder.standard()
        .withRegion(Regions.fromName(System.getenv("AWS_REGION")))
        .withRequestHandlers(new TracingHandler(AWSXRay.getGlobalRecorder()))
        .build();
...

すべてのサービスについて、呼び出された API の名前を X-Ray コンソールに表示できます。サービスのサブセットの場合、X-Ray SDK はセグメントに情報を追加し、より詳しい内容をサービスマップに表示します。

たとえば、インストルメント化された DynamoDB クライアントを使用して呼び出しを行う場合、SDK はテーブルを対象とする呼び出しでセグメントにテーブル名を追加します。コンソールでは、各テーブルがサービスマップで個別のノードとして表示され、テーブルを対象としない呼び出しには 1 つの汎用の DynamoDB ノードが表示されます。

例 項目を保存するための 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 – キュー名

AWS SDK for Java 2.2 以降でダウンストリーム呼び出しを AWS のサービスに実装するには、ビルド設定から aws-xray-recorder-sdk-aws-sdk-v2-instrumentor モジュールを除外します。その代わりに、aws-xray-recorder-sdk-aws-sdk-v2 module を含め、TracingInterceptor で設定して個々のクライアントを実装します。

例 AWS SDK for Java 2.2 以降 - トレースインターセプター

import com.amazonaws.xray.interceptors.TracingInterceptor;
import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
//...
public class MyModel {
private DynamoDbClient client = DynamoDbClient.builder()
.region(Region.US_WEST_2)
.overrideConfiguration(ClientOverrideConfiguration.builder()
.addExecutionInterceptor(new TracingInterceptor())
.build()
)
.build();
//...