＊らぁめん真(大阪府茨木市)

 

こんにちは！
株式会社ビヨンド大阪オフィスのラーメン王、ヒデです。
今回が4回目の投稿です。

この記事では、最近僕が案件でも実装した
CloudwatchアラームをTeams・Chatworkに通知することについて話します！
前回のブログ記事では、AWS認定資格 SAA(ソリューションアーキテクト)の勉強方法に関する記事も書いたので
興味ある方は、ぜひ見てくださいね

【受験者必見】AWS認定資格 SAA(ソリューションアーキテクト)の勉強方法を教えます！！

 

構成図

 

 

構成図は上記になります！
CloudWatchでEC2のメトリクスを取得して、アラームが発生すれば SNSに通知します
そして、SNSはCloudWatchから送られてきた様々な値をLambdaに送信します
Lambdaはその値を整形して各コミュニケーションツールに送信するという流れになります！
様々なAWSリソースを使うので難しく感じますが簡単に実装できるので一緒に頑張りましょう

 

構築手順

①Lambdaを作成

①-①Lambda>関数>関数の作成をクリック

 

 

①-②以下情報を指定して【関数の作成】をクリック

関数名：＊お好きな名前を指定してください
ランタイム：＊Python3系を指定してください

 

 

①-③コミュニケーションツール別にコードを貼り付ける

＊WebhookURLや認証トークンなどをコードに直接書きたくない場合は環境変数を設定してください

Teams用コード

#!/usr/bin/python3.8
import boto3
import json
  
from urllib.request import Request, urlopen

#WebhookURLを代入
HOOK_URL = "https://xxxxxxxxxxxxxxxx"
  
def lambda_handler(event, context): 
  
  #本番アラーム
  #message = json.loads(event['Records'][0]['Sns']['Message'])
  #subject = event['Records'][0]['Sns']['Subject']
   
  #アラームテスト
  message = {"AlarmName":"test-CPUUtilization","AWSAccountId":"xxxxxxxxxxx","NewStateValue":"ALARM","NewStateReason":"Threshold Crossed: 1 out of the last 1 datapoints [1.8083480560463125 (xx/xx/xx xx:xx:xx)] was less than or equal to the threshold (80.0) (minimum 1 datapoint for OK -> ALARM transition).","StateChangeTime":"xxxx-xx-xxTxx:xx:xx.xxx+xxxx","Region":"Asia Pacific (Tokyo)"}
  subject = "ALARM: test-CPUUtilization in Asia Pacific (Tokyo)"
  
  #アラーム情報
  alarm_name = message["AlarmName"]
  new_state = message["NewStateValue"]
  reason = message["NewStateReason"]
  alarm_time = message["StateChangeTime"]
  account_id = message["AWSAccountId"]
  region = message["Region"]
  alert_url = "https://ap-northeast-1.console.aws.amazon.com/cloudwatch/home?region=ap-northeast-1#alarmsV2:alarm/%s" %alarm_name
  
  alert_msg = {
    'title': "%s" %subject,
    'text': '<br>アラーム名: %s' %alarm_name +
    '<br> ステータス: %s' %new_state +
    '<br> アラーム理由: %s' %reason +
    '<br><br> アラーム発生時刻(UTC): %s' %alarm_time +
    '<br> アカウントID: %s' %account_id + 
    '<br> リージョン: %s' %region +
    '<br><br> アラームURL:<br> %s' %alert_url
  }

  #辞書型を文字列に変換してHTTPリクエストを生成
  req = Request(HOOK_URL, json.dumps(alert_msg).encode('utf-8'))

  #送信
  urlopen(req)

 

Chatwork用コード

#!/usr/bin/python3.8
import boto3
import json
import urllib
 
from urllib.request import Request, urlopen
 
#ルームIDを指定
room_id = 'xxxxxxxxxxx'

#トークンを指定
tokun = 'xxxxxxxxxxxxxxxxxxxxxxxxxxx'

chatwork_URL = "https://api.chatwork.com/v2/rooms/%s/messages" %room_id
 
def lambda_handler(event, context): 
 
  #本番アラーム
  #message = json.loads(event['Records'][0]['Sns']['Message'])
  #subject = event['Records'][0]['Sns']['Subject']
   
  #アラームテスト
  message = {"AlarmName":"test-CPUUtilization","AWSAccountId":"xxxxxxxxxxx","NewStateValue":"ALARM","NewStateReason":"Threshold Crossed: 1 out of the last 1 datapoints [1.8083480560463125 (xx/xx/xx xx:xx:xx)] was less than or equal to the threshold (80.0) (minimum 1 datapoint for OK -> ALARM transition).","StateChangeTime":"xxxx-xx-xxTxx:xx:xx.xxx+xxxx","Region":"Asia Pacific (Tokyo)"}
  subject = "ALARM: test-CPUUtilization in Asia Pacific (Tokyo)"
   
  #アラーム情報
  alarm_name = message["AlarmName"]
  new_state = message["NewStateValue"]
  reason = message["NewStateReason"]
  alarm_time = message["StateChangeTime"]
  account_id = message["AWSAccountId"]
  region = message["Region"]
  alert_url = "https://ap-northeast-1.console.aws.amazon.com/cloudwatch/home?region=ap-northeast-1#alarmsV2:alarm/%s" %alarm_name
 
  alert_msg = {
    'body': 
      '[info][title]%s[/title]'%subject+
      'アラーム名: %s'%alarm_name +'\n'+
      'ステータス: %s'%new_state +'\n'+
      'アラーム理由: %s'%reason +'\n'+
      'アラーム発生時刻(UTC): %s'%alarm_time +'\n'+
      'アカウントID: %s'%account_id +'\n'+
      'リージョン: %s'%region +'\n\n'+
      'アラームURL: %s'%alert_url +
      '[/info]'
  }
 
  headers = {
    'X-ChatWorkToken': '%s' %tokun
  }

  #クエリ文字列を生成
  data = urllib.parse.urlencode(alert_msg)
  
  #文字コードを変換
  data = data.encode('utf-8')

  #HTTPリクエストを生成
  req = Request(chatwork_URL, data,headers)

  #送信
  urlopen(req)

 

補足

・各コミュニケーションツールのメッセージ記法

Teams

https://docs.microsoft.com/ja-jp/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using?tabs=cURL

Chatwork

https://developer.chatwork.com/docs/message-notation

 

・参考記事

https://aws.amazon.com/jp/premiumsupport/knowledge-center/sns-lambda-webhooks-chime-slack-teams/

 

 

①-④【deploy】をクリック

 

 

①-⑤【Test】をクリック

 

 

①-⑥以下情報を指定して【保存】をクリック

イベント名：＊お好きな名前を指定してください
テンプレート-オプション：sns-notification

 

 

①-⑦【Test】をクリック

 

 

①-⑧テストアラームが通知されているか確認する

Teams

Chatwork

①-⑨本番アラーム通知用に変数を以下のように編集する

  #本番アラーム
  message = json.loads(event['Records'][0]['Sns']['Message'])
  subject = event['Records'][0]['Sns']['Subject']

  #アラームテスト
  #message = {"AlarmName":"test-CPUUtilization","AlarmDescription":"null","AWSAccountId":"xxxxxxxxxxx","AlarmConfigurationUpdatedTimestamp":"xxxx-xx-xxTxx:xx:xx.xxx+xxxx","NewStateValue":"ALARM","NewStateReason":"Threshold Crossed: 1 out of the last 1 datapoints [1.8083480560463125 (xx/xx/xx xx:xx:xx)] was less than or equal to the threshold (80.0) (minimum 1 datapoint for OK -> ALARM transition).","StateChangeTime":"xxxx-xx-xxTxx:xx:xx.xxx+xxxx","Region":"Asia Pacific (Tokyo)","AlarmArn":"arn:aws:cloudwatch:ap-northeast-1:xxxx:alarm:test-CPUUtilization","OldStateValue":"OK","OKActions":[],"AlarmActions":["arn:aws:sns:ap-northeast-1:xxxxxxxx:test"],"InsufficientDataActions":[],"Trigger":{"MetricName":"CPUUtilization","Namespace":"AWS/EC2","StatisticType":"Statistic","Statistic":"AVERAGE","Unit":"null","Dimensions":[{"value":"i-07876365e6af5774f","name":"InstanceId"}],"Period":300,"EvaluationPeriods":1,"DatapointsToAlarm":1,"ComparisonOperator":"LessThanOrEqualToThreshold","Threshold":80.0,"TreatMissingData":"missing","EvaluateLowSampleCountPercentile":""}}
  #subject = "ALARM: test-CPUUtilization in Asia Pacific (Tokyo)"

 

 

②SNS作成

②-①SNS>トピック>トピックの作成をクリック

 

 

②-②以下情報を指定して【トピックの作成】をクリック

タイプ：スタンダード
名前：好きな名前を記入してください

 

 

②-③【サブスクリプションの作成】をクリック

 

 

②-④以下情報を指定して【サブスクリプションの作成】をクリック

プロトコル：Lambda
エンドポイント：＊以下を参照してください

 

＊lambdaのARN情報場所

作成した関数>関数の概要の右端に関数のARNがあるのでそこからコピーしてください

 

 

②-⑤ステータスを確認

 

 

③CloudWatchを作成

＊EC2は作成している前提で進めてさせて頂きます。

③-①Cloudwatch>アラーム>【アラームの作成】をクリック

 

 

③-②お好みのメトリクスを選択

 

 

③-③アラーム条件を選択

＊アラームが発生するように設定してください

 

 

③-④通知設定

 

 

③-④アラーム名を指定する

 

 

③-⑤【アラームの作成】をクリック

 

 

④アラーム通知テスト

④-①アラーム状態になっているか確認する

 

 

④-②アラームが通知されているか確認する

Teams

 

ChatWork

 

 補足

・CloudWatchのアラーム情報をすべて確認したい場合
以下のように変数alert_msgの中身を編集すれば、参照することができます

Teams

  alert_msg ={
    "text":"%s" %message
  }

 

Chatwork

  alert_msg = {
    'body': '%s' %message
  }

 

出力結果

{"AlarmName":"test-CPUUtilization","AlarmDescription":"null","AWSAccountId":"xxxxxxxxxxx","AlarmConfigurationUpdatedTimestamp":"xxxx-xx-xxTxx:xx:xx.xxx+xxxx","NewStateValue":"ALARM","NewStateReason":"Threshold Crossed: 1 out of the last 1 datapoints [1.8083480560463125 (xx/xx/xx xx:xx:xx)] was less than or equal to the threshold (80.0) (minimum 1 datapoint for OK -> ALARM transition).","StateChangeTime":"xxxx-xx-xxTxx:xx:xx.xxx+xxxx","Region":"Asia Pacific (Tokyo)","AlarmArn":"arn:aws:cloudwatch:ap-northeast-1:xxxx:alarm:test-CPUUtilization","OldStateValue":"OK","OKActions":[],"AlarmActions":["arn:aws:sns:ap-northeast-1:xxxxxxxx:test"],"InsufficientDataActions":[],"Trigger":{"MetricName":"CPUUtilization","Namespace":"AWS/EC2","StatisticType":"Statistic","Statistic":"AVERAGE","Unit":"null","Dimensions":[{"value":"i-xxxxxxxxxxxxxx","name":"InstanceId"}],"Period":300,"EvaluationPeriods":1,"DatapointsToAlarm":1,"ComparisonOperator":"LessThanOrEqualToThreshold","Threshold":80.0,"TreatMissingData":"missing","EvaluateLowSampleCountPercentile":""}}

 

まとめ

お疲れ様でした！
今回はアラーム内容を各コミュニケーションツールに通知する方法をご紹介しました!

SlackはAWS Chatbotを活用すると簡単にアラームを通知できますが
Teames・Chatworkに送信する機能がCloudwatch・SNSにないため、
難しいですがアラームを通知する場合はこのようにします。

また、コードを編集すれば、処理に応じてメッセージを送信することもできます。
アラームを通知する際は、ぜひ活用してくださいね！