CloudWatchカスタムメトリクスに任意の値を登録してグラフで監視する

概要

CoudWatchカスタムメトリクスって知ってますか？
通常のCloudWatchメトリクスは使ったことがある人が多いと思いますがカスタムメトリクスはそうでもないかもしれません
通常のメトリクスがAWSが用意したリソースしか監視できないのに対し、CloudWatchカスタムメトリクスは何でも監視してグラフ化出来る優れものです

どうやって監視するか

監視といってもカスタムメトリクスは変動する値を継続的に読み込んでくれるわけではありません
CLIやSDK等を使って監視したい値をその都度メトリクスに送信してグラフを作成するわけです
今回はAWSCLIを使用する方法とLambdaを使用する方法を紹介します

AWSCLIを使う

まずCLIを使える環境を用意しましょう
私はローカルに導入するのが面倒だったのでEC2インスタンスを立てました

アクセスキーの作成

認証情報にアクセスキーが必要なので作成しておきましょう
IAMコンソール→ユーザー→認証情報→アクセスキーの作成ボタンをクリックです

IDが二つ表示されますのでメモしといてください

CLIのセットアップ

SSHで接続したらaws configureコマンドで簡単に設定しちゃいましょう

$ aws configure
AWS Access Key ID [None]: さっきメモしたやつ
AWS Secret Access Key [None]: さっきメモしたやつ
Default region name [None]: ap-northeast-1
Default output format [None]: json

これでawsコマンドがちゃんと使えるようになりました

カスタムメトリクスを登録する

AWSCLIのセットアップが終わったところで早速カスタムメトリクスを登録してみましょう
次のコマンドを叩いてください
$ aws cloudwatch put-metric-data --namespace CustomMetrics --metric-name Test --dimensions CLI=RandomNum --value 100
なんだかオプションがたくさん並んでいますが実は簡単です
namespace,metric-name,dementionsは全て識別子なので好きな名前を付けちゃってください
大事なのはvalueだけです。これが実際にメトリクスに登録される値です
今回は100という数値を登録しました
早速メトリクスを見てみましょう

しっかり送信されていますね
見にくいですが青い点が今登録した値です
しかしこんな点を登録したところで何の役にも立たないのでグラフにしていきましょう

#!/bin/bash
while true
do
NUM=$(($RANDOM % 100))
aws cloudwatch put-metric-data --namespace CustomMetrics --metric-name Test --dimensions CLI=RandomNum --value $NUM
sleep 60
done &

今回は0~100のランダム数値を送信する簡単なスクリプトを書きました
これをEC2上で実行してみましょう

いい感じのグラフが出来ましたね

Lambdaを使う

Lambdaを使った登録も可能です
大体の流れは一緒ですがLambdaではランタイム毎に用意されたSDKを使うことになります
今回はNode.jsで実装してみましょう

IAMロールの作成

CloudWatchにアクセスするロールをLambdaにアタッチする必要があります
ユースケースからLambdaを選んでCloudWatchFullAccessを含んだロールを作成します

Lambda関数の作成

ロールを作成したらLambda関数を作成します
先程作成したロールを作成時にアタッチしましょう

サンプルコード

const AWS = require('aws-sdk');

exports.handler = (event, context, callback) => {
  const rundom_num = Math.floor(Math.random() * (100))
  const params = {
    MetricData: [ 
      {
        MetricName: 'Test', 
        Dimensions: [
          {
            Name: 'Lambda', 
            Value: 'Random_num' 
          }
        ],
        Timestamp: new Date,
        Unit: 'Count',
        Value: rundom_num,
      }
    ],
    Namespace: 'CustomMetrics' 
  };
  
  const cloudwatch = new AWS.CloudWatch({ region: 'ap-northeast-1' });
  cloudwatch.putMetricData(params, function (err, data) {
    if (err) console.log(err, err.stack);
    else console.log(data);
  });
}

今回も0~100のランダム数値を登録します
Lambda関数ではオプションをMetricDataに記述してputMetricDataで送信します
CLIで登録した時と同じようなオプションが並んでいるので難しくないですね

Timestampはメトリクスに登録される時刻です
基本的には現在時刻を登録することになると思いますがそれ以外も指定することが可能です
unitは登録する値の単位です
以下の中から選択できますが今回はCountを選択しました

"Seconds"
"Microseconds"
"Milliseconds"
"Bytes"
"Kilobytes"
"Megabytes"
"Gigabytes"
"Terabytes"
"Bits"
"Kilobits"
"Megabits"
"Gigabits"
"Terabits"
"Percent"
"Count"
"Bytes/Second"
"Kilobytes/Second"
"Megabytes/Second"
"Gigabytes/Second"
"Terabytes/Second"
"Bits/Second"
"Kilobits/Second"
"Megabits/Second"
"Gigabits/Second"
"Terabits/Second"
"Count/Second"
"None"

任意の値を登録、監視するにはこれで十分ですが他のパラメータも用意されています
今回使用しなかったパラメータの詳細は公式ドキュメントを参照してください
さて、実際にコードを走らせてみましょう

ちゃんと登録されていますね

関数を定期実行させる

Lambdaの場合シェルスクリプトみたいにWhileで定期実行させられないのでEventBridgeの機能を使っていきます
設定から「トリガーを追加」ボタンをクリックです


トリガーにEventBridgeを選択してルールを決めます
今回は一分毎に実行させるrate(1 minute)を設定しました
ここら辺を詳しく知りたい方はEventBridgeの公式ドキュメントを読んでください
最後にメトリクスを見に行きましょう

ちゃんとグラフになっていますね

さいごに

今回はただの乱数を使用しましたがValueさえ変えてしまえば様々なことに応用できます
みなさん独自のオレオレメトリクスを作って自慢してやりましょう