CloudWatch ソリューション: Amazon EC2 での JVM ワークロード

このソリューションは、EC2 インスタンスで実行されている JVM アプリケーション用の CloudWatch エージェントを使用して、すぐに使用できるメトリクス収集を設定するのに役立ちます。さらに、事前設定された CloudWatch ダッシュボードを設定するのに役立ちます。すべての CloudWatch オブザーバビリティソリューションの一般的な情報については、「CloudWatch オブザーバビリティソリューション」を参照してください。

要件

このソリューションは、以下の条件に適しています。

利点

このソリューションでは JVM をモニタリングしているため、以下のユースケースに役立つインサイトが得られます。

ソリューションの主な利点を以下に示します。

以下の画像は、このソリューションのダッシュボードの例です。

コスト

このソリューションは、アカウントでリソースを作成して使用します。標準使用には料金がかかります。これには以下を含みます。

CloudWatch の料金の詳細については、「Amazon CloudWatch の料金」をご覧ください。

料金計算ツールを使用すると、このソリューションを使用するためのおよその月額コストを見積もることができます。

このソリューションの CloudWatch エージェント設定

CloudWatch エージェントは、サーバー上およびコンテナ化された環境で継続的かつ自律的に実行されるソフトウェアです。インフラストラクチャとアプリケーションからメトリクス、ログ、トレースを収集し、CloudWatch と X-Ray に送信します。

CloudWatch エージェントの詳細については、「CloudWatch エージェントを使用してメトリクス、ログ、トレースを収集する」を参照してください。

このソリューションのエージェント設定では、ソリューションの基本的なメトリクスが収集されます。CloudWatch エージェントは、ダッシュボードのデフォルトで表示されるよりも多くの JVM メトリクスを収集するように設定できます。収集できるすべての JVM メトリクスのリストについては、「JVM メトリクスの収集」を参照してください。CloudWatch エージェント設定の一般的な情報については、「CloudWatch エージェントにより収集されるメトリクス」を参照してください。

JVM アプリケーションの JMX ポートを公開する

CloudWatch エージェントは JMX に依存して JVM プロセスに関連するメトリクスを収集します。これを実現するには、JVM アプリケーションから JMX ポートを公開する必要があります。JMX ポートを公開する手順は、JVM アプリケーションに使用するワークロードタイプによって異なります。これらの手順については、アプリケーションのドキュメントを参照してください。

通常、モニタリングと管理のために JMX ポートを有効にするには、JVM アプリケーションに次のシステムプロパティを設定します。必ず未使用のポート番号を指定してください。次の例では、認証されていない JMX を設定します。セキュリティポリシー/要件で、JMX を有効にするためにパスワード認証やリモートアクセスで SSL を有効にすることが必須の場合は、JMX のドキュメントを参照して必要なプロパティを設定します。

-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=port-number
-Dcom.sun.management.jmxremote.authenticate=false 
-Dcom.sun.management.jmxremote.ssl=false

アプリケーションの開始スクリプトと設定ファイルを確認して、これらの引数を追加する最適な場所を見つけます。コマンドラインから .jar ファイルを実行する場合、このコマンドは次のようになります。ここで、pet-search.jar はアプリケーション jar の名前です。

$ java -jar -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false pet-search.jar

このソリューションのエージェント設定

エージェントによって収集されるメトリクスは、エージェント設定で定義されます。このソリューションには、ソリューションのダッシュボードに適したディメンションで推奨メトリクスを収集するためのエージェント設定が用意されています。

ソリューションをデプロイする手順については、「ソリューションにエージェントをデプロイする」で後述します。以下の情報は、環境に合わせてエージェント設定をカスタマイズする方法を理解するのに役立ちます。

環境に合わせて、次のエージェント設定の一部をカスタマイズする必要があります。

例えば、同じアカウントで実行されている Java アプリケーションが 2 つあり、1 つは order-processing アプリケーション用、もう 1 つは inventory-management アプリケーション用である場合、それに応じて各インスタンスのエージェント設定で ProcessGroupName ディメンションを設定する必要があります。

これらのガイドラインに従うと、ソリューションダッシュボードは ProcessGroupName ディメンションに基づいてメトリクスを自動的にグループ化します。ダッシュボードには、特定のプロセスグループのメトリクスを選択および表示するドロップダウンオプションが含まれており、個々のプロセスグループのパフォーマンスを個別にモニタリングできます。

JVM ホストのエージェント設定

Java アプリケーションがデプロイされている EC2 インスタンスでは、次の CloudWatch エージェント設定を使用します。設定は、「ステップ 2: 推奨 CloudWatch エージェント設定ファイルを Systems Manager パラメータストアに保存する」で後述するように、SSM のパラメータストアにパラメータとして保存されます。

ProcessGroupName をプロセスグループの名前に置き換えます。port-number を Java アプリケーションの JMX ポートに置き換えます。JMX がリモートアクセス用のパスワード認証または SSL で有効になっている場合は、必要に応じて、エージェント設定で TLS または認証を設定する方法について「Java Management Extensions (JMX) メトリクスの収集」を参照してください。

この設定 (JMX ブロックの外部に示される設定) に示される EC2 メトリクスは、Linux インスタンスと macOS インスタンスでのみ機能します。Windows インスタンスを使用している場合は、設定でこれらのメトリクスを省略できます。Windows インスタンスで収集されたメトリクスについては、「Windows Server インスタンスで CloudWatch エージェントにより収集されるメトリクス」を参照してください。

{
  "metrics": {
    "namespace": "CWAgent",
    "append_dimensions": {
      "InstanceId": "${aws:InstanceId}"
    },
    "metrics_collected": {
      "jmx": [
        {
          "endpoint": "localhost:port-number",
          "jvm": {
            "measurement": [
              "jvm.classes.loaded",
              "jvm.gc.collections.count",
              "jvm.gc.collections.elapsed",
              "jvm.memory.heap.committed",
              "jvm.memory.heap.max",
              "jvm.memory.heap.used",
              "jvm.memory.nonheap.committed",
              "jvm.memory.nonheap.max",
              "jvm.memory.nonheap.used",
              "jvm.threads.count"
            ]
          },
          "append_dimensions": {
            "ProcessGroupName": "ProcessGroupName"
          }
        }
      ],
      "disk": {
        "measurement": [
          "used_percent"
        ]
      },
      "mem": {
        "measurement": [
          "used_percent"
        ]
      },
      "swap": {
        "measurement": [
          "used_percent"
        ]
      },
      "netstat": {
        "measurement": [
          "tcp_established",
          "tcp_time_wait"
        ]
      }
    }
  }
}

ソリューションにエージェントをデプロイする

ユースケースに応じて、CloudWatch エージェントをインストールするためのいくつかのアプローチがあります。このソリューションには Systems Manager を使用することをお勧めします。これにより、コンソール操作機能が提供され、1 つの AWS アカウント内のマネージドサーバーのフリートの管理が簡単になります。このセクションの手順では Systems Manager を使用し、CloudWatch エージェントを既存の設定で実行していない場合を想定しています。CloudWatch エージェントが実行されているかどうかは、「CloudWatch エージェントが実行されていることを確認する」の手順に従って確認できます。

ワークロードがデプロイされている EC2 ホストで CloudWatch エージェントを既に実行していて、エージェント設定を管理している場合は、このセクションの手順をスキップし、既存のデプロイメカニズムに従って設定を更新できます。JVM のエージェント設定を既存のエージェント設定とマージしてから、マージされた設定をデプロイするようにしてください。Systems Manager を使用して CloudWatch エージェントの設定を保存および管理している場合は、設定を既存のパラメータ値にマージできます。詳細については、「CloudWatch エージェント設定ファイルの管理」を参照してください。

このデプロイプロセスには、以下のステップが含まれます。

ステップ 1: ターゲット EC2 インスタンスに必要な IAM アクセス許可があることを確認する

CloudWatch エージェントをインストールして設定するためのアクセス許可を Systems Manager に付与する必要があります。また、EC2 インスタンスから CloudWatch にテレメトリを発行するアクセス許可を CloudWatch エージェントに付与する必要もあります。インスタンスにアタッチされた IAM ロールに CloudWatchAgentServerPolicy と AmazonSSMManagedInstanceCore の IAM ポリシーがアタッチされていることを確認します。

ステップ 2: 推奨 CloudWatch エージェント設定ファイルを Systems Manager パラメータストアに保存する

パラメータストアでは、設定パラメータを安全に保存および管理することで EC2 インスタンスへの CloudWatch エージェントのインストールが簡素化され、ハードコーディングされた値が不要になります。これにより、デプロイプロセスがより安全で柔軟になり、集中管理が可能になり、複数のインスタンスで設定を簡単に更新できるようになります。

以下の手順を使用して、パラメータストアに推奨 CloudWatch エージェント設定ファイルをパラメータとして保存します。

ステップ 3: CloudWatch エージェントをインストールし、AWS CloudFormation テンプレートを使用して設定を適用する

AWS CloudFormation を使用してエージェントをインストールし、これまでの手順で作成した CloudWatch エージェント設定を使用するように設定できます。

まずテンプレートファイルを編集してカスタマイズする場合は、[スタックの作成ウィザード] の [テンプレートファイルのアップロード] オプションを選択して、編集したテンプレートをアップロードします。詳細については、「AWS CloudFormation コンソールからスタックを作成する」を参照してください。次のリンクを使用して、テンプレートをダウンロードできます: https://aws-observability-solutions-prod-us-east-1.s3.us-east-1.amazonaws.com/CloudWatchAgent/CFN/v1.0.0/cw-agent-installation-template-1.0.0.json。

ステップ 4: エージェントのセットアップが正しく設定されていることを確認する

CloudWatch エージェントがインストールされているかどうかは、「CloudWatch エージェントが実行されていることを確認する」の手順に従って確認できます。CloudWatch エージェントがインストールされておらず、実行されていない場合は、すべてが正しく設定されていることを確認してください。

すべてが正しく設定されている場合は、JVM メトリクスが CloudWatch に公開されているはずです。CloudWatch コンソールをチェックして、公開されていることを確認します。

JVM ソリューションダッシュボードを作成する

このソリューションが提供するダッシュボードには、サーバーの基盤となる Java 仮想マシン (JVM) のメトリクスが表示されます。すべてのインスタンスでメトリクスを集約して表示することで JVM の概要が示され、全体的なヘルスと運用状態の概要がわかります。さらに、ダッシュボードには、各メトリクスに寄与する上位の要因 (メトリクスウィジェットあたり上位 10 件) の内訳が表示されます。これにより、観測されたメトリクスに大きく寄与する外れ値やインスタンスをすばやく特定できます。

ソリューションダッシュボードには EC2 メトリクスは表示されません。EC2 メトリクスを表示するには、EC2 自動ダッシュボードを使用して EC2 からのメトリクスを表示し、EC2 コンソールダッシュボードを使用して CloudWatch エージェントによって収集された EC2 メトリクスを表示する必要があります。AWS サービスの自動ダッシュボードの詳細については、「単一の AWS サービスの CloudWatch ダッシュボードの表示」を参照してください。

ダッシュボードを作成するには、以下のオプションを使用できます。

CloudWatch コンソールを使用してダッシュボードを作成すると、実際に作成して課金される前にダッシュボードをプレビューできます。

何らかの目的でテンプレートファイルを編集してカスタマイズする場合は、[スタックの作成ウィザード] の [テンプレートファイルのアップロード] オプションを使用して、編集したテンプレートをアップロードできます。詳細については、「AWS CloudFormation コンソールからスタックを作成する」を参照してください。次のリンクを使用して、テンプレートをダウンロードできます: https://aws-observability-solutions-prod-us-east-1.s3.us-east-1.amazonaws.com/JVM_EC2/CloudWatch/CFN/v1.0.0/dashboard-template-1.0.0.json。

JVM ダッシュボードの使用を開始する

新しい JVM ダッシュボードで試すことができるタスクをいくつか示します。これらのタスクにより、ダッシュボードが正しく機能していることの検証が可能になり、JVM プロセスグループをモニタリングするためにダッシュボードを実際に使用する経験ができます。これらを試すと、ダッシュボードの操作に慣れ、可視化されたメトリクスを解釈できるようになっていきます。

プロセスグループを選択する

[JVM プロセスグループ名] ドロップダウンリストを使用して、モニタリングするプロセスグループを選択します。ダッシュボードは自動的に更新されて、選択したプロセスグループのメトリクスが表示されます。複数の Java アプリケーションまたは環境がある場合、それぞれが別々のプロセスグループとして表される場合があります。適切なプロセスグループを選択すると、分析するアプリケーションまたは環境に固有のメトリクスを表示できます。

メモリ使用率を確認する

ダッシュボードの概要セクションから、[ヒープメモリ使用率 (%)] ウィジェットと [非ヒープメモリ使用率 (%)] ウィジェットを見つけます。これらは、選択したプロセスグループ内のすべての JVM で使用されているヒープメモリと非ヒープメモリの使用率を示しています。使用率が高いと、メモリにプレッシャーがかかっている可能性があります。これはパフォーマンスの問題や OutOfMemoryError 例外につながる可能性があります。また、[ホスト別のメモリ使用率] でホスト別のヒープ使用率の内訳を確認して、使用率の高いホストをチェックすることもできます。

スレッドとロードされたクラスを分析する

[ホスト別のスレッドとロードされたクラス] セクションで、[上位 10 のスレッド数] ウィジェットと [ロードされた上位 10 のクラス] ウィジェットを見つけます。スレッド数またはクラス数が他と比較して異常に多い JVM がないか探します。スレッドが多すぎることは、スレッドリークや過剰な同時実行を示している可能性があり、ロードされたクラスが多いことは、クラスローダーリークや非効率的な動的クラス生成を示している可能性があります。

ガベージコレクションの問題を特定する

[ガベージコレクション] セクションで、Young、Concurrent、Mixed の各ガベージコレクタータイプに対して、[1 分あたりのガベージコレクションの呼び出し上位 10 件] ウィジェットと、[ガベージコレクションの持続時間上位 10 件] ウィジェットを見つけます。他と比較して非常にコレクションが多い JVM やコレクションの持続時間が長い JVM がないか探します。これは、設定の問題やメモリリークを示している可能性があります。