チュートリアル:IoT ハブでメトリックとログを設定して使用する

[アーティクル]
03/25/2023

Azure Monitor を使用して IoT ハブからメトリックとログを収集し、ソリューションの操作を監視するとともに、問題が発生したときにトラブルシューティングを行います。このチュートリアルでは、メトリックに基づいてグラフを作成する方法、メトリックに対してトリガーされるアラートを作成する方法、IoT Hub の操作とエラーを Azure Monitor ログに送信する方法、ログでエラーを確認する方法について説明します。

このチュートリアルでは、.NET でのテレメトリの送信に関するクイックスタートの Azure サンプルを使用して、IoT ハブにメッセージを送信します。デバイスまたは別のサンプルを使用していつでもメッセージを送信できますが、いくつかの手順を適宜変更することが必要な場合があります。

このチュートリアルを開始する前に、Azure Monitor の概念をある程度理解しておくと役立つものと思われます。詳細については、IoT Hub の監視に関する記事を参照してください。 IoT Hub によって出力されるメトリックとリソースログの詳細については、監視データのリファレンスに関する記事をご覧ください。

このチュートリアルでは、以下のタスクを実行します。

Azure CLI を使用して IoT ハブを作成し、シミュレートされたデバイスを登録して、Log Analytics ワークスペースを作成する。
IoT Hub の接続およびデバイステレメトリリソースログを、Log Analytics ワークスペース内の Azure Monitor ログに送信する。
メトリックスエクスプローラーを使用して、選択したメトリックに基づいてグラフを作成し、ダッシュボードにピン留めする。
重要性の高い状態が生じたときに電子メールで通知を受け取ることができるように、メトリックアラートを作成する。
IoT ハブにメッセージを送信する IoT デバイスをシミュレートするアプリをダウンロードして実行する。
特定の条件に合致したときにアラートを表示する。
メトリックのグラフをダッシュボード上に表示する。
Azure Monitor ログに IoT Hub のエラーと操作を表示する。

前提条件

Azure サブスクリプション。 Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。
開発用コンピューター上の .NET Core SDK 2.1 以降。複数のプラットフォームに対応する .NET Core SDK を .NET からダウンロードできます。

開発コンピューターに現在インストールされている C# のバージョンは、次のコマンドを使って確認できます。
```
dotnet --version
```
メールを受信できる電子メールアカウント。
ポート 8883 がファイアウォールで開放されていることを確認してください。このチュートリアルのデバイスサンプルでは、ポート 8883 を介して通信する MQTT プロトコルを使用しています。このポートは、企業や教育用のネットワーク環境によってはブロックされている場合があります。この問題の詳細と対処方法については、「IoT Hub への接続 (MQTT)」を参照してください。

Azure Cloud Shell で Bash 環境を使用します。詳細については、「Azure Cloud Shell の Bash のクイックスタート」を参照してください。
CLI リファレンスコマンドをローカルで実行する場合、Azure CLI をインストールします。 Windows または macOS で実行している場合は、Docker コンテナーで Azure CLI を実行することを検討してください。詳細については、「Docker コンテナーで Azure CLI を実行する方法」を参照してください。
- ローカルインストールを使用する場合は、az login コマンドを使用して Azure CLI にサインインします。認証プロセスを完了するには、ターミナルに表示される手順に従います。その他のサインインオプションについては、Azure CLI でのサインインに関するページを参照してください。
- 初回使用時にインストールを求められたら、Azure CLI 拡張機能をインストールします。拡張機能の詳細については、Azure CLI で拡張機能を使用する方法に関するページを参照してください。
- az version を実行し、インストールされているバージョンおよび依存ライブラリを検索します。最新バージョンにアップグレードするには、az upgrade を実行します。

リソースを設定する

このチュートリアルには、IoT ハブ、Log Analytics ワークスペース、シミュレートされた IoT デバイスが必要です。これらのリソースは、Azure portal、Azure CLI、または PowerShell を使用して作成できます。すべてのリソースに同じリソースグループと場所を使います。このチュートリアルを完了したら、リソースグループを削除することによって、すべてのものを一度に削除できます。

このチュートリアルでは、次の手順を実行する CLI スクリプトを提供しました。

リソースグループを作成します。
IoT Hub を作成します。
Log Analytics ワークスペースを作成します。
IoT ハブにメッセージを送信するシミュレートされたデバイスのデバイス ID を登録します。シミュレートされたデバイスの構成に使用するデバイス接続文字列を保存します。

Azure CLI を使用してリソースを設定する

次のコマンドをコピーして、Cloud Shell または Azure CLI がインストールされているローカルコマンドラインインスタンスに貼り付けます。一部のコマンドは、実行に時間がかかる場合があります。リソースグループ ContosoResources に新しいリソースが作成されます。

一部のリソースの名前は、Azure 全体で一意である必要があります。このスクリプトでは、$RANDOM 関数を使用してランダム値が生成され、変数に格納されます。これらのリソースでは、スクリプトによってこのランダム値がリソースのベース名に追加され、リソース名が一意になります。

グローバルに一意である必要のないリソース名の値を設定します。

location=westus
resourceGroup=ContosoResources
iotDeviceName=Contoso-Test-Device

一意である必要があるリソース名の値を設定します。これらの名前は、末尾に連結された乱数を持ちます。

randomValue=$RANDOM
iotHubName=ContosoTestHub$randomValue
echo "IoT hub name = " $iotHubName
workspaceName=contoso-la-workspace$randomValue
echo "Log Analytics workspace name = " $workspaceName

このチュートリアルのすべてのリソースに使用するリソースグループを作成します。

az group create --name $resourceGroup --location $location

無料レベルで IoT ハブを作成します。各サブスクリプションで使用できる無料 IoT ハブは 1 つのみです。空きハブが既にある場合は、値を --sku (basic) または B1 (standard) にS1変更します。

az iot hub create --name $iotHubName --resource-group $resourceGroup --partition-count 2 --sku F1 --location $location

Log Analytics ワークスペースの作成

az monitor log-analytics workspace create --resource-group $resourceGroup --workspace-name $workspaceName --location $location

テストに使用する IoT デバイス ID を作成します。

az iot hub device-identity create --device-id $iotDeviceName --hub-name $iotHubName

デバイス ID のプライマリ接続文字列を取得し、ローカルにコピーします。この接続文字列は、テストフェーズ中にデバイスシミュレーションを実行するために必要です。

az iot hub device-identity connection-string show --device-id $iotDeviceName --hub-name $iotHubName

接続とデバイステレメトリのログを収集する

IoT Hub は、複数のカテゴリの操作について、リソースログを出力します。これらのログを表示するには、診断設定を作成して同期先に送信する必要があります。そのような送信先の 1 つが、Log Analytics ワークスペースで収集される Azure Monitor ログです。 IoT Hub リソースログは、さまざまなカテゴリにグループ化されます。 Azure Monitor ログに送信するカテゴリを診断設定で選択できます。この記事では、接続とデバイステレメトリに関連する操作とエラーのログを収集します。 IoT Hub でサポートされているカテゴリの完全な一覧については、IoT Hub リソースログに関するセクションをご覧ください。

IoT Hub リソースログを Azure Monitor ログに送信するための診断設定を作成するには、次の手順に従います。

Azure Portal で、IoT ハブに移動します。 CLI コマンドを使用してリソースを作成した場合、IoT ハブはリソースグループ ContosoResources にあります。
ナビゲーションメニューの[監視] セクションの [診断設定] を選択します。次に [診断設定を追加する] を選択します。

[診断設定] ページで次の詳細を指定します。

パラメーター	値
診断設定の名前	設定に「接続とテレメトリをログに送信する」など、わかりやすい名前を付けます。
ログ	[カテゴリ] の一覧から [接続] と [デバイステレメトリ] を選択します。
宛先の詳細	[Log Analytics ワークスペースに送信] を選択し、Log Analytics ワークスペースピッカーを使用して、前にメ書き留めておいたワークスペースを選択します。

最終的な診断ログ設定を示すスクリーンショット

[保存] を選択して設定を保存します。 [診断設定] ペインを閉じます。診断設定の一覧に新しい設定が表示されます。

メトリックを設定する

次に、メトリックスエクスプローラーを使用して、追跡するメトリックを表示するグラフを作成します。Azure portal の既定のダッシュボードにこのグラフをピン留めします。

IoT ハブのメニューで、[監視] セクションから [メトリック] を選択します。
画面の上部にある [Last 24 hours (Automatic)](過去 24 時間 (自動)) を選択します。表示されるドロップダウンでは、 [時間の範囲] で [過去 4 時間] を選択し、 [時間の粒度] を [1 分] に設定します。また、 [時刻の表示形式] で [ローカル] を選択します。 [適用] を選択して、これらの設定を保存します。設定に、 [Local Time: Last 4 hours (1 minute)](ローカル時刻: 過去 4 時間 (1 分)) と表示されます。
グラフには、IoT ハブをスコープとする部分的なメトリック設定が表示されます。 [スコープ] と [メトリック名前空間] の値は既定値のままにしておきます。 [メトリック] 設定を選択して「Telemetry」と入力し、ドロップダウンから [Telemetry messages sent](送信済みテレメトリメッセージ) を選択します。 [集計] は、自動的に [合計] に設定されます。グラフのタイトルも変更されることに注意してください。

$グラフへの [Telemetry messages sent]$送信済みテレメトリメッセージ$ メトリックの追加を示すスクリーンショット。$
次に、 [メトリックの追加] を選択して、グラフに別のメトリックを追加します。 [メトリック] で、 [Total number of messages used](使用されているメッセージの合計数) を選択します。 [集計]で、[平均] を選択ます。グラフのタイトルがこのメトリックを含むように変更されたことがわかります。

これで画面には、最小化された [Telemetry messages sent](送信済みテレメトリメッセージ) のメトリックに加え、新しく [Total number of messages used](使用されているメッセージの合計数) のメトリックが表示されます。

$グラフへの [Total number of messages used]$使用されているメッセージの合計数$ メトリックの追加を示すスクリーンショット。$
グラフの右上にある [ダッシュボードに保存] を選択し、ドロップダウンリストから [ダッシュボードにピン留めする] を選択します。
[ダッシュボードにピン留め] ペインで、 [既存] タブを選択します。 [プライベート] を選択し、[ダッシュボード] ドロップダウンから [ダッシュボード] を選択します。最後に、 [ピン留め] を選択して、Azure portal の既定のダッシュボードにグラフをピン留めします。グラフをダッシュボードにピン留めしていない場合、メトリックスエクスプローラーを終了すると、設定は保持されません。

メトリックアラートを設定する

次に、「Telemetry messages sent (送信済みテレメトリメッセージ)」と「Total number of messages used (使用されているメッセージの合計数)」の 2 つのメトリックに対してトリガーするアラートを設定します。

「Telemetry messages sent (送信済みテレメトリメッセージ)」は、メッセージのスループットを追跡し、回避するための優れたメトリックです。 Free レベルの IoT ハブの場合、調整制限は 1 秒あたり 100 メッセージです。単一のデバイスでは、そのようなスループットを達成できないため、代わりに、5 分間でメッセージ数が 1,000 を超えた場合にトリガーするアラートを設定します。運用環境では、IoT ハブのレベル、エディション、ユニット数に基づいて、このシグナルをより大きな値に設定できます。

"Total number of messages used (使用されているメッセージの合計数) " では、使用されているメッセージの 1 日あたりの数を追跡します。このメトリックは、毎日 00:00 UTC にリセットされます。 1 日あたりのクォータが特定のしきい値を超えると、IoT ハブはメッセージを受け入れなくなります。 Free レベルの IoT ハブの場合、1 日あたりのメッセージクォータは 8,000 です。メッセージの合計数が 4000 (クォータの 50%) を超えた場合にトリガーするアラートを設定します。実際には、この割合をより大きな値に設定すると考えられます。 1 日あたりのクォータ値は、IoT ハブのレベル、エディション、ユニット数によって異なります。

IoT Hub のクォータと調整制限の詳細については、クォータと調整に関する記事をご覧ください。

メトリックアラートを設定するには、次の手順に従います。

IoT ハブメニューの [監視] セクションから [アラート] を選択します。
[アラートルールの作成] を選択します。

[アラートルールの作成] ペインには、次の 4 つのセクションがあります。
- スコープは IoT ハブに既に設定されているため、このセクションはそのままにしておきます。
- [条件] では、アラートをトリガーするシグナルと条件を設定します。
- [アクション] では、アラートがトリガーされたときの動作を構成します。
- [詳細] では、アラートの名前と説明を設定できます。

まず、アラートがトリガーされる条件を構成します。

[条件] タブが開き [シグナルの選択] ウィンドウが開きます。シグナル名の検索ボックスに「telemetry」と入力し、[送信されたテレメトリメッセージ] を選択します。

[シグナルロジックの構成] ペインで、 [アラートロジック] の次のフィールドを設定または確認します (グラフは無視してかまいません)。

パラメーター	値
しきい値	静的
[オペレーター]	より大きい
集計の種類	合計
しきい値	1000
単位	Count
集計の粒度 (期間)	5 分
評価の頻度	1 分ごと

アラートの条件設定を示すスクリーンショット。

これらの設定により、5 分間のメッセージの数を合計するようにシグナルが設定されます。この合計が 1 分ごとに評価され、前の 5 分間の合計が 1000 メッセージを超えると、アラートがトリガーされます。

[完了] を選択して、シグナルロジックを保存します。

[次へ: アクション] を選択してアラートのアクションを構成します。
1. [アクショングループの作成] を選択します。
2. [アクショングループの作成] ウィンドウの [基本] タブで、アクショングループの名前と表示名を指定します。
3. [通知] タブを選択します。 [通知の種類] で、ドロップダウンから [Email/SMS message/Push/Voice](メール/SMS メッセージ/プッシュ/音声) を選択します。 [Email/SMS message/Push/Voice](メール/SMS メッセージ/プッシュ/音声) ペインが開きます。
4. [Email/SMS message/Push/Voice](メール/SMS メッセージ/プッシュ/音声) ペインで、メールを選択し、メールアドレスを入力して、 [OK] を選択します。
5. [通知] ペインに戻り、通知の名前を入力します。
6. (オプション)アクショングループでは、[アクション] タブの [アクションの種類] ドロップダウンには、アラートでトリガーできるアクションの種類が一覧表示されます。この記事では通知のみを使用するため、このタブの設定は無視してかまいません。
7. [確認および作成] タブを選択し、設定を確認して、 [作成] を選択します。
8. アラートルールの [アクション] タブに戻り、新しいアクショングループがアラートのアクションに追加されていることを確認します。
[次へ: 詳細] を選択して、アラートルールの詳細を構成し、アラートルールを保存します。
1. [詳細] タブで、アラートの名前と説明を入力します。(例: 「5 分間に 1000 件を超えるメッセージがある場合に警告する」)
[確認と作成] を選択して、アラートルールの詳細を確認します。すべてが正しく表示される場合は、[作成] を選択して新しいルールを保存します。

次は、 [Total number of messages used](使用されているメッセージの合計数) 用に、もう 1 つアラートを設定します。このメトリックは、使用されているメッセージの数が IoT ハブの 1 日あたりのクォータ (IoT ハブがメッセージを拒否し始める時点) に近づきつつあるときにアラートを送信したい場合に役立ちます。次の違いを除き、前に行った手順に従います。

[シグナルロジックの構成] ペインのシグナルでは、[Total number of messages used](使用されているメッセージの合計数) を選びます。

[シグナルロジックの構成] ペインで、次のフィールドを設定または確認します (グラフは無視してかまいません)。

パラメーター	値
しきい値	静的
[オペレーター]	より大きい
集計の種類	合計
しきい値	4000
単位	Count
集計の粒度 (期間)	1 分
評価の頻度	1 分ごと

これらの設定により、メッセージ数が 4000 に達したときにシグナルを発するように設定されます。メトリックは 1 分ごとに評価されます。

警告ルールのアクションを指定するときは、前のルールに対して作成したものと同じアクショングループを選択します。
アラートの詳細では、前とは異なる名前と説明を使用します。

IoT ハブの左ペインの [監視] で、 [アラート] を選択します。次に、[アラート] ウィンドウの上部にあるメニューで、[アラートルール] を選択します。 [[アラートルール] ウィンドウが開きます。次の 2 つのアラートが表示されます。
[アラートルール] ウィンドウを閉じます。

これらの設定により、5 分以内に 1000 件を超えるメッセージが送信されたときと、使用されているメッセージの合計数が 4000 (Free レベルの IoT ハブの、1 日あたりのクォータの 50%) を超えたときに、アラートがトリガーされ、電子メール通知が送信されます。

シミュレーション済みデバイスアプリを実行する

「リソースを設定する」で、IoT デバイスの使用をシミュレートするために使用するデバイス ID を登録しました。このセクションでは、device-to-cloud メッセージを IoT ハブに送信するデバイスをシミュレートする .NET コンソールアプリをダウンロードし、これらのメッセージを IoT ハブに送信するようにアプリを構成して実行します。

重要

アラートが IoT Hub によって完全に構成され、有効になるまでに最大 10 分かかることがあります。最後のアラートを構成してから、シミュレートされたデバイスアプリを実行するまで、少なくとも 10 分お待ちください。

GitHub から Azure IoT C# SDK リポジトリのソリューションをダウンロードまたは複製します。このリポジトリには、いくつかのサンプルアプリケーションが含まれています。このチュートリアルでは、iothub/device/samples/getting started/SimulatedDevice/ を使用します。

ローカルターミナルウィンドウで、ソリューションのルートフォルダーに移動します。次に iothub\device\samples\getting started\SimulatedDeviceWithCommand フォルダーに移動します。
適当なテキストエディターで SimulatedDevice.cs ファイルを開きます。
1. s_connectionString 変数の値を、スクリプトを実行してリソースを設定したときに書き留めておいたデバイス接続文字列に置き換えます。
2. SendDeviceToCloudMessagesAsync メソッドで、Task.Delay を 1000 から 1 に変更します。これにより、メッセージの送信間隔が 1 秒から 0.001 秒に短縮されます。この待ち時間を短くすることで、送信されるメッセージの数が増えます。 (1 秒あたり 100 メッセージのメッセージレートは得られない可能性があります。)
```
await Task.Delay(1);
```
3. 変更を SimulatedDevice.cs に保存します。
ローカルターミナルウィンドウで次のコマンドを実行して、シミュレートされたデバイスアプリケーションに必要なパッケージをインストールします。
```
dotnet restore
```
ローカルターミナルウィンドウで次のコマンドを実行し、シミュレートされたデバイスアプリケーションをビルドして実行します。
```
dotnet run
```
次のスクリーンショットは、シミュレートされたデバイスアプリケーションが IoT Hub にテレメトリを送信したときの出力を示しています。

アプリケーションを少なくとも 10 から 15 分間実行します。メッセージの送信を停止するまで実行するのが理想的です (約 20 から 30 分)。これは、IoT ハブの 1 日あたりのメッセージクォータを超え、それ以上のメッセージの受け入れを停止したときに発生します。

Note

メッセージの送信を停止した後、デバイスアプリを長時間実行したままにすると、例外が発生する場合があります。この例外を無視し、アプリウィンドウを閉じてかまいません。

ダッシュボードにメトリックのグラフを表示する

Azure portal の左上隅にあるポータルメニューを開き、 [ダッシュボード] を選択します。
以前にピン留めしたグラフを見つけ、グラフデータの外側のタイル上の任意の場所をクリックして展開します。送信済みテレメトリメッセージと、使用されているメッセージの合計数がグラフに示されます。グラフの下部に最新の数値が表示されます。グラフ内でカーソルを移動して、特定の時間のメトリック値を確認できます。グラフの上部にある時間値と粒度を変更して、データを関心がある期間に絞り込んだり拡大したりすることもできます。

このシナリオでは、シミュレートされたデバイスのメッセージスループットは、IoT Hub によるメッセージ数の調整が発生するほど大きくありません。実際に調整を伴うシナリオでは、限られた期間、送信済みテレメトリメッセージが IoT ハブの調整制限を超える場合があります。これは、バーストトラフィックに対応するためです。詳細については、「トラフィックシェイプ」をご覧ください。

アラートを表示する

送信されたメッセージの数がアラートルールで設定した上限を超えると、電子メールアラートが届き始めます。

アクティブなアラートがあるかどうかを確認するには、IoT ハブの左ペインの [監視] で [アラート] を選択します。 [アラート] ペインには、指定した時間範囲に発生したアラートの数が重大度順に表示されます。

アラートの概要を示すスクリーンショット。

重大度 3 の行を選択します。 [すべてのアラート] ペインが開き、発生した重大度 3 のアラートが一覧表示されます。

[すべてのアラート] ペインを示すスクリーンショット。

アラートのいずれかを選択すると、そのアラートの詳細が表示されます。

アラートの詳細を示すスクリーンショット。

受信トレイで Microsoft Azure からの電子メールを確認します。件名にトリガーされたアラートが記載されています (例: Azure: Activated Severity:3 Alert if more than 1000 messages over 5 minutes)。本文は次の画像のようになります。

アラートが作動したことを示す電子メールのスクリーンショット

Azure Monitor ログを表示する

「接続とデバイステレメトリのログを収集する」で、接続とデバイステレメトリの操作について、IoT ハブによって出力されたリソースログを Azure Monitor ログに送信するための診断設定を作成しました。このセクションでは、Azure Monitor ログに対して Kusto クエリを実行して、発生したエラーを監視します。

Azure portal の IoT ハブの左ペインにある [監視] で [ログ] を選択します。最初の [クエリ] ウィンドウが開いた場合は閉じます。
[新しいクエリ] ペインで、 [クエリ] タブを選択し、 [IoT Hub] を展開して既定のクエリの一覧を表示します。
[エラーの概要] クエリを選択します。クエリエディターペインにクエリが表示されます。エディターペインで [実行] を選択し、クエリ結果を確認します。行のいずれかを展開すると、詳細が表示されます。

注意

エラーが表示されない場合は、 [Recently connected devices](最近接続されたデバイス) クエリを実行してみてください。これにより、シミュレートされたデバイスの行が返されます。

リソースをクリーンアップする

このチュートリアルで作成したリソースをすべて削除するには、リソースグループを削除します。これにより、そのグループ内に含まれているすべてのリソースも削除されます。ここでは、IoT ハブ、Log Analytics ワークスペース、およびリソースグループ自体が削除されます。メトリックのグラフをダッシュボードにピン留めしている場合は、それらを手動で削除する必要があります。各グラフの右上隅にある 3 つのドットをクリックし、 [削除] を選択します。グラフを削除したら、必ず変更を保存してください。

リソースグループを削除するには、az group delete コマンドを使います。

az group delete --name ContosoResources

次のステップ

このチュートリアルでは、次のタスクを実行することで、IoT Hub のメトリックとログの使用方法を学習しました。

Azure CLI を使用して IoT ハブを作成し、シミュレートされたデバイスを登録して、Log Analytics ワークスペースを作成する。
IoT Hub の接続およびデバイステレメトリリソースログを、Log Analytics ワークスペース内の Azure Monitor ログに送信する。
メトリックスエクスプローラーを使用して、選択したメトリックに基づいてグラフを作成し、ダッシュボードにピン留めする。
重要性の高い状態が生じたときに電子メールで通知を受け取ることができるように、メトリックアラートを作成する。
IoT ハブにメッセージを送信する IoT デバイスをシミュレートするアプリをダウンロードして実行する。
特定の条件に合致したときにアラートを表示する。
メトリックのグラフをダッシュボード上に表示する。
Azure Monitor ログに IoT Hub のエラーと操作を表示する。

次のチュートリアルにでは、IoT Hub の障害復旧機能をテストする方法について説明します。

IoT ハブの手動フェールオーバーを実行する