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

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

IoT Hub 用に収集できるデータとその使用方法の詳細については、「 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 で診断設定を作成する」を参照してください。

サポートされる集約

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

ほとんどのメトリクスでは、すべての集計タイプが有効です。 Unit 列の値が Count のカウントメトリクスの場合、一部の集計のみが有効です。 カウント メトリックは、次の 2 つのタイプのいずれかになります。

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

• スナップショット数メトリックの場合、IoT Hub は測定された操作が発生したときに合計数を登録します。 現在、IoT Hub によって出力される スナップショット メトリックには、 使用されたメッセージの合計数、 デバイスの合計数、 接続されたデバイスの 3 つがあります。 これらのメトリクスは毎回「合計」数量を示すため、指定された粒度で合計しても意味がありません。 Azure Monitor では、これらのメトリックの集計の種類として、平均、最小、および最大を選択するように制限されています。

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

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

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

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

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

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

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

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

[単位] の値が [カウント] のメトリクスの場合、合計 (合計) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

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

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

構成メトリック:

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

日次クォータ メトリック:

[ Total number of messages used] では、最小、最大、および平均の集計のみがサポートされています。 詳細については、「 サポートされている集計」を参照してください。

デバイスメトリクス:

[Total devices] (非推奨) と [Connected devices] (非推奨) の場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

[ Total devices ] と [ Connected devices] では、最小、最大、および平均の集計のみが有効です。 詳細については、「 サポートされている集計」を参照してください。

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

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

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

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

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

Event Grid メトリック:

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

ジョブメトリクス:

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

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

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

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

Unit 値が Count のメトリクスの場合、合計 (sum) 集計のみが有効です。 最小、最大、および平均の集計は、常に 1 を返します。 詳細については、「 サポートされている集計」を参照してください。

リソース ログ

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

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

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

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

cloud-to-device コマンド カテゴリは、IoT ハブで発生し、cloud-to-device メッセージ パイプラインに関連するエラーを追跡します。 このカテゴリには、以下から発生するエラーが含まれます。

• 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"
        }
    ]
}

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

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

{
    "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 ハブの 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 ハブで発生し、テレメトリ パイプラインに関連するエラーを追跡します。 このカテゴリには、テレメトリ イベントの送信時 (調整など) とテレメトリ イベントの受信時 (承認されていないリーダーなど) で発生するエラーが含まれます。 このカテゴリでは、デバイス自体で実行されているコードによって発生したエラーをキャッチすることはできません。

{
    "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は、trace-idとspan-idを含む W3C Trace Context の提案に準拠しています。

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セクションのタイムスタンプを使用してロジックを記述し、デバイスからクラウドへのレイテンシの急増をキャプチャすることをお勧めします。

IoT Hub イングレス ログ

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

{
    "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 ハブで発生し、ファイルのアップロード機能に関連するエラーを追跡します。 このカテゴリには、次のものが含まれます。

• 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 によって認識されるエンドポイントの正常性を追跡します。 このカテゴリには、次のようなイベントが含まれます。

• ルールが「未定義」と評価される
• 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"
        }
    ]
}

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

• ルーティング・リソース・ログ・エラー・コードのリスト
• ルーティング・リソース・ログoperationNamesのリスト

ツイン クエリ カテゴリ

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

{
    "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 の監視については、「 Azure IoT Hub の監視 」を参照してください。
• Azure リソースの監視の詳細については、「Azure Monitor で Azure リソースを監視する」を参照してください。