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

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

要件

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

利点

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

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

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

コスト

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

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

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

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

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

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

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

Tomcat サーバーの JMX ポートを公開する

CloudWatch エージェントは、JMX に依存して Tomcat サーバーと JVM プロセスに関連するメトリクスを収集します。これを実現するには、サーバーから JMX ポートを公開する必要があります。モニタリングと管理のために JMX ポートを有効にするには、Tomcat サーバーのシステムプロパティを設定します。環境変数 CATALINA_OPTS を使用して、Tomcat に必要なシステムプロパティを設定できます。環境変数を設定する最適な場所について、Tomcat サーバーの開始スクリプトと設定ファイルを確認します。必ず未使用のポート番号を指定してください。変更後にサーバーを再起動する必要があります。

export CATALINA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=<<port-number>> -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false"

この例では、認証されていない JMX を設定します。セキュリティポリシー/要件で、JMX を有効にするためにパスワード認証やリモートアクセスで SSL を有効にすることが必須の場合は、JMX のドキュメントを参照して必要なプロパティを設定します。

JMX ポートを確認するには、ps aux | grep jmxremote.port を実行します。結果は、JMX ポートが JVM プロセスで設定されたことを示すはずです。

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

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

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

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

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

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

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

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

AppName を、インスタンスが属する Tomcat アプリケーションを表す意味のある名前に置き換えます。port-number を Tomcat サーバーの 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",
          "tomcat": {
            "measurement": [
              "tomcat.sessions",
              "tomcat.errors",
              "tomcat.processing_time",
              "tomcat.traffic",
              "tomcat.max_time",
              "tomcat.request_count",
              "tomcat.threads"
            ]
          },
          "append_dimensions": {
            "AppName": "AppName"
          }
        },
        {
          "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": "AppName"
          }
        }
      ],
      "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 エージェントが実行されていることを確認する」の手順に従って確認できます。

JVM アプリケーションがデプロイされている 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 エージェントがインストールされておらず、実行されていない場合は、すべてが正しく設定されていることを確認してください。

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

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

このダッシュボードには、Tomcat アプリケーションサーバーと基盤となる JVM の両方を示す、新しく出力されるメトリクスが表示されます。このダッシュボードには、Tomcat ワークロードのヘルスに寄与する上位の要因が表示されます。寄与する上位の要因のビューには、メトリクスウィジェットあたり上位 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/Tomcat_EC2/CloudWatch/CFN/v1.0.0/dashboard-template-1.0.0.json。

Tomcat モニタリングダッシュボードの使用を開始する

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

ドロップダウンリストの使用

ダッシュボードの上部には、モニタリングする特定の Tomcat アプリケーションのフィルタリングと選択に使用できるドロップダウンリストが表示されます。特定の Tomcat アプリケーションのメトリクスを表示するには、[Tomcat アプリケーション] ドロップダウンリストでそのアプリケーション名を選択します。

アプリケーションのヘルスを確認する

[アプリケーションの概要] セクションから、[リクエスト]、[エラー]、および [エラー率] の各ウィジェットを見つけます。これらは、アプリケーションのリクエスト処理パフォーマンスの概要を示します。異常に多いエラー数やエラー率がないか調べます。これは、調査が必要な問題を示している可能性があります。

リクエスト処理をモニタリングする

[リクエスト処理時間] セクションで、[最大時間] ウィジェットと [すべてのリクエストを処理する合計時間] ウィジェットを見つけます。これらのメトリクスは、リクエスト処理における潜在的なパフォーマンスのボトルネックを特定するのに役立ちます。最大処理時間が他のサーバーよりも大幅に長いサーバーがないか探します。

ネットワークトラフィックを分析する

[ネットワークトラフィック] セクションで、[送信されたトラフィック] ウィジェットと [受信したトラフィック] ウィジェットを見つけます。これらは、アプリケーションがネットワーク経由で送受信するデータの量を示します。想定外にトラフィックレベルが高い場合は、ネットワーク飽和や非効率なデータ転送の問題が発生する可能性があります。

スレッドの使用状況を調査する

[セッションとスレッド] セクションで、[ビジースレッド数]、[スレッド数] 、および [セッション] の各ウィジェットを見つけます。これらのメトリクスからは、アプリケーションのスレッド管理とアクティブなユーザーセッションに関するインサイトが得られます。ビジースレッド数またはセッション数が異常に多いサーバーを探します。これは、リソースが制約されている可能性を示します。