前提情報
この記事は Microsoft Azure Tech Advent Calendar 2018 の14日目の記事です。
今回 Azure Monitor アラートの アクション グループ について記事を書こうと思っております。
その前提情報として Azure Monitor について少しご説明させていただければと存じます。
そもそも Azure Monitor では、リソースの メトリック や アクティビティ ログ などのデータを収集しております。Monitor のデータストアに収集されたデータは、アラート を利用して監視することが可能となります。アラート 条件に一致した場合に、電子メールや webhook など アクション グループ で指定した内容に基づいて通知ができるのですが、今回 Monitor アラート の アクション グループ について説明していきたいと思います。
Monitor アクション グループとは
アクション グループとは、どの宛先の電子メールに送信するか、どの function を呼び出す、などの通知方法を定義したものとなります。
Monitor アラートを作成するときに必ず 1 つ以上、紐づけする必要となり、アクション グループで設定可能な通知方法は以下の通りとなります。
アクション グループ詳細については、こちら に記載がございますので、ご参照ください。
また、それぞれの課金については、Azure Monitor の価格 の資料の "通知" の項目をご確認ください。
- 電子メール
- SMS
- Azure アプリのプッシュ通知 ※ Service Health アラート でのみサポートされます
- 音声
- Azure Function
- Logic Apps
- Webhook
- ITSM
- Automation Runbook
Azure ポータル上での設定方法
今回は、例として、自分宛ての電子メールに通知を行うアクション グループを作成していきたいと思います。
<手順>
-
左側のリスト一覧に [モニター] が表示されていれば、[モニター] をクリックします。表示されていない場合は、[すべてのサービス] をクリックして「モニター」で検索して [モニター] をクリックします。
-
アクション グループ名、短い名前、リソース グループを指定します。
補足(クリックすると展開します)
(アクション グループの)短い名前は、通知の発信元であるアクション グループを識別するために電子メール通知と SMS 通知に含まれます。ユーザーが登録を解除すると、その短い名前で識別される特定のアクション グループから登録を解除することになります。 -
プルダウンからアクション タイプを選択して、その名前(アクション名)と電子メールにチェックを入れて対象のアドレスを指定します。そして OK をクリックしてアクションを追加します。なお、他の宛先の電子メールにも送信したい場合は、再度このステップ 5 の手順でアクションを追加する必要があります。電子メールのアクションは 1 つのアクショングループに最大 1000 個登録できます。
-
アクション グループの追加ブレードの OK をクリックして アクション グループを作成します。Azure ポータル上の左上に以下のようなポップアップが表示されたら作成完了です。
Azure PowerShell を利用して電子メール 100 個を一括で登録する
上述したとおり、一つのアクション グループに最大 1000 個の電子メールを紐づけることが可能となりますが、Azure ポータル上から手動で登録するとなかなか面倒な作業です。
今回は Excel ファイルを読み込んで、よしなにアクション グループを作成する PowerShell スクリプトをご紹介します。ご参考になれば幸いです。
<手順>
-
まず、アクション名と電子メールを記載した以下のような Excel ファイルを用意します。こちらをローカルの適当なパスに保存します。
-
PowerShell を開き、以下のスクリプトの内容を適宜置換して実行します。
## まずログイン
Connect-AzureRmAccount
# Excel ファイル読み込み
$excel = new-Object -com excel.application;
$excel.visible = $false
$book = $excel.Workbooks.open("C:\Users\mekamata\Desktop\main\powershell\email-list.xlsx");
# Excel シート 1 読み込み
$sheet = $book.Worksheets.Item(1);
# 名前(Excel に名前を記載したセルの範囲を指定します)
$aryNames = @($sheet.Range("A2:A101")).text
# 電子メール(Excel に電子メールを記載したセルの範囲を指定します)
$aryEmails = @($sheet.Range("B2:B101")).text
# Excel のプロセス終了
$book.close();
$excel.quit();
# 電子メールのアクションを追加
$emailReceiver = @()
for($i = 0; $i -lt $aryNames.Count; $i++){
$emailReceiver += New-AzureRmActionGroupReceiver -Name $aryNames[$i] -EmailReceiver -EmailAddress $aryEmails[$i]
}
# アクショングループ名
$actionGroupName = "actiongroup-1214"
# アクショングループの短い名前
$actionGroupNameShort = "agp"
# リソース グループ名
$resourceGroup = "Default-ActivityLogAlerts"
# アクショングループ作成
$action = Set-AzureRmActionGroup -ResourceGroupName $resourceGroup -Name $actionGroupName -ShortName $actionGroupNameShort -Receiver $emailReceiver
なお、Azure PowerShell がインストールされていない場合は、下記ドキュメントを参考にインストールください。
参考:PowerShellGet を使用した Windows への Azure PowerShell のインストール
https://docs.microsoft.com/ja-jp/powershell/azure/install-azurerm-ps?view=azurermps-6.13.0
また、上記スクリプトにて利用した Azure PowerShell コマンドレットについても公式資料がございますので、併せてご案内いたします。
参考:New-AzureRmActionGroupReceiver
https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/new-azurermactiongroupreceiver?view=azurermps-6.13.0
参考:Set-AzureRmActionGroup
https://docs.microsoft.com/en-us/powershell/module/azurerm.insights/set-azurermactiongroup?view=azurermps-6.13.0
実行後に Azure ポータル上で確認したところ以下のように正常に追加できました!
[補足] Logic Apps や Azure Function など、実装次第で様々な方法で通知可能
お問い合わせ対応をしていると、一般的にアラートが発報されたときにメールで通知する方が多い印象を受けます。一方で、上述した通り、アクション グループでは Logic Apps や Azure Function などアクションとして追加することができます。このため発報されたアラートの内容を Logic Apps 経由で slack や teams に通知したりなど実装次第で様々な方法で通知可能なため、ご入り用に応じて検討してみてください。
参考:AzureのアラートをSlackに通知する方法
https://tech-lab.sios.jp/archives/3788
参考:Azure Logic App で Azure メトリックアラートを Slack に投稿する
https://qiita.com/sgr@github/items/b79405f952b8de8987a4
参考:How to trigger complex actions with Azure Monitor alerts
https://docs.microsoft.com/ja-jp/azure/azure-monitor/platform/action-groups-logic-app
まとめ
今回は、Azure Monitor のアクション グループについての概要、Azure ポータルおよび PowerShell での設定方法をご案内いたしました。アクショングループに限った話ではないのですが、どんなものかイメージを掴むには、Azure ポータルを利用みるのが直感的に分かりやすいのですが、ポチポチ作業がメンドクサイ方は、Azure PowerShell(※) などコマンドラインで操作すると効率化できるので、状況に応じてポータルや PowerShell など使い分けていただければと存じます。
※今回は Azure PowerShell をご紹介しましたが、Azure CLI や REST API なども利用可能です。