AWS SDK for Java に対するメトリクスの有効化 - AWS SDK for Java 1.x

AWS SDK for Java 1.x は 2024 年 7 月 31 日にメンテナンスモードに入り、2025 年 12 月 31 日にサポート終了となります。新しい機能、可用性の向上、セキュリティ更新のために、AWS SDK for Java 2.x に移行することをお勧めします。

AWS SDK for Java に対するメトリクスの有効化

AWS SDK for Java は、以下を測定する Amazon CloudWatch での可視化およびモニタリング用のメトリクスを生成できます。

  • AWS にアクセスしているときのアプリケーションのパフォーマンス

  • AWS で使用されているときの JVM のパフォーマンス

  • ヒープメモリ、スレッド数、開かれたファイル記述子などのランタイム環境の詳細

Java SDK メトリクス生成を有効にする方法

SDK が CloudWatch にメトリクスを送信できるようにするには、次の Maven 依存関係を追加する必要があります。

<dependencyManagement> <dependencies> <dependency> <groupId>com.amazonaws</groupId> <artifactId>aws-java-sdk-bom</artifactId> <version>1.12.490*</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>com.amazonaws</groupId> <artifactId>aws-java-sdk-cloudwatchmetrics</artifactId> <scope>provided</scope> </dependency> <!-- Other SDK dependencies. --> </dependencies>

* バージョン番号を Maven Central で入手可能な SDK の最新バージョンに置き換えてください。

AWS SDK for Java のメトリクスは、デフォルトでは無効になっています。これをローカル開発環境で有効にするには、JVM の起動時に AWS セキュリティ認証情報ファイルをポイントするシステムプロパティを含めます。例:

-Dcom.amazonaws.sdk.enableDefaultMetrics=credentialFile=/path/aws.properties

後の分析用に SDK が収集されたデータポイントを CloudWatch にアップロードできるよう、認証情報ファイルへのパスを指定する必要があります。

注記

Amazon EC2 インスタンスメタデータサービスを使用して Amazon EC2 インスタンスから AWS にアクセスしている場合、認証情報ファイルを指定する必要はありません。この場合、指定する必要があるのは以下だけです。

-Dcom.amazonaws.sdk.enableDefaultMetrics

AWS SDK for Java にキャプチャされたすべてのメトリクスは、AWSSDK/Java という名前空間にあり、CloudWatch のデフォルトリージョン (us-east-1) にアップロードされます。リージョンを変更するには、システムプロパティの cloudwatchRegion 属性を使用して指定します。例えば、CloudWatch リージョンを us-east-1 に設定するには、次を使用します。

-Dcom.amazonaws.sdk.enableDefaultMetrics=credentialFile=/path/aws.properties,cloudwatchRegion={region_api_default}

この機能を有効にすると、AWS SDK for Java から AWS にサービスリクエストがあるたびに、メトリクスのデータポイントが生成され、統計的要約のためのキューに入れられ、約 1 分に 1 回 CloudWatch に非同期でアップロードされます。メトリクスがアップロードされたら、AWS マネジメントコンソール を使用して可視化し、メモリリーク、ファイル記述子リークなどの潜在的な問題にアラームを設定できます。

利用可能なメトリクスのタイプ

デフォルトのメトリクスのセットは 3 つの主要なカテゴリに分かれています。

AWS リクエストメトリクス
  • HTTP リクエスト/応答のレイテンシー、リクエスト数、例外および再試行などのエリアを扱います。

    RequestMetric 131111
AWS のサービス のメトリクス
  • S3 アップロードとダウンロードのスループットやバイトカウントなど、AWS のサービス に固有のデータを含みます。

    ServiceMetric 131111
マシンメトリクス
  • ヒープメモリ、スレッド数、および開いているファイル記述子を含むランタイム環境を扱います。

    MachineMetric 131111

    マシンメトリクスを除外する場合は、システムプロパティに excludeMachineMetrics を追加します。

    -Dcom.amazonaws.sdk.enableDefaultMetrics=credentialFile=/path/aws.properties,excludeMachineMetrics

詳細情報