Azure IoT 中樞 監視數據參考

本文包含此服務的所有監視參考資訊。

如需您可以針對 IoT 中樞 收集的數據及其使用方式的詳細資訊，請參閱監視 Azure IoT。

計量

本節列出針對此服務的所有自動收集平台計量。 這些計量也是 Azure 監視器中支援的所有平台計量全域清單的一部分。

如需計量保留的相關資訊，請參閱 Azure 監視器計量概觀。

Microsoft.Devices/IoTHubs 支援的計量

下表列出適用於 Microsoft.Devices/IoTHubs 資源類型的計量。

• 所有資料行可能不存在於每個資料表中。
• 某些資料行可能超出頁面的檢視區域。 選取 [展開資料表] 以檢視所有可用的資料行。

資料表標題

• 類別 - 計量群組或分類。
• 計量 - Azure 入口網站中顯示的計量顯示名稱。
• REST API 中的名稱 - REST API 中所指的計量名稱。
• 單位 - 測量單位。
• 彙總 - 預設彙總類型。 有效值：平均值 (Avg)、最小值 (Min)、最大值 (Max)、總計 (Sum)、計數。
• 維度 - 計量可用的維度。
• 時間精細度 - 取樣計量的間隔。 例如，PT1M 表示計量會每分鐘取樣、每 30 分鐘PT30M、每小時 PT1H，以此類推。
• DS 匯出 - 計量是否可透過診斷設定，匯出至 Azure 監視器記錄。 如需匯出計量的資訊，請參閱在 Azure 監視器中建立診斷設定。

支援的匯總

數據表中的 [匯總類型] 數據行會對應至針對圖表或警示選取計量時所使用的預設匯總。

對於大部分的計量，所有匯總類型都是有效的。 對於具有 Count 單位數據行值的計數計量，只有一些匯總有效。 計數計量可以是兩種類型之一：

• 針對單一點計數計量，IoT 中樞 每次測量作業時註冊單一數據點（基本上為 1）。 然後，Azure 監視器會將這些數據點加總至指定的數據粒度。 單一點計量的範例是已傳送的遙測訊息，以及已完成 C2D 訊息傳遞。 針對這些計量，唯一相關的匯總類型是 Total （Sum）。 入口網站可讓您選擇最小、最大值和平均值。 這些值一律為 1。

• 針對快照集計數計量，IoT 中樞 在測量作業發生時註冊總計計數。 目前，IoT 中樞 發出三個快照集計量：使用的訊息總數、裝置總數和已連線裝置。 由於這些計量每次都會呈現「總計」數量，因此在指定的粒度上加總它們並無意義。 Azure 監視器會限制您為這些計量選取匯總類型的平均、最小值和最大值。

載入計量維度

如需計量維度是什麼的資訊，請參閱多維度計量。

此服務具有下列與其計量相關聯的維度。

計量顯示名稱和匯總

下表提供有關上表所述計量的詳細資訊。 他們會依一般類別顯示 IoT 中樞 平臺計量，並依 Azure 入口網站 中指派的顯示名稱列出計量。

雲端到裝置命令計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

雲端到裝置直接方法計量：

對於單位值為 Count total （sum） 匯總的計量有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

雲端到裝置對應項作業計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

設定計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

每日配額計量：

針對 使用的訊息總數，僅支援最小、最大值和平均匯總。 如需詳細資訊，請參閱 支持的匯總。

裝置計量：

針對 [裝置總計][已淘汰] 和 [已連線的裝置] [已淘汰]，只有總計 （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

針對 [ 裝置總計] 和 [已連線的裝置]，只有最小值、最大值和平均匯總有效。 如需詳細資訊，請參閱 支持的匯總。

無法透過診斷設定導出裝置 和 連線裝置 總數。

裝置遙測計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

裝置到雲端對應項目作業計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

事件方格計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

工作計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

路由計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

對應項目查詢計量：

對於單位值為 Count 的計量，只有 total （sum） 匯總有效。 最小值、最大值和平均匯總一律會傳回 1。 如需詳細資訊，請參閱 支持的匯總。

資源記錄

本節列出您可以針對此服務收集的資源記錄類型。 該區段會從 Azure 監視器中支援的所有資源記錄類別類型清單提取。

Microsoft.Devices/IotHubs 支援的資源記錄

下列各節列出針對 Azure IoT 中樞 收集的資源記錄類別類型和架構。 系統只會針對一些類別中的錯誤發出事件。

雲端到裝置命令類別

雲端到裝置的命令類別會追蹤發生在 IoT 中樞且與雲端到裝置訊息管線相關的錯誤。 此類別包括發生自下列動作的錯誤：

• 傳送雲端到裝置訊息（例如未經授權的發件者錯誤），
• 接收雲端到裝置訊息（例如傳遞計數超過錯誤），以及
• 接收雲端到裝置訊息意見反應 (例如意見反應已過期的錯誤)。

當雲端到裝置訊息成功傳遞，但裝置未正確處理時，此類別不會攔截錯誤。

{
    "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 中樞 組態記錄會追蹤自動 裝置管理 功能集的事件和錯誤。

{
    "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 中樞 的連線能力。

裝置身分識別作業類別

裝置身分識別作業類別會追蹤您嘗試在 IoT 中樞的身分識別登錄中建立、更新或刪除項目時所發生的錯誤。 追蹤此類別對於佈建案例很實用。

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

分散式追蹤類別 （預覽）

分散式追蹤類別會追蹤包含追蹤內容標頭之訊息的相互關聯標識碼。 若要完全啟用這些記錄，用戶端程式代碼必須遵循使用分散式追蹤 IoT 中樞 端對端分析及診斷 IoT 應用程式來更新。

correlationId符合 W3C 追蹤內容提案，其中包含 trace-id 和 span-id。

IoT 中樞 D2C （裝置到雲端） 記錄

當包含有效追蹤屬性的訊息到達 IoT 中樞 時，IoT 中樞 會記錄此記錄檔。

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

在這裡，durationMs不會計算為 IoT 中樞 的時鐘可能未與裝置時鐘同步，因此持續時間計算可能會產生誤導。 建議您使用 區段中的 properties 時間戳來撰寫邏輯，以擷取裝置到雲端延遲的尖峰。

IoT 中樞 輸入記錄

當包含有效追蹤屬性的訊息寫入內部或內建事件中樞時，IoT 中樞 會記錄此記錄檔。

{
    "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 中樞 輸出記錄

IoT 中樞 啟用路由時記錄此記錄檔，並將訊息寫入端點。 如果未啟用路由，IoT 中樞 不會記錄此記錄。

{
    "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 中樞 通知訊息建立期間，在記憶體中找不到檔案時所發生的錯誤。

此類別無法攔截裝置將檔案上傳至記憶體時直接發生的錯誤。

{
    "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 中樞 所感知的端點健康情況。 此類別包括下列事件，例如：

• 規則評估為「未定義」
• IoT 中樞 將端點標示為無效
• 從端點接收的任何錯誤

此類別不包含訊息本身的特定錯誤（例如裝置節流錯誤），這些錯誤會報告在「裝置遙測」類別之下。

{
    "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 監視器記錄資料表

本節列出與此服務相關的 Azure 監視器記錄資料表，並且該資料表可供 Log Analytics 使用 Kusto 查詢進行查詢。 資料表包含資源記錄資料，而且可能包含更多資料，具體取決於所收集及路由傳送至此的內容。

IoT 中樞 Microsoft.Devices/IotHubs

• AzureActivity
• AzureMetrics
• AzureDiagnostics
• IoTHubDistributedTracing
• InsightsMetrics

活動記錄檔

連結的資料表會列出此服務活動記錄檔中可記錄的操作。 這些操作是活動記錄中的所有可能資源提供者操作的子集。

如需活動記錄項目結構描述的詳細資訊，請參閱活動記錄結構描述。

• Microsoft.Devices 資源提供者作業

相關內容

• 如需監視 IoT 中樞 的描述，請參閱監視 Azure IoT 中樞。
• 如需監視 Azure 資源的詳細資訊，請參閱使用 Azure 監視器來監視 Azure 資源。