Amazon CloudWatch
ユーザーガイド

開始方法: CloudWatch エージェントを最初のインスタンスにインストールする

CloudWatch エージェントをダウンロードして実行中の Amazon EC2 インスタンスにインストールするには、AWS Systems Manager またはコマンドラインのどちらかを使用できます。どちらの方法でも、まず IAM ロールを作成してインスタンスにアタッチする必要があります。

IAM ロールをインスタンスにアタッチする

CloudWatch エージェントを Amazon EC2 インスタンスにインストールするときは、インスタンスプロファイルの IAM ロールが必要です。このロールは、CloudWatch エージェントがインスタンス上でアクションを実行できるようにします。前のステップで作成したロールのいずれかを使用します。これらのロールの作成についての詳細は、「CloudWatch エージェントで使用する IAM ロールおよびユーザーを作成する」を参照してください。リストをスクロールして見つけるか、検索ボックスを使用することができます。

このインスタンスを使用して CloudWatch エージェント設定ファイルを作成し、Systems Manager Parameter Store にコピーする場合は、Parameter Store に書き込むアクセス権限を持つ、作成したロールを使用します。このロールの名前は CloudWatchAgentAdminRole などです。

他のすべてのインスタンスの場合、エージェントのインストールと実装に必要なアクセス権限のみ含まれるロールを選択します。このロールの名前は CloudWatchAgentServerRole などです。

CloudWatch エージェントをインストールするインスタンスにこのロールをアタッチします。詳細については、Windows インスタンスの Amazon EC2 ユーザーガイドの「IAM ロールをインスタンスにアタッチする」を参照してください。

Amazon EC2 インスタンスに CloudWatch エージェントパッケージをインストールする

Systems Manager Run Command または Amazon S3 ダウンロードリンクを使用して、CloudWatch エージェントパッケージをダウンロードできます。

AWS Systems Manager を使用して Amazon EC2 インスタンスに CloudWatch エージェントをインストールする

Systems Manager を使用して CloudWatch エージェントをインストールするには、Systems Manager に合わせてインスタンスが適切に設定されていることを確認する必要があります。

SSM Agent をインストールまたは更新する

Amazon EC2 インスタンスでは、CloudWatch エージェントを使用するにはバージョン 2.2.93.0 以降のインスタンスが実行されている必要があります。CloudWatch エージェントをインストールする前に、SSM Agent を更新するか、インスタンスにインストールしてください (まだの場合)。

Linux を実行しているインスタンスでの SSM Agent のインストールまたは更新については、AWS Systems Manager ユーザーガイドの「Linux インスタンスでの SSM Agent のインストールおよび設定」を参照してください。

SSM Agent のインストールまたは更新については、AWS Systems Manager ユーザーガイドの「SSM Agent のインストールおよび設定」を参照してください。

(オプション) Systems Manager の前提条件を確認する

Systems Manager Run Command を使用して CloudWatch エージェントをインストールおよび設定する前に、インスタンスが Systems Manager の最小要件を満たしていることを確認します。詳細については、AWS Systems Manager ユーザーガイドの「リSystems Manager の前提条件」を参照してください。

インターネットアクセスを確認する

データを CloudWatch または CloudWatch Logs に送信するには、Amazon EC2 インスタンスにアウトバウンドのインターネットアクセスが必要です。インターネットアクセスの詳しい設定方法については、Amazon VPC ユーザーガイド の「インターネットゲートウェイ」を参照してください。

プロキシで設定するエンドポイントとポートは、次のとおりです。

  • エージェントを使用してメトリクスを収集する場合は、適切なリージョンの CloudWatch エンドポイントをホワイトリストに入れる必要があります。これらのエンドポイントは、アマゾン ウェブ サービス全般のリファレンスAmazon CloudWatch に一覧表示されます。

  • エージェントを使用してログを収集する場合は、適切なリージョンの CloudWatch Logs エンドポイントをホワイトリストに入れる必要があります。これらのエンドポイントは、アマゾン ウェブ サービス全般のリファレンスAmazon CloudWatch Logs に一覧表示されます。

  • SSM を使用して、エージェントまたは Parameter Store をインストールして設定ファイルを保存する場合は、適切なリージョンの SSM エンドポイントをホワイトリストに入れる必要があります。これらのエンドポイントは、アマゾン ウェブ サービス全般のリファレンスAWS Systems Manager に一覧表示されます。

Run Command を使用して CloudWatch エージェントパッケージをダウンロードする

Systems Manager Run Command では、インスタンスの設定を管理できます。Systems Manager ドキュメントを指定してパラメータを指定し、1 つ以上のインスタンスでコマンドを実行します。インスタンスの SSM Agent は、コマンドを処理し、指定されたとおりにインスタンスを設定します。

Run Command を使用して CloudWatch エージェントをダウンロードするには

  1. Open the Systems Manager console at https://console.aws.amazon.com/systems-manager/.

  2. In the navigation pane, choose Run Command.

    -or-

    If the AWS Systems Manager home page opens, scroll down and choose Explore Run Command.

  3. [Run command] を選択します。

  4. [Command document] リストで、[AWS-ConfigureAWSPackage] を選択します。

  5. [Targets] 領域で、CloudWatch エージェントをインストールするインスタンスを選択します。特定のインスタンスが表示されない場合、Run Command 用に設定されていない可能性があります。詳細については、Windows インスタンスの Amazon EC2 ユーザーガイドの「Systems Manager の前提条件」を参照してください。

  6. [Action] リストで、[Install] を選択します。

  7. [Name] フィールドに、「AmazonCloudWatchAgent」と入力します。

  8. エージェントの最新バージョンをインストールには、[Version] を [latest] に設定したままにします。

  9. [Run] を選択します。

  10. 必要に応じて、[Targets and outputs] 領域で、インスタンス名の横のボタンを選択して [View output] を選択します。Systems Manager に、エージェントが正常にインストールされたことが表示されます。

ダウンロードリンクを使用して Amazon EC2 インスタンスに CloudWatch エージェントパッケージをダウンロードする

Amazon S3 ダウンロードリンクを使用すると、Amazon EC2 インスタンスサーバーに CloudWatch エージェントパッケージをダウンロードできます。

コマンドラインを使用して CloudWatch エージェントを Amazon EC2 インスタンスにインストールするには

  1. エージェントパッケージをダウンロードして解凍するためのディレクトリを作成します。 ("tmp/AmazonCloudWatchAgent" など)。次に、そのディレクトリに移動します。

  2. CloudWatch エージェントをダウンロードします。Linux サーバーの場合、次を入力します。

    wget https://s3.amazonaws.com/amazoncloudwatch-agent/linux/amd64/latest/AmazonCloudWatchAgent.zip

    Windows Server を実行しているサーバーの場合、次のファイルをダウンロードします。

    https://s3.amazonaws.com/amazoncloudwatch-agent/windows/amd64/latest/AmazonCloudWatchAgent.zip
  3. パッケージをダウンロードしたら、必要に応じて GPG 署名ファイルを使用してパッケージの署名を確認できます。詳細については、「CloudWatch エージェントパッケージの署名を確認する」を参照してください。

  4. パッケージを解凍します。

    unzip AmazonCloudWatchAgent.zip
  5. パッケージをインストールします。Linux サーバーでは、パッケージを含むディレクトリに移動し、次のように入力します。

    sudo ./install.sh

    Windows Server を実行するサーバーでは、PowerShell を開いて、解凍されたパッケージを含むディレクトリに移動し、install.ps1 スクリプトを使用してインストールします。

(オプション) CloudWatch エージェントの一般的な設定と名前付きプロファイルを変更する

ダウンロードした CloudWatch エージェントパッケージには、common-config.toml という設定ファイルが含まれています。このファイルを使用して、プロキシ、認証情報、およびリージョン情報を指定できます。Linux を実行しているサーバーでは、このファイルは /opt/aws/amazon-cloudwatch-agent/etc ディレクトリにあります。Windows Server を実行しているサーバーでは、このファイルは C:\ProgramData\Amazon\AmazonCloudWatchAgent ディレクトリにあります。

デフォルトの common-config.toml は次のようになります。

CloudWatch エージェントを Amazon EC2 インスタンスにインストールするとき、プロキシ設定を指定する必要がある場合や、インスタンスとは別のリージョンにある CloudWatch にエージェントがメトリクスを送信しなければならないときは、このファイルのみ変更する必要があります。

# This common-config is used to configure items used for both ssm and cloudwatch access ## Configuration for shared credential. ## Default credential strategy will be used if it is absent here: ## Instance role is used for EC2 case by default. ## AmazonCloudWatchAgent profile is used for onPremise case by default. # [credentials] # shared_credential_profile = "{profile_name}" ## Configuration for proxy. ## System-wide environment-variable will be read if it is absent here. ## i.e. HTTP_PROXY/http_proxy; HTTPS_PROXY/https_proxy; NO_PROXY/no_proxy ## Note: system-wide environment-variable is not accessible when using ssm run-command. ## Absent in both here and environment-variable means no proxy will be used. # [proxy] # http_proxy = "{http_url}" # https_proxy = "{https_url}" # no_proxy = "{domain}"

初期状態では、すべての行がコメントアウトされています。認証情報プロファイルやプロキシ設定を設定するには、その行から # を削除し、値を指定します。このファイルは、手動で編集したり、Systems Manager で RunShellScript Run Command を使用したりすることができます。

  • proxy settings サーバーが HTTP または HTTPS プロキシを使用して AWS サービスに接続している場合、http_proxy フィールドと https_proxy フィールドでそれらのプロキシを指定します。プロキシから除外すべき URL がある場合、カンマで区切って no_proxy フィールドで指定します。

  • shared_credential_profile CloudWatch エージェントによってメトリクスがインスタンスと同じリージョンにある CloudWatch に送信されるよう指定するとき、適切なアクセス権限を持つ IAM ロールをインスタンスにアタッチした場合は、この行を変更する必要はありません。また、aws configure コマンドを使用して、エージェントの名前付きプロファイルを作成する必要もありません。

    それ以外の場合は、この行で、CloudWatch エージェントが使用する AWS 設定ファイル内の名前付きプロファイルを指定できます。これにより、CloudWatch エージェントはその名前付きプロファイルのリージョン設定を使用するようになります。

common-config.toml を変更した後、CloudWatch エージェントのリージョン情報の指定が必要になった場合は、AWS 設定ファイルで CloudWatch エージェントの名前付きプロファイルを作成します。このプロファイルを作成するときは、ルートまたは管理者ユーザーとして実行します。

次の例は、設定ファイルのプロファイルです。

[AmazonCloudWatchAgent] region=us-west-1

CloudWatch データを別のリージョンに送信できるようにするには、このインスタンスにアタッチした IAM ロールに、そのリージョンで CloudWatch データを書き込むアクセス権限があることを確認してください。

次の例では、aws configure コマンドを使用して CloudWatch エージェントの名前付きプロファイルを作成します。この例では、AmazonCloudWatchAgent のデフォルトプロファイル名を使用しているものとします。

CloudWatch エージェントの AmazonCloudWatchAgent プロファイルを作成するには

  • 以下のコマンドを入力してプロンプトに従います。

    aws configure --profile AmazonCloudWatchAgent

最初のインスタンスでエージェント設定ファイルを作成する

CloudWatch エージェントをダウンロードしたら、サーバーでエージェントを開始する前に設定ファイルを作成する必要があります。詳細については、「CloudWatch エージェント設定ファイルを作成する」を参照してください。

CloudWatch エージェントを開始する

エージェント設定ファイルを作成したサーバーでエージェントを開始するには、以下の手順を実行します。他のサーバーでこの設定ファイルを使用する場合は、「 エージェント設定を使用して追加インスタンスに CloudWatch エージェントをインストールする」を参照してください。

Run Command を使用して CloudWatch エージェントを開始する

Systems Manager Run Command を使用してエージェントを開始するには、以下の手順を実行します。

Run Command を使用して CloudWatch エージェントを開始するには

  1. Open the Systems Manager console at https://console.aws.amazon.com/systems-manager/.

  2. In the navigation pane, choose Run Command.

    -or-

    If the AWS Systems Manager home page opens, scroll down and choose Explore Run Command.

  3. [Run command] を選択します。

  4. [Command document] リストで、[AmazonCloudWatch-ManageAgent] を選択します。

  5. [Targets] 領域で、CloudWatch エージェントをインストールしたインスタンスを選択します。

  6. [Action] リストで、[configure] を選択します。

  7. [Optional Configuration Source] リストで、[ssm] を選択します。

  8. CloudWatch エージェント設定ファイルを作成する」で説明されているとおり、[Optional Configuration Location] ボックスで、作成して Systems Manager Parameter Store に保存したエージェント設定ファイルの名前を入力します。

  9. これらのステップを完了した後、[Optional Restart] リストで、[yes] を選択してエージェントを開始します。

  10. [Run] を選択します。

  11. 必要に応じて、[Targets and outputs] 領域で、インスタンス名の横のボタンを選択して [View output] を選択します。Systems Manager に、エージェントが正常に開始されたことが表示されます。

コマンドラインを使用して Amazon EC2 インスタンスで CloudWatch エージェントを開始する

コマンドラインを使用して CloudWatch エージェントを Amazon EC2 インスタンスにインストールするには、以下の手順を実行します。

コマンドラインを使用して CloudWatch エージェントを Amazon EC2 インスタンスに開始するには

  • Linux サーバーで、設定ファイルを Systems Manager Parameter Store に保存した場合は、次のコマンドを入力します。

    sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a fetch-config -m ec2 -c ssm:configuration-parameter-store-name -s

    Linux サーバーで、設定ファイルをローカルコンピューターに保存した場合は、次のコマンドを入力します。

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

    Windows Server を実行するサーバーで、設定ファイルを Systems Manager Parameter Store に保存した場合は、次のコマンドを入力します。

    amazon-cloudwatch-agent-ctl.ps1 -a fetch-config -m ec2 -c ssm:configuration-parameter-store-name -s

    Windows Server を実行するサーバーで、設定ファイルをローカルコンピューターに保存した場合は、次のコマンドを入力します。

    amazon-cloudwatch-agent-ctl.ps1 -a fetch-config -m ec2 -c file:configuration-file-path -s