Systems Manager を使用して、統合された CloudWatch エージェントをインストールおよび設定する方法を教えてください。

所要時間2分

AWS Systems Manager を使用して、統合された Amazon CloudWatch エージェントをインストールおよび設定したいと考えています。

簡単な説明

次の手順に従い、統合された CloudWatch エージェントをインストールして設定します。

CloudWatch エージェントを実行できる AWS Identity and Access Management (IAM) ロールを作成します。次に、その IAM ロールを Amazon Elastic Compute Cloud (Amazon EC2) インスタンスにアタッチします。
AWS Systems Manager を使用して、CloudWatch エージェントをダウンロードしてインストールします。
Amazon EC2 インスタンスから CloudWatch にプッシュする予定のメトリクスとログを指定した、エージェント設定ファイルを作成します。
設定ファイルを使用して CloudWatch エージェントを起動します。

解決策に着手する前に、EC2 インスタンスでインターネット接続を確立し、インスタンスを必要なエンドポイントに接続します。

IAM コンソールを開き、[ロール] を選択して、[ロールを作成] を選択します。
[信頼されたエンティティの種類を選択] から、[AWS サービス] を選択します。
[一般的なユースケース] で [EC2] を選択し、[次へ] を選択します。
ポリシーのリストで、[CloudWatchAgentServerPolicy] および [AmazonSSMManagedInstanceCore] チェックボックスをオンにし、[次へ] を選択します。
[ロール名] に、ロールの名前 (CloudWatchAgentServerRole など) を入力します。
(オプション) ロールの説明を入力します。
[ポリシー] の横に [CloudWatchAgentServerPolicy] と [AmazonSSMManagedInstanceCore] が表示されていることを確認します。
[ロールを成] を選択します。
IAM ロールを EC2 インスタンスにアタッチします。

オンプレミスサーバーの場合は、「Create IAM users to use with the CloudWatch agent on on-premises servers」を参照してください。

前提条件:

AWS Systems Manager Agent (SSM Agent) バージョン 2.2.93.0 以降をインスタンスにインストールします。
SSM Agent が EC2 インスタンスを管理しており、ステータスが [オンライン] であることを確認してください。問題をトラブルシューティングするには、「Systems Manager で EC2 インスタンスがマネージドノードとして表示されない、または『接続が失われました』というステータスが表示されるのはなぜですか?」を参照してください。
CloudWatch Logs にデータを送信できるように、アウトバウンドのインターネットアクセスを設定します。仮想プライベートクラウド (virtual private cloud: VPC) のエンドポイントまたはプロキシを使用している場合は、CloudWatch エンドポイントと CloudWatch Logs エンドポイントを設定します。

ヒント: エージェント設定ファイルを作成するウィザードを使用します。その後、ファイルを手動で編集して、メトリクスやログを追加または削除できます。詳細については、以下の「エージェント設定ファイルウィザードを完了するためのヒント」セクションを参照してください。

ウィザードを実行します。

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-config-wizard

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a fetch-config -m ec2 -c file:configuration-file-path -s

注: configuration-file-path は、前述の手順で受け取った設定ファイルのパスに置き換えてください。

デフォルトでは、エージェントは NameSpace CWAgent にメトリクスをプッシュします。

詳細については、「Create the CloudWatch agent configuration file」を参照してください。

エージェント設定ファイルウィザードを設定する際、次の質問が表示されます。

Do you want to turn on StatsD daemon? および Do you want to monitor metrics from CollectD? StatsD および CollectD プラグインを EC2 インスタンスにインストールしている場合のみ、これらの質問に対して [はい] を選択します。
どのデフォルトメトリクス設定を適用しますか? さまざまな詳細レベルについては、「CloudWatch agent predefined metric sets」を参照してください。その後で、ユースケースに最適なオプションを選択します。
移行用にインポートできる既存の CloudWatch Logs エージェント設定ファイルはありますか? awslogs エージェントを実行している場合、ウィザードは awslogs エージェント設定ファイル (/etc/awslogs/awslogs.conf または /var/awslogs/etc/awslogs.conf) を読み取り、監視するログファイルを決定します。
AWS Systems Manager の機能であるパラメータストアに設定を保存しますか? 後でエージェント設定ファイルを再利用する場合は、[はい] を選択してファイルをパラメータストアに保存します。
重要: エージェント設定ファイルをパラメータストアに保存した場合、エージェントを起動するコマンドは異なってきます。

ウィザードを完了すると、エージェント設定ファイルはデフォルトで /opt/aws/amazon-cloudwatch-agent/bin/config.json に保存されます。このファイルを手動で編集して、メトリクスやログを追加、または削除できます。

CloudWatch エージェントを起動および停止する手順については、「Stopping and restarting the CloudWatch agent」を参照してください。

注: エージェント設定ファイルを変更した場合は、fetch-config コマンドを使用してエージェントを起動することで、変更がエージェントに反映されるようにします。