翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

からSDKメトリクスを使用する AWS SDK for Java

AWS SDK for Java 2.x を使用すると、アプリケーション内のサービスクライアントに関するメトリクスを収集し、 で出力を分析し Amazon CloudWatch、それに基づいて行動できます。

デフォルトでは、メトリクスコレクションは で無効になっていますSDK。このトピックは、それを有効にして設定するのに役立ちます。

前提条件

メトリクスを有効にして使用する前に、次の手順を完了する必要があります。

メトリクスの収集を有効にする方法

アプリケーションでサービスクライアントのメトリクスを有効にすることも、個々のリクエストでメトリクスを有効にすることもできます。

特定のリクエストのメトリクスを有効にする

次のクラスは、 へのリクエストの CloudWatch メトリクスパブリッシャーを有効にする方法を示しています Amazon DynamoDB。デフォルトのメトリクスパブリッシャー設定を使用します。

import software.amazon.awssdk.metrics.MetricPublisher;
import software.amazon.awssdk.metrics.publishers.cloudwatch.CloudWatchMetricPublisher;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.ListTablesRequest;

public class DefaultConfigForRequest {
    // Use one MetricPublisher for your application. It can be used with requests or service clients.
    static MetricPublisher metricsPub = CloudWatchMetricPublisher.create();

    public static void main(String[] args) {
        DynamoDbClient ddb = DynamoDbClient.create();
        // Publish metrics the for ListTables operation.
        ddb.listTables(ListTablesRequest.builder()
            .overrideConfiguration(c -> c.addMetricPublisher(metricsPub))
            .build());

        // Perform more work in your application.

        // A MetricsPublisher has its own lifecycle independent of any service client or request that uses it.
        // If you no longer need the publisher, close it to free up resources.
        metricsPub.close();  // All metrics stored in memory are flushed to CloudWatch.

        // Perform more work with the DynamoDbClient instance without publishing metrics.
        // Close the service client when you no longer need it.
        ddb.close();
    }
}

特定のサービスクライアントのサマリーメトリクスを有効にする

次のコードスニペットは、サービスクライアントのデフォルト設定で CloudWatch メトリクスパブリッシャーを有効にする方法を示しています。

MetricPublisher metricsPub = CloudWatchMetricPublisher.create();

DynamoDbClient ddb = DynamoDbClient.builder()
          .overrideConfiguration(c -> c.addMetricPublisher(metricsPub))
          .build();

メトリクスパブリッシャーをカスタマイズする

次のクラスは、特定のサービスクライアントのメトリクスパブリッシャーにカスタム設定を設定する方法を示しています。カスタマイズには、特定のプロファイルのロード、メトリクスパブリッシャーがリクエストを送信する AWS リージョンの指定、パブリッシャーがメトリクスを に送信する頻度のカスタマイズが含まれます CloudWatch。

import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.core.metrics.CoreMetric;
import software.amazon.awssdk.metrics.MetricPublisher;
import software.amazon.awssdk.metrics.publishers.cloudwatch.CloudWatchMetricPublisher;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.cloudwatch.CloudWatchAsyncClient;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;

import java.time.Duration;

public class CustomConfigForDDBClient {
    // Use one MetricPublisher for your application. It can be used with requests or service clients.
    static MetricPublisher metricsPub = CloudWatchMetricPublisher.builder()
        .cloudWatchClient(CloudWatchAsyncClient.builder()
            .region(Region.US_WEST_2)
            .credentialsProvider(ProfileCredentialsProvider.create("cloudwatch"))
            .build())
        .uploadFrequency(Duration.ofMinutes(5))
        .maximumCallsPerUpload(100)
        .namespace("ExampleSDKV2Metrics")
        .detailedMetrics(CoreMetric.API_CALL_DURATION)
        .build();

    public static void main(String[] args) {
        DynamoDbClient ddb = DynamoDbClient.builder()
            .overrideConfiguration(c -> c.addMetricPublisher(metricsPub))
            .build();
        // Publish metrics for DynamoDB operations.
        ddb.listTables();
        ddb.describeEndpoints();
        ddb.describeLimits();
        // Perform more work in your application.

        // A MetricsPublisher has its own lifecycle independent of any service client or request that uses it.
        // If you no longer need the publisher, close it to free up resources.
        metricsPub.close();  // All metrics stored in memory are flushed to CloudWatch.


        // Perform more work with the DynamoDbClient instance without publishing metrics.
        // Close the service client when you no longer need it.
        ddb.close();
    }
}

前のスニペットで示したカスタマイズには、次の効果があります。

メトリクスが利用可能になるまでの時間

メトリクスは、 SDK for Java がメトリクスを発行してから 5～10 分以内に一般公開されます。正確な と up-to-dateメトリクスについては、Java アプリケーションからメトリクスを送信してから少なくとも 10 分後に Cloudwatch を確認してください。

収集される情報

メトリクスの収集には、次のものが含まれます。

詳細なリストについては、サービスクライアントのメトリクスを参照してください。

この情報の使用方法

がSDK収集するメトリクスを使用して、アプリケーション内のサービスクライアントをモニタリングできます。全体的な使用傾向の確認や、異常の特定ができるほか、返されたサービスクライアントの例外を確認したり、特定の問題を理解するために詳しく確認したりすることもできます。を使用して Amazon CloudWatch、アプリケーションが定義した条件に達したらすぐに通知するアラームを作成することもできます。

詳細については、Amazon CloudWatch 「 ユーザーガイド」のAmazon CloudWatch 「メトリクスの使用」とAmazon CloudWatch 「アラームの使用」を参照してください。