CloudWatch Agent を CLI で EC2 に導入

先日 CloudWatch Agent が発表されました。

新発表 – Amazon CloudWatch AgentとAWS Systems Managerとの連携 – 統一されたメトリクスとログの収集をLinuxとWindowsに | Amazon WebServices ブログ

SSM Agent 導入が前提、となるとマネジメントコンソールすら使う必要が無いだろうということで、AWS CLI (aws ssm) での導入方法です。

公式導入手順
- Collect Metrics from Amazon EC2 Instances and On-Premises Servers with the CloudWatch Agent – Amazon CloudWatch
- Metrics Collected by the CloudWatch Agent

SSM Agent

CloudWatch Agent を使うには、SSM Agent がインストールされていることが前提条件になります。

SSM Agent 導入状況確認

query はお好みで。

$ aws ssm describe-instance-information \
  --query 'sort_by(InstanceInformationList[].{
    InstanceId:InstanceId, ComputerName:ComputerName, ResourceType:ResourceType, PingStatus:PingStatus,
    AgentVersion:AgentVersion, IsLatestVersion:IsLatestVersion
    PlatformType:PlatformType, PlatformName:join(`:`, [ PlatformName, PlatformVersion ])
  },&PlatformName)' \
  --output table
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|                                                                              DescribeInstanceInformation                                                                              |
+--------------+---------------------------------------------------+----------------------+------------------+-------------+---------------------------+---------------+----------------+
| AgentVersion |                   ComputerName                    |     InstanceId       | IsLatestVersion  | PingStatus  |       PlatformName        | PlatformType  | ResourceType   |
+--------------+---------------------------------------------------+----------------------+------------------+-------------+---------------------------+---------------+----------------+
|  2.2.120.0   |  ip-xxx-xx-x-xx.ap-northeast-1.compute.internal   |  i-xxxxxxxxxxxx8632f |  False           |  Online     |  Amazon Linux AMI:2017.09 |  Linux        |  EC2Instance   |
|  2.2.103.0   |  ip-xxx-xx-x-xx                                   |  i-xxxxxxxxxxxx2c23b |  True            |  Online     |  Amazon Linux:2.0         |  Linux        |  EC2Instance   |
・・・

IsLatestVersion ですが、 Amazon Linux 2017.09 版で確認した所 False が返ってきました。
最新版は 2.2.103.0 のはずですが、なぜか 2.2.120.0 が導入されており、マニュフェストに存在しないバージョンのため False となっていたようです。

現時点での最新 Version は “2.2.103.0”

# https://s3.ap-northeast-1.amazonaws.com/amazon-ssm-ap-northeast-1/ssm-agent-manifest.json
{"Name":"amazon-ssm-agent-linux-amd64.tar.gz","Version":"2.2.103.0"}

SSM Agent インストール

未導入の場合はインストールする必要があります。 SSM Agent が居ないことには AWS Systems Manager から実行できないため、EC2インスタンス起動時なり、sshログインなりでインストールを行います。

SSM エージェントをインストールし設定する – Amazon EC2 Systems Manager

SSM Agent アップデート

On an Amazon EC2 instance, the CloudWatch agent requires that the instance is running version 2.2.93.0 or later.

バージョン 2.2.93.0 以上が必要なため、SSM Agent が古い場合は AWS-UpdateSSMAgent を使用してアップデートを行います。

$ _DOCNAME="AWS-UpdateSSMAgent"
$ _INSTANCEs="i-xxxxxxxxxxxx2c23b,i-xxxxxxxxxxxx8632f"

$ aws ssm send-command \
  --document-name "${_DOCNAME}" \
  --targets "Key=instanceids,Values=${_INSTANCEs}"

send-command の結果確認

list-command-invocations で実行結果一覧が取得できます。

一覧取得例

$ aws ssm list-command-invocations \
  --query 'sort_by(CommandInvocations[].{
    DocumentName:DocumentName, CommandId:CommandId, InstanceId:InstanceId, InstanceName:InstanceName, Status:Status, StatusDetails:StatusDetails, RequestedDateTime:RequestedDateTime
  }, &RequestedDateTime)' \
  --output table

-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|                                                                                      ListCommandInvocations                                                                                       |
+--------------------------------------+-------------------------------+----------------------+---------------------------------------------------+--------------------+----------+-----------------+
|               CommandId              |         DocumentName          |     InstanceId       |                   InstanceName                    | RequestedDateTime  | Status   |  StatusDetails  |
+--------------------------------------+-------------------------------+----------------------+---------------------------------------------------+--------------------+----------+-----------------+
|  XXXXXXXX-ab3e-4aaa-bb72-xxxxxxxxxxxx|  AWS-UpdateSSMAgent           |  i-xxxxxxxxxxxx2c23b |  ip-xxx-xx-x-xx                                   |  1513519181.61     |  Success |  Success        |
|  XXXXXXXX-83d4-4628-a01e-xxxxxxxxxxxx|  AWS-ConfigureAWSPackage      |  i-xxxxxxxxxxxx2c23b |  ip-xxx-xx-x-xx                                   |  1513523228.34     |  Failed  |  Failed         |

get-command-invocation で実行結果詳細が取得できます。 StandardOutputContent と StandardErrorContent が出力結果となります。

詳細取得例
- command-id、instance-id を指定

$ _CMDID=XXXXXXXX-ab3e-4aaa-bb72-xxxxxxxxxxxx
$ _INSTANCE=i-xxxxxxxxxxxx2c23b

# jq有
$ aws ssm get-command-invocation \
  --command-id ${_CMDID} \
  --instance-id ${_INSTANCE} \
  | jq -r '.StandardOutputContent, .StandardErrorContent'

Updating amazon-ssm-agent from 2.2.120.0 to latest
Successfully downloaded https://s3.ap-northeast-1.amazonaws.com/amazon-ssm-ap-northeast-1/ssm-agent-manifest.json
updating amazon-ssm-agent to an older version, please enable allow downgrade to proceed

# jq無
$ aws ssm get-command-invocation \
  --command-id ${_CMDID} \
  --instance-id ${_INSTANCE} \
  --query '[ StandardOutputContent, StandardErrorContent ]' \
  | awk '{gsub(/\\n/,"\n"); print}'