Azure IoT Hub 監視データ リファレンス

この記事には、このサービスに関するすべての監視リファレンス情報が含まれています。

IoT Hub 用に収集できるデータとその使用方法の詳細については、 Monitor Azure IoT を参照してください。

メトリック

このセクションには、このサービスに関して自動的に収集されるすべてのプラットフォーム メトリックが一覧表示されています。 これらのメトリックは、Azure Monitor でサポートされているすべてのプラットフォーム メトリックのグローバル リストにも含まれています。

メトリックのリテンション期間の詳細については、「Azure Monitor メトリックの概要」を参照してください。

Microsoft.Devices/IoTHubs でサポートされているメトリック

次の表に、Microsoft.Devices/IoTHubs リソースの種類で使用できるメトリックを示します。

• すべての列がすべてのテーブルに存在するわけではない場合があります。
• 一部の列がページの表示領域を超えている場合があります。 [テーブルの展開] を選択すると、使用可能なすべての列が表示されます。

テーブルの見出し

• カテゴリ - メトリック グループまたは分類。
• メトリック - Azure Portal に表示されるメトリックの表示名。
• REST API の名前 - REST API で参照されるメトリック名。
• 単位 - 測定単位。
• 集計 - 既定の集計の種類。 有効な値: 平均 (Avg)、最小 (Min)、最大 (Max)、合計 (Sum)、数。
• ディメンション - メトリックで使用できるディメンション。
• 時間グレイン - メトリックをサンプリングする間隔。 たとえば、PT1M は、メトリックを 1 分ごとに、PT30Mは 30 分ごとに、PT1H は 1 時間ごとにサンプリングすることを示します。
• DS エクスポート - メトリックが診断設定を介して Azure Monitor ログにエクスポート可能かどうかを示します。 メトリックのエクスポートについては、「Azure Monitor で診断設定を作成する」を参照してください。

サポートされる集計

テーブルの Aggregation Type 列は、メトリックがグラフまたはアラートに対して選択されたときに使用される既定の集計に対応します。

ほとんどのメトリックでは、すべての集計の種類が有効です。 Unit 列の値が Count のカウント メトリックの場合、一部の集計のみが有効です。 カウント メトリックには、次の 2 種類があります。

• シングルポイント カウント メトリックの場合、測定されている操作が発生するたびに、IoT Hub により 1 つのデータ ポイント (基本的に 1) が登録されます。 次に、Azure Monitor によって、指定された粒度でこれらのデータ ポイントが合計されます。 シングルポイント メトリックの例としては、"送信済みテレメトリ メッセージ" や "C2D メッセージ配信完了" があります。 これらのメトリックでは、関連する集計の種類は合計 (Sum) のみです。 ポータルでは、最小値、最大値、平均を選択できます。 これらの値は常に 1 です。

• スナップショット カウント メトリックの場合、測定されている操作が発生すると、IoT Hub によって合計数が登録されます。 現時点では、IoT Hub によって出力されるスナップショット メトリックとしては、"使用されているメッセージの合計数"、"デバイスの合計数"、"接続されているデバイス" の 3 つがあります。 これらのメトリックは毎回 "合計" 数量を提示するため、指定された粒度で合計しても意味がありません。 Azure Monitor では、これらのメトリックに対する集計の種類として Minimum、Maximum、Average を選択するように制限されています。

メトリック ディメンション

メトリック ディメンションについては、「多次元メトリック」を参照してください。

このサービスでは、次のディメンションがそのメトリックに関連付けられています。

メトリックの表示名と集計

次の表は、前の表で説明したメトリックの詳細を示しています。 一般的なカテゴリ別に IoT Hub プラットフォーム メトリックが表示され、Azure portal で割り当てられた表示名でメトリックが一覧表示されます。

クラウドからデバイスへのコマンド メトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

クラウドからデバイスへのダイレクト メソッドのメトリック:

[ユニット] 値が Count のメトリックでは、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

クラウドからデバイスへのツイン操作のメトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

構成メトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

日単位のクォータ メトリック:

"使用されているメッセージの合計数" では、Minimum、Maximum、Average の集計のみがサポートされています。 詳細については、「サポートされる集計」を参照してください。

デバイス メトリック:

"デバイスの総数 (非推奨) " と "接続されているデバイス (非推奨) " では、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

"デバイスの合計数" と "接続されているデバイス" では、Minimum、Maximum、Average の集計のみが有効です。 詳細については、「サポートされる集計」を参照してください。

合計デバイスおよび接続されているデバイスは、診断設定を使用してエクスポートできません。

デバイス テレメトリ メトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

デバイスからクラウドへのツイン操作のメトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

Event Grid メトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

ジョブのメトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

ルーティング メトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

ツイン クエリ メトリック:

[ユニット] 値が Count のメトリックの場合、合計 (Sum) の集計のみが有効です。 Minimum、Maximum、Average の集計では、常に 1 が返されます。 詳細については、「サポートされる集計」を参照してください。

リソース ログ

このセクションでは、このサービス用に収集できるリソース ログの種類を一覧表示します。 このセクションでは、Azure Monitor でサポートされているすべてのリソース ログ カテゴリの種類のリストからプルされます。

Microsoft.Devices/IotHubs でサポートされているリソース ログ

次のセクションでは、Azure IoT Hub 用に収集されたリソース ログ カテゴリの種類とスキーマの一覧を示します。 イベントは一部のカテゴリのエラーに対してのみ生成されます。

Cloud-to-device コマンド カテゴリ

C2D コマンド カテゴリでは、IoT Hub で発生し、かつクラウドからデバイスへのメッセージ パイプラインに関連しているエラーを追跡します。 このカテゴリには、以下から発生するエラーが含まれます。

• 送信 cloud-to-device メッセージ (承認されていない送信者のエラーなど)、
• 受信 cloud-to-device メッセージ (配信数超過のエラーなど)、および
• 受信 cloud-to-device メッセージのフィードバック (フィードバックの有効期限切れのエラーなど)。

このカテゴリでは、cloud-to-device メッセージが正常に配信されたときのエラーはキャッチされませんが、デバイスによって不適切に処理されたときのエラーはキャッチされます。

{
    "records":
    [
        {
            "time": " UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "messageExpired",
            "category": "C2DCommands",
            "level": "Error",
            "resultType": "Event status",
            "resultDescription": "MessageDescription",
            "properties": "{\"deviceId\":\"<deviceId>\",\"messageId\":\"<messageId>\",\"messageSizeInBytes\":\"<messageSize>\",\"protocol\":\"Amqp\",\"deliveryAcknowledgement\":\"<None, NegativeOnly, PositiveOnly, Full>\",\"deliveryCount\":\"0\",\"expiryTime\":\"<timestamp>\",\"timeInSystem\":\"<timeInSystem>\",\"ttl\":<ttl>, \"EventProcessedUtcTime\":\"<UTC timestamp>\",\"EventEnqueuedUtcTime\":\"<UTC timestamp>\", \"maskedIpAddress\": \"<maskedIpAddress>\", \"statusCode\": \"4XX\"}",
            "location": "Resource location"
        }
    ]
}

クラウドからデバイスへのツイン操作カテゴリ

クラウドからデバイスへのツイン操作カテゴリでは、デバイス ツイン上のサービスによって開始されたイベントを追跡します。 これらの操作には、ツインの取得、タグの更新または置換、および必要なプロパティの更新または置換が含まれます。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "read",
            "category": "C2DTwinOperations",
            "level": "Information",
            "durationMs": "1",
            "properties": "{\"deviceId\":\"<deviceId>\",\"sdkVersion\":\"<sdkVersion>\",\"messageSize\":\"<messageSize>\"}",
            "location": "Resource location"
        }
    ]
}

デバイスからクラウドへのツイン操作カテゴリ

デバイスからクラウドへのツイン操作カテゴリでは、デバイス ツイン上のデバイスによって開始されたイベントを追跡します。 これらの操作には、ツインの取得、報告されたプロパティの更新、および必要なプロパティへのサブスクライブが含まれます。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "update",
            "category": "D2CTwinOperations",
            "level": "Information",
            "durationMs": "1",
            "properties": "{\"deviceId\":\"<deviceId>\",\"protocol\":\"<protocol>\",\"authenticationType\":\"{\\\"scope\\\":\\\"device\\\",\\\"type\\\":\\\"sas\\\",\\\"issuer\\\":\\\"iothub\\\",\\\"acceptingIpFilterRule\\\":null}\"}",
            "location": "Resource location"
        }
    ]
}

構成カテゴリ

IoT Hub 構成ログでは、自動デバイス管理機能セットのイベントとエラーが追跡されます。

{
    "records":
    [
         {
             "time": "2019-09-24T17:21:52Z",
             "resourceId": "Resource Id",
             "operationName": "ReadManyConfigurations",
             "category": "Configurations",
             "resultType": "",
             "resultDescription": "",
             "level": "Information",
             "durationMs": "17",
             "properties": "{\"configurationId\":\"\",\"sdkVersion\":\"2018-06-30\",\"messageSize\":\"0\",\"statusCode\":null}",
             "location": "southcentralus"
         }
    ]
}

接続カテゴリ

接続カテゴリでは、IoT ハブからのデバイスの接続および切断イベントとエラーを追跡できます。 このカテゴリは、承認されていない接続の試行を識別したり、デバイスへの接続を失ったときに警告したりするのに役立ちます。

デバイスの信頼できる接続状態については、「デバイス接続の状態を監視する」を参照してください。

{
   "records":
   [
        {
            "time": " UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "deviceConnect",
            "category": "Connections",
            "level": "Information",
            "properties": "{\"deviceId\":\"<deviceId>\",\"sdkVersion\":\"<sdkVersion>\",\"protocol\":\"<protocol>\",\"authType\":\"{\\\"scope\\\":\\\"device\\\",\\\"type\\\":\\\"sas\\\",\\\"issuer\\\":\\\"iothub\\\",\\\"acceptingIpFilterRule\\\":null}\",\"maskedIpAddress\":\"<maskedIpAddress>\"}",
            "location": "Resource location"
        }
    ]
}

デバイス接続の監視を目的とした接続ログの使用の詳細については、Azure IoT Hub へのデバイス接続の監視、診断、およびトラブルシューティングに関する記事を参照してください。

デバイス ID 操作カテゴリ

デバイス ID の操作のカテゴリでは、IoT Hub の ID レジストリ内でエントリの作成、更新、または削除を試みたときに発生するエラーを追跡します。 このカテゴリの追跡は、プロビジョニングのシナリオで便利です。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "get",
            "category": "DeviceIdentityOperations",
            "level": "Error",
            "resultType": "Event status",
            "resultDescription": "MessageDescription",
            "properties": "{\"maskedIpAddress\":\"<maskedIpAddress>\",\"deviceId\":\"<deviceId>\", \"statusCode\":\"4XX\"}",
            "location": "Resource location"
        }
    ]
}

デバイス ストリーム カテゴリ (プレビュー)

デバイス ストリーム カテゴリでは、個々のデバイスに送信される要求 - 応答のインタラクションが追跡されます。

{
    "records":
    [
         {
             "time": "2019-09-19T11:12:04Z",
             "resourceId": "Resource Id",
             "operationName": "invoke",
             "category": "DeviceStreams",
             "resultType": "",
             "resultDescription": "",    
             "level": "Information",
             "durationMs": "74",
             "properties": "{\"deviceId\":\"myDevice\",\"moduleId\":\"myModule\",\"sdkVersion\":\"2019-05-01-preview\",\"requestSize\":\"3\",\"responseSize\":\"5\",\"statusCode\":null,\"requestName\":\"myRequest\",\"direction\":\"c2d\"}",
             "location": "Central US"
         }
    ]
}

デバイス テレメトリ カテゴリ

デバイス テレメトリのカテゴリでは、IoT Hub で発生し、かつテレメトリ パイプラインに関連しているエラーを追跡します。 このカテゴリーには、テレメトリ イベントの送信時に発生したエラー (スロットルなど) やテレメトリ イベントの受信時に発生したエラー (許可されていないリーダーなど) が含まれます。 このカテゴリでは、デバイス自体で実行されているコードに起因するエラーをキャッチできません。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "ingress",
            "category": "DeviceTelemetry",
            "level": "Error",
            "resultType": "Event status",
            "resultDescription": "MessageDescription",
            "properties": "{\"deviceId\":\"<deviceId>\",\"batching\":\"0\",\"messageSizeInBytes\":\"<messageSizeInBytes>\",\"EventProcessedUtcTime\":\"<UTC timestamp>\",\"EventEnqueuedUtcTime\":\"<UTC timestamp>\",\"partitionId\":\"1\"}", 
            "location": "Resource location"
        }
    ]
}

ダイレクト メソッド カテゴリ

ダイレクト メソッド カテゴリでは、個々のデバイスに送信される要求 - 応答のインタラクションを追跡します。 これらの要求は、クラウドで開始されます。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "send",
            "category": "DirectMethods",
            "level": "Information",
            "durationMs": "1",
            "properties": "{\"deviceId\":<messageSize>, \"RequestSize\": 1, \"ResponseSize\": 1, \"sdkVersion\": \"2017-07-11\"}",
            "location": "Resource location"
        }
    ]
}

分散トレース カテゴリ (プレビュー)

分散トレース カテゴリでは、トレース コンテキスト ヘッダーが含まれれるメッセージの関連付け ID が追跡されます。 これらのログを完全に有効にするには、IoT Hub 分散トレース (プレビュー) を使用した IoT アプリケーションの エンド ツー エンドの分析と診断に関する記事に従って、クライアント側のコードを更新する必要があります。

correlationId が W3C トレース コンテキストの提案に準拠していることに注意してください。これには、trace-id と span-id が含まれます。

IoT Hub D2C (device-to-cloud) のログ

IoT Hub では、有効なトレース プロパティを含むメッセージが IoT Hub に到着すると、このログが記録されます。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "DiagnosticIoTHubD2C",
            "category": "DistributedTracing",
            "correlationId": "00-8cd869a412459a25f5b4f31311223344-0144d2590aacd909-01",
            "level": "Information",
            "resultType": "Success",
            "resultDescription":"Receive message success",
            "durationMs": "",
            "properties": "{\"messageSize\": 1, \"deviceId\":\"<deviceId>\", \"callerLocalTimeUtc\": : \"2017-02-22T03:27:28.633Z\", \"calleeLocalTimeUtc\": \"2017-02-22T03:27:28.687Z\"}",
            "location": "Resource location"
        }
    ]
}

ここで、IoT Hub のクロックがデバイスのクロックと同期していない可能性があり、経過時間を計算すると誤解を招く場合があるので、durationMs は計算されません。 properties セクションのタイムスタンプを使用するロジックを記述して、device-to-cloud 待機時間のスパイクをキャプチャすることをお勧めします。

IoT Hub のイングレス ログ

有効なトレース プロパティを含むメッセージが内部または組み込みの Event Hubs に書き込むと、IoT Hub でこのログが記録されます。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "DiagnosticIoTHubIngress",
            "category": "DistributedTracing",
            "correlationId": "00-8cd869a412459a25f5b4f31311223344-349810a9bbd28730-01",
            "level": "Information",
            "resultType": "Success",
            "resultDescription":"Ingress message success",
            "durationMs": "10",
            "properties": "{\"isRoutingEnabled\": \"true\", \"parentSpanId\":\"0144d2590aacd909\"}",
            "location": "Resource location"
        }
    ]
}

properties セクションでは、このログにはメッセージのイングレスに関する追加情報が含まれています

IoT Hub のエグレス ログ

ルーティングが有効になっていて、メッセージがエンドポイントに書き込まれると、IoT Hub でこのログが記録されます。 ルーティングが有効でない場合、IoT Hub はこのログを記録しません。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "DiagnosticIoTHubEgress",
            "category": "DistributedTracing",
            "correlationId": "00-8cd869a412459a25f5b4f31311223344-98ac3578922acd26-01",
            "level": "Information",
            "resultType": "Success",
            "resultDescription":"Egress message success",
            "durationMs": "10",
            "properties": "{\"endpointType\": \"EventHub\", \"endpointName\": \"myEventHub\", \"parentSpanId\":\"349810a9bbd28730\"}",
            "location": "Resource location"
        }
    ]
}

properties セクションでは、このログにはメッセージのイングレスに関する追加情報が含まれています

ファイルのアップロード操作カテゴリ

ファイルのアップロード カテゴリでは、IoT Hub で発生し、かつファイルのアップロード機能に関連しているエラーを追跡します。 このカテゴリには、次のエラーが含まれます。

• SAS URI で発生したエラー (デバイスがアップロード完了をハブに通知する前に期限切れになった、など)。
• デバイスによって報告されたアップロード エラー。
• IoT Hub 通知メッセージの作成中にストレージでファイルが見つからないときに発生するエラー。

このカテゴリでは、デバイスがファイルをストレージにアップロードしているときに直接発生したエラーをキャッチできません。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "ingress",
            "category": "FileUploadOperations",
            "level": "Error",
            "resultType": "Event status",
            "resultDescription": "MessageDescription",
            "durationMs": "1",
            "properties": "{\"deviceId\":\"<deviceId>\",\"protocol\":\"<protocol>\",\"authType\":\"{\\\"scope\\\":\\\"device\\\",\\\"type\\\":\\\"sas\\\",\\\"issuer\\\":\\\"iothub\\\",\\\"acceptingIpFilterRule\\\":null}\",\"blobUri\":\"http//bloburi.com\"}",
            "location": "Resource location"
        }
    ]
}

ジョブ操作カテゴリ

ジョブ操作カテゴリでは、デバイス ツインを更新するジョブ要求または複数のデバイスでダイレクト メソッドを呼び出すジョブ要求を報告します。 これらの要求は、クラウドで開始されます。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "jobCompleted",
            "category": "JobsOperations",
            "level": "Information",
            "durationMs": "1",
            "properties": "{\"jobId\":\"<jobId>\", \"sdkVersion\": \"<sdkVersion>\",\"messageSize\": <messageSize>,\"filter\":\"DeviceId IN ['1414ded9-b445-414d-89b9-e48e8c6285d5']\",\"startTimeUtc\":\"Wednesday, September 13, 2017\",\"duration\":\"0\"}",
            "location": "Resource location"
        }
    ]
}

ルート カテゴリ

メッセージ ルーティング カテゴリでは、メッセージ ルートの評価時に発生するエラーと、IoT Hub によって認識されるエンドポイントの正常性を追跡します。 このカテゴリには、以下のようなイベントが含まれます。

• ルールが "undefined" と評価される
• IoT Hub によってエンドポイントがデッドとしてマークされる
• エンドポイントから受信したエラー

このカテゴリには、メッセージ自体に関する具体的なエラー (デバイス調整エラーなど) は含まれません。このようなエラーは、"デバイス テレメトリ" カテゴリで報告されます。

{
    "records":
    [
        {
            "time":"2019-12-12T03:25:14Z",
            "resourceId":"/SUBSCRIPTIONS/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/RESOURCEGROUPS/ANON-TEST/PROVIDERS/MICROSOFT.DEVICES/IOTHUBS/ANONHUB1",
            "operationName":"endpointUnhealthy",
            "category":"Routes",
            "level":"Error",
            "resultType":"403004",
            "resultDescription":"DeviceMaximumQueueDepthExceeded",
            "properties":"{\"deviceId\":null,\"endpointName\":\"anon-sb-1\",\"messageId\":null,\"details\":\"DeviceMaximumQueueDepthExceeded\",\"routeName\":null,\"statusCode\":\"403\"}",
            "location":"westus"
        }
    ]
}

ルーティング リソース ログの詳細は次のとおりです。

• ルーティング リソース ログのエラー コードの一覧
• ルーティング リソース ログの操作名の一覧

ツイン クエリ カテゴリ

ツイン クエリのカテゴリでは、クラウドで開始されたデバイス ツインのクエリ要求を報告します。

{
    "records":
    [
        {
            "time": "UTC timestamp",
            "resourceId": "Resource Id",
            "operationName": "query",
            "category": "TwinQueries",
            "level": "Information",
            "durationMs": "1",
            "properties": "{\"query\":\"<twin query>\",\"sdkVersion\":\"<sdkVersion>\",\"messageSize\":\"<messageSize>\",\"pageSize\":\"<pageSize>\", \"continuation\":\"<true, false>\", \"resultSize\":\"<resultSize>\"}",
            "location": "Resource location"
        }
    ]
}

Azure Monitor ログ テーブル

このセクションでは、Kusto クエリを使用した Log Analytics によるクエリに使用できる、このサービスに関連するすべての Azure Monitor ログ テーブルを一覧表示します。 テーブルにはリソース ログ データが含まれており、収集されルーティングされる内容によっては、さらに多くのデータが含まれる場合があります。

IoT Hub Microsoft.Devices/IotHubs

• AzureActivity
• AzureMetrics
• AzureDiagnostics
• IoTHubDistributedTracing
• InsightsMetrics

アクティビティ ログ

リンクされたテーブルには、このサービスのアクティビティ ログに記録できる操作が一覧表示されます。 これらの操作は、アクティビティ ログで使用可能なすべてのリソース プロバイダー操作のサブセットです。

アクティビティ ログ エントリのスキーマの詳細については、「アクティビティ ログのスキーマ」を参照してください。

• Microsoft.Devices リソース プロバイダーの操作

関連するコンテンツ

• IoT Hub の監視の詳細については、「 Monitor Azure IoT Hub 」を参照してください。
• Azure リソースの監視の詳細については、「Azure Monitor で Azure リソースを監視する」を参照してください。