CloudWatchのメトリクスをコマンドで取得する

記事タイトルとURLをコピーする

技術4課の鎌田(裕)です。 CloudWatchのメトリクス、マネジメントコンソールで確認される方は多いと思いますが、メトリクスをコマンドラインで取得したいケースもあると思います。 色々な都合でAWS CLIとPowerShellの両方を比較しながら取得したかったのですが、意外と同じデータを取れる情報が並べて書かれている記事がなかったので、こちらのブログでは、AWS CLIとAWS Tools for PowerShellの両方の方法を記載します。

必要なパラメータ

CloudWatchの概念(https://docs.aws.amazon.com/ja_jp/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html)でも 解説されている、各種パラメタを指定します。指定するパラメタは以下の通りです。

AWS CLI PowerShell 説明
namespace Namespace メトリクスを取得するAWSのサービスを指定します。EC2であればAWS/EC2を指定します。
metric-name MetricName 取得したいメトリクスの指定をします。CPU使用率であればCPUUtilizationを指定します。
statistics Statistic メトリクスの平均値/最大値/最小値など、いずれの情報を取得したいのか指定をします。最大値であればMaximumです。
period Period メトリクスを取得する間隔を秒で指定します。5分間隔であれば300を指定します。
start-time UtcStartTime メトリクスを表示したい日時の先頭となる日時を指定します。
end-time UtcEndTime メトリクスを表示したい日時の最後となる日時を指定します。
dimensions Dimension メトリクスを一意に識別する名前/値のペアを指定します。

AWS CLIで取得してみる

実際にコマンドで取得してみましょう。 以下のコマンドでは、EC2のCPU使用率の最大値を、指定した日時の期間、5分間隔で出力する例です。


aws cloudwatch get-metric-statistics --namespace AWS/WorkSpaces --metric-name UserConnected --statistics Maximum --period 300 --start-time 2019-02-26T23:00:00Z --end-time 2019-02-27T00:00:00Z --dimensions "Name=WorkspaceId,Value=ws-xxxxxxxx"

結果はjsonで返されます。

PowerShellで取得してみる

基本はAWS CLIと同じですが、PowerShellで取得する場合、Dimensionは一度オブジェクトを生成する必要があります。 EC2と同じように取得すると、下記のようになります。


$dimension = New-Object Amazon.CloudWatch.Model.Dimension
$dimension.set_Name("WorkspaceId")
$dimension.set_Value("ws-xxxxxxxx")
$date1 = ([Datetime]"2019/2/27 8:00:00").ToUniversalTime()
$date2 = ([Datetime]"2019/2/27 9:00:00").ToUniversalTime()
Get-CWMetricStatistics -Region ap-northeast-1 -Namespace AWS/WorkSpaces -MetricName UserConnected -UtcEndTime $date2 -UtcStartTime $date1 -Statistic Maximum -Period 600 -Dimension $dimension

結果はDatapointsというオブジェクトで返されます。Datapointsの中は配列になっています。 Get-CWMetricStatisticsの結果を$dataという変数に入れたあと、Datapointsの0番目のデータを見てみると、次のような値が取得できます。

日付の指定について

上記のコマンド実行例では、AWS CLIでは、UTCの時間を計算して指定しています。 一方、PowerShellでは日本時間で記載の上、PowerShellで変換をかけた上でコマンドの引数に使っています。 PowerShellの方が、日付の指定は直間的で分かり易いかも知れません。

終わりに

CloudWatchのメトリクスをコマンドで取得することで、運用などでもご活用いただけると思います。 なかなかAWS CLIとPowerShellで同じ実行例が並んでいなかったためこのブログ記事を書きました。 ご参考になれば幸いです。