Monitorização Hub IoT do Azure referência de dados

Para começar a utilizar a monitorização do Azure, veja Monitorizar Hub IoT do Azure para compreender como recolher e analisar dados de monitorização para Hub IoT do Azure.

Este artigo é uma referência para implementar a monitorização do Azure.

As secções principais neste artigo de referência:

Métricas

Esta secção lista todas as métricas de plataforma recolhidas automaticamente para Hub IoT do Azure. O espaço de nomes do fornecedor de recursos para Hub IoT métricas é Microsoft.Devices e o tipo Espaço de Nomes é IoTHubs.

As subsecções seguintes mostram as métricas da plataforma Hub IoT por categoria geral e listar métricas pelo respetivo nome a apresentar atribuído no portal do Azure.

Também pode encontrar uma única tabela que lista todas as métricas da plataforma Hub IoT por nome de métrica em Microsoft.Devices/IotHubs na documentação do Azure Monitor. Esta tabela não fornece todas as informações, como agregações suportadas para algumas métricas, disponíveis neste artigo.

Para saber mais sobre as métricas suportadas por outros serviços do Azure, veja Métricas suportadas com o Azure Monitor.

Tópicos nesta secção

Selecione um tópico para aceder às respetivas informações nesta página.

Agregações suportadas

A coluna Tipo de Agregação em cada tabela corresponde à agregação predefinida utilizada quando a métrica é selecionada para um gráfico ou alerta.

Captura de ecrã a mostrar a agregação de métricas

Para a maioria das métricas, todos os tipos de agregação são válidos; no entanto, para contar métricas com um valor de coluna Unidade de Contagem, apenas algumas agregações são válidas. A contagem de métricas pode ser um de dois tipos:

  • Para métricas de contagem de pontos únicos, Hub IoT regista um único ponto de dados (essencialmente um 1) sempre que a operação medida ocorre. Em seguida, o Azure Monitor soma estes pontos de dados sobre a granularidade especificada. Exemplos de métricas de ponto único são mensagens de Telemetria enviadas e entregas de mensagens C2D concluídas. Para estas métricas, o único tipo de agregação relevante é Total (Soma). O portal permite-lhe escolher o mínimo, o máximo e a média; no entanto, estes valores serão sempre 1.

  • Para métricas de Contagem de instantâneos, Hub IoT regista uma contagem total quando ocorre a operação medida. Atualmente, existem três Métricas de instantâneo emitidas por Hub IoT: Número total de mensagens utilizadas, Total de dispositivos e Dispositivos ligados. Uma vez que estas métricas apresentam uma quantidade "total" sempre que são emitidas, somar as mesmas sobre a granularidade especificada não faz sentido. O Azure Monitor limita-o a selecionar a média, o mínimo e o máximo para o tipo de agregação para estas métricas.

Métricas de comandos da cloud para o dispositivo

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Description Dimensões
Mensagens C2D Expiradas C2DMessagesExpired de palavras Total Número de mensagens da cloud para o dispositivo expiradas Nenhuma
Entregas de mensagens C2D concluídas c2d.commands.egress.complete.success de palavras Total Número de entregas de mensagens da cloud para o dispositivo concluídas com êxito pelo dispositivo Nenhuma
Mensagens C2D abandonadas c2d.commands.egress.abandon.success de palavras Total Número de mensagens da cloud para o dispositivo abandonadas pelo dispositivo Nenhuma
Mensagens C2D rejeitadas c2d.commands.egress.reject.success de palavras Total Número de mensagens da cloud para o dispositivo rejeitadas pelo dispositivo Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de métodos diretos da cloud para o dispositivo

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Description Dimensões
Invocações de método direto falhadas c2d.methods.failure de palavras Total A contagem de todas as chamadas de método direto falhadas. Nenhuma
Tamanho do pedido de invocações de método direto c2d.methods.requestSize Bytes Média A contagem de todos os pedidos de método direto bem-sucedidos. Nenhuma
Tamanho da resposta das invocações de método direto c2d.methods.responseSize Bytes Média A contagem de todas as respostas de método direto bem-sucedidas. Nenhuma
Invocações de métodos diretos bem-sucedidas c2d.methods.success de palavras Total A contagem de todas as chamadas de método direto bem-sucedidas. Nenhuma

Para métricas com um valor unitário de Contagem apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de operações cloud para dispositivo duplo

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Description Dimensões
Leituras de duplos com falhas a partir do back-end c2d.twin.read.failure de palavras Total A contagem de todas as leituras de duplos iniciadas no back-end falhadas. Nenhuma
Atualizações de duplos falhadas a partir do back-end c2d.twin.update.failure de palavras Total A contagem de todas as atualizações de duplos iniciadas no back-end falhadas. Nenhuma
Tamanho da resposta das leituras de duplos a partir do back-end c2d.twin.read.size Bytes Média A contagem de todas as leituras de duplos iniciadas no back-end com êxito. Nenhuma
Tamanho das atualizações de duplos a partir do back-end c2d.twin.update.size Bytes Média O tamanho total de todas as atualizações de duplo iniciadas no back-end com êxito. Nenhuma
Leituras de duplos bem-sucedidas a partir do back-end c2d.twin.read.success de palavras Total A contagem de todas as leituras de duplos iniciadas no back-end com êxito. Nenhuma
Atualizações de duplos bem-sucedidas a partir do back-end c2d.twin.update.success de palavras Total A contagem de todas as atualizações de duplos iniciadas no back-end com êxito. Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de configuração

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Description Dimensões
Métricas de Configuração configurações de palavras Total Número total de operações CRUD realizadas para a configuração do dispositivo e IoT Edge implementação, num conjunto de dispositivos de destino. Estão incluídas o número de operações que modificam o dispositivo duplo ou o módulo duplo devido a estas configurações. Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de quota diárias

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Description Dimensões
Utilização total de dados do dispositivo deviceDataUsage Bytes Total Bytes transferidos de e para quaisquer dispositivos ligados ao IotHub Nenhuma
Utilização total de dados do dispositivo (pré-visualização) deviceDataUsageV2 Bytes Total Bytes transferidos de e para quaisquer dispositivos ligados ao IotHub Nenhuma
Número total de mensagens utilizadas dailyMessageQuotaUsed de palavras Média Número total de mensagens utilizadas atualmente. Um valor cumulativo que é reposto para zero às 00:00 UTC todos os dias. Nenhuma

Para o número total de mensagens utilizadas, são suportadas apenas agregações mínimas, máximas e médias. Para obter mais informações, veja Agregações suportadas.

Métricas do dispositivo

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Descrição Dimensões
Total de dispositivos (preteridos) devices.totalDevices de palavras Total Número de dispositivos registados no hub IoT Nenhuma
Dispositivos ligados (preteridos) devices.connectedDevices.allProtocol de palavras Total Número de dispositivos ligados ao hub IoT Nenhuma
Total de dispositivos totalDeviceCount de palavras Média Número de dispositivos registados no hub IoT Nenhuma
Dispositivos ligados connectedDeviceCount de palavras Média Número de dispositivos ligados ao hub IoT Nenhuma

Para o Total de dispositivos (preteridos) e Dispositivos ligados (preteridos), apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Para o Total de dispositivos e Dispositivos ligados, apenas são válidas as agregações mínimas, máximas e médias. Para obter mais informações, veja Agregações suportadas.

O total de dispositivos e Dispositivos ligados não são exportáveis através das definições de diagnóstico.

Métricas de telemetria do dispositivo

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Descrição Dimensões
Número de erros de limitação d2c.telemetry.ingress.sendThrottle de palavras Total Número de erros de limitação devido a limitações de débito do dispositivo Nenhuma
Tentativas de "envio de mensagens" de telemetria d2c.telemetry.ingress.allProtocol de palavras Total Número de mensagens de telemetria do dispositivo para a cloud que tentaram ser enviadas para o seu hub IoT Nenhuma
Mensagens de telemetria enviadas d2c.telemetry.ingress.success de palavras Total Número de mensagens de telemetria do dispositivo para a cloud enviadas com êxito para o seu hub IoT Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de operações do dispositivo para o cloud twin

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Descrição Dimensões
Leituras de duplos com falha a partir de dispositivos d2c.twin.read.failure de palavras Total A contagem de todas as leituras de duplos iniciadas pelo dispositivo falhadas. Nenhuma
Falha nas atualizações de duplos a partir de dispositivos d2c.twin.update.failure de palavras Total A contagem de todas as atualizações de dispositivos duplos falhadas iniciadas pelo dispositivo. Nenhuma
Tamanho da resposta de leituras de duplos a partir de dispositivos d2c.twin.read.size Bytes Média O número de todas as leituras de dispositivos duplos iniciadas com êxito. Nenhuma
Tamanho das atualizações de duplos a partir de dispositivos d2c.twin.update.size Bytes Média O tamanho total de todas as atualizações de dispositivos duplos iniciadas com êxito. Nenhuma
Leituras de duplos duplos bem-sucedidas a partir de dispositivos d2c.twin.read.success de palavras Total A contagem de todas as leituras de dispositivos duplos iniciadas com êxito. Nenhuma
Atualizações de duplos com êxito a partir de dispositivos d2c.twin.update.success de palavras Total A contagem de todas as atualizações de dispositivos duplos iniciadas com êxito. Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas do Event Grid

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Description Dimensões
Entregas do Event Grid EventGridDeliveries de palavras Total O número de Hub IoT eventos publicados no Event Grid. Utilize a dimensão Result para o número de pedidos com êxito e falhados. A dimensão EventType mostra o tipo de evento (https://aka.ms/ioteventgrid). Resultado:
EventType
Para obter mais informações, veja Dimensões das métricas.
Latência do Event Grid EventGridLatency Milissegundos Média A latência média (milissegundos) de quando o evento hub IoT foi gerado para quando o evento foi publicado no Event Grid. Este número é uma média entre todos os tipos de eventos. Utilize a dimensão EventType para ver a latência de um tipo específico de evento. EventType
Para obter mais informações, veja Dimensões das métricas.

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de tarefas

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Description Dimensões
Tarefas concluídas jobs.completed de palavras Total A contagem de todas as tarefas concluídas. Nenhuma
Chamadas falhadas para listar tarefas jobs.listJobs.failure de palavras Total A contagem de todas as chamadas falhadas para listar tarefas. Nenhuma
Criações falhadas de tarefas de invocação de métodos jobs.createDirectMethodJob.failure de palavras Total A contagem de todas as tarefas de invocação do método direto falhadas. Nenhuma
Criações falhadas de tarefas de atualização de duplos jobs.createTwinUpdateJob.failure de palavras Total A contagem de todas as tarefas de atualização de duplos falhadas. Nenhuma
Cancelamentos de tarefas falhados jobs.cancelJob.failure de palavras Total A contagem de todas as chamadas falhadas para cancelar uma tarefa. Nenhuma
Consultas de tarefas falhadas jobs.queryJobs.failure de palavras Total A contagem de todas as chamadas falhadas para tarefas de consulta. Nenhuma
Tarefas falhadas jobs.failed de palavras Total A contagem de todas as tarefas falhadas. Nenhuma
Chamadas bem-sucedidas para listar tarefas jobs.listJobs.success de palavras Total A contagem de todas as chamadas bem-sucedidas para listar tarefas. Nenhuma
Criações bem-sucedidas de tarefas de invocação de métodos jobs.createDirectMethodJob.success de palavras Total A contagem de todas as criações bem-sucedidas de tarefas de invocação de métodos diretos. Nenhuma
Criações bem-sucedidas de tarefas de atualização de duplos jobs.createTwinUpdateJob.
exito
de palavras Total A contagem de todas as criações bem-sucedidas de tarefas de atualização de duplos. Nenhuma
Cancelamentos de tarefas com êxito jobs.cancelJob.success de palavras Total A contagem de todas as chamadas bem-sucedidas para cancelar uma tarefa. Nenhuma
Consultas de tarefas com êxito jobs.queryJobs.success de palavras Total A contagem de todas as chamadas bem-sucedidas para tarefas de consulta. Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de encaminhamento

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Descrição Dimensões
Encaminhamento de Entregas (pré-visualização) EncaminhamentoDeliveries de palavras Total A métrica de entrega do encaminhamento. Utilize as dimensões para identificar o estado de entrega de um ponto final específico ou para uma origem de encaminhamento específica. Resultado:
RoutingSource,
EndpointType,
FailureReasonCategory,
EndpointName
Para obter mais informações, veja Dimensões de métricas.
Encaminhamento do Tamanho da Mensagem de Entrega em Bytes (pré-visualização) RoutingDataSizeInBytesDelivered Bytes Total O número total de bytes encaminhados por Hub IoT para o ponto final personalizado e o ponto final incorporado. Utilize as dimensões para identificar o tamanho dos dados encaminhados para um ponto final específico ou para uma origem de encaminhamento específica. RoutingSource,
EndpointType
EndpointName
Para obter mais informações, veja Dimensões de métricas.
Latência de Entrega de Encaminhamento (pré-visualização) RoutingDeliveryLatency Milissegundos Média A métrica de latência de entrega de encaminhamento. Utilize as dimensões para identificar a latência de um ponto final específico ou para uma origem de encaminhamento específica. RoutingSource,
EndpointType,
EndpointName
Para obter mais informações, veja Dimensões de métricas.
Encaminhamento: blobs entregues no armazenamento d2c.endpoints.egress.storage.blobs de palavras Total O número de vezes Hub IoT encaminhamento de blobs entregues para pontos finais de armazenamento. Nenhuma
Encaminhamento: dados entregues no armazenamento d2c.endpoints.egress.storage.bytes Bytes Total A quantidade de dados (bytes) Hub IoT encaminhamento fornecido para pontos finais de armazenamento. Nenhuma
Encaminhamento: latência de mensagens para Hubs de Eventos d2c.endpoints.latency.eventHubs Milissegundos Média A latência média (milissegundos) entre a entrada de mensagens para Hub IoT e a entrada de mensagens em pontos finais personalizados do tipo Hubs de Eventos. As rotas de mensagens para o ponto final incorporado (eventos) não estão incluídas. Nenhuma
Encaminhamento: latência de mensagens para a Fila do Service Bus d2c.endpoints.latency.serviceBusQueues Milissegundos Média A latência média (milissegundos) entre a entrada de mensagens para Hub IoT e a entrada de mensagens num ponto final de fila do Service Bus. Nenhuma
Encaminhamento: latência de mensagens para o Tópico do Service Bus d2c.endpoints.latency.serviceBusTopics Milissegundos Média A latência média (milissegundos) entre a entrada de mensagens para Hub IoT e a entrada de mensagens num ponto final de tópico do Service Bus. Nenhuma
Encaminhamento: latência de mensagens para mensagens/eventos d2c.endpoints.latency.builtIn.events Milissegundos Média A latência média (milissegundos) entre a entrada de mensagens para Hub IoT e a entrada de mensagens no ponto final incorporado (mensagens/eventos) e a rota de contingência. Nenhuma
Encaminhamento: latência de mensagens para armazenamento d2c.endpoints.latency.storage Milissegundos Média A latência média (milissegundos) entre a entrada de mensagens para Hub IoT e a entrada de mensagens num ponto final de armazenamento. Nenhuma
Encaminhamento: mensagens entregues nos Hubs de Eventos d2c.endpoints.egress.eventHubs de palavras Total O número de vezes Hub IoT o encaminhamento de mensagens entregues com êxito para pontos finais personalizados do tipo Hubs de Eventos. As rotas de mensagens para o ponto final incorporado (eventos) não estão incluídas. Nenhuma
Encaminhamento: mensagens entregues na Fila do Service Bus d2c.endpoints.egress.serviceBusQueues de palavras Total O número de vezes Hub IoT o encaminhamento de mensagens entregues com êxito para pontos finais de fila do Service Bus. Nenhuma
Encaminhamento: mensagens entregues no Tópico do Service Bus d2c.endpoints.egress.serviceBusTopics de palavras Total O número de vezes Hub IoT o encaminhamento de mensagens entregues com êxito para pontos finais de tópicos do Service Bus. Nenhuma
Encaminhamento: mensagens entregues para contingência d2c.telemetry.egress.fallback de palavras Total O número de vezes Hub IoT encaminhamento de mensagens entregues para o ponto final associado à rota de contingência. Nenhuma
Encaminhamento: mensagens entregues a mensagens/eventos d2c.endpoints.egress.builtIn.events de palavras Total O número de vezes Hub IoT o encaminhamento de mensagens entregues com êxito para o ponto final incorporado (mensagens/eventos) e a rota de contingência. Nenhuma
Encaminhamento: mensagens entregues no armazenamento d2c.endpoints.egress.storage de palavras Total O número de vezes Hub IoT o encaminhamento de mensagens entregues com êxito para pontos finais de armazenamento. Nenhuma
Encaminhamento: mensagens de telemetria entregues d2c.telemetry.egress.success de palavras Total O número de vezes que as mensagens foram entregues com êxito em todos os pontos finais com Hub IoT encaminhamento. Se uma mensagem for encaminhada para vários pontos finais, este valor aumenta um para cada entrega com êxito. Se uma mensagem for entregue no mesmo ponto final várias vezes, este valor aumenta um para cada entrega com êxito. Nenhuma
Encaminhamento: mensagens de telemetria removidas d2c.telemetry.egress.dropped de palavras Total O número de vezes que as mensagens foram removidas por Hub IoT encaminhamento devido a pontos finais inativos. Este valor não conta as mensagens entregues na rota de contingência, uma vez que as mensagens removidas não são entregues na mesma. Nenhuma
Encaminhamento: mensagens de telemetria incompatíveis d2c.telemetry.egress.invalid de palavras Total O número de vezes Hub IoT o encaminhamento não conseguiu entregar mensagens devido a uma incompatibilidade com o ponto final. Uma mensagem é incompatível com um ponto final quando o Hub Iot tenta entregar a mensagem a um ponto final e falha com um erro não transitório. As mensagens inválidas não são repetidas. Este valor não inclui repetições. Nenhuma
Encaminhamento: mensagens de telemetria órfãs d2c.telemetry.egress.orphaned de palavras Total O número de vezes que as mensagens foram órfãs por Hub IoT o encaminhamento porque não correspondem a nenhuma consulta de encaminhamento, quando a rota de contingência está desativada. Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Métricas de consulta de duplos

Nome a Apresentar da Métrica Metric Unidade Tipo de Agregação Descrição Dimensões
Consultas de duplos duplos falhadas twinQueries.failure de palavras Total A contagem de todas as consultas de duplos com falhas. Nenhuma
Consultas de duplos duplos com êxito twinQueries.success de palavras Total A contagem de todas as consultas de duplos êxitos. Nenhuma
Tamanho do resultado das consultas de duplos twinQueries.resultSize Bytes Média O total do tamanho do resultado de todas as consultas de duplos efetuadas com êxito. Nenhuma

Para métricas com um valor unitário de Contagem, apenas a agregação total (soma) é válida. As agregações mínimas, máximas e médias devolvem sempre 1. Para obter mais informações, veja Agregações suportadas.

Dimensões das métricas

Hub IoT do Azure tem as seguintes dimensões associadas a algumas das métricas de encaminhamento e event grid.

Nome da Dimensão Description
EndpointName O nome do ponto final
EndpointType eventHubs, serviceBusQueues, cosmosDB, serviceBusTopics. builtin ou blobStorage
EventType Microsoft.Devices.DeviceCreated. Microsoft.Devices.DeviceDeleted, Microsoft.Devices.DeviceConnected, Microsoft.Devices.DeviceDisconnected ou Microsoft.Devices.DeviceTelemetry
Para obter mais informações, veja Tipos de eventos.
FailureReasonCategory Uma das seguintes opções: inválida, removida, órfã ou nula.
Resultado Êxito oufalha
RoutingSource Mensagens do Dispositivo
Eventos de Alteração de Duplos
Eventos de Ciclo de Vida do Dispositivo

Para saber mais sobre as dimensões das métricas, veja Métricas multidimensionais.

Registos do recurso

Esta secção lista todos os tipos e esquemas de categorias de registo de recursos recolhidos para Hub IoT do Azure. O fornecedor de recursos e o tipo para todos os registos de Hub IoT é Microsoft.Devices/IotHubs. Os eventos são emitidos apenas para erros em algumas categorias.

Tópicos nesta secção

Ligações

A categoria de ligações monitoriza os eventos de ligação e desconexão de dispositivos de um hub IoT e erros. Esta categoria é útil para identificar tentativas de ligação não autorizadas e alertas quando perde a ligação a dispositivos.

Para obter o estado de ligação fiável dos dispositivos, veja Monitorizar o estado da ligação do dispositivo.

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

Para obter informações detalhadas sobre a utilização de registos de ligações para monitorizar a conectividade do dispositivo, veja Monitorizar, diagnosticar e resolver problemas de conectividade do dispositivo a Hub IoT do Azure.

Telemetria do dispositivo

A categoria de telemetria do dispositivo monitoriza os erros que ocorrem no hub IoT e estão relacionados com o pipeline de telemetria. Esta categoria inclui erros que ocorrem ao enviar eventos de telemetria (como limitação) e receber eventos de telemetria (como leitor não autorizado). Esta categoria não consegue detetar erros causados pelo código em execução no próprio dispositivo.

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

Comandos da cloud para dispositivo

A categoria de comandos da cloud para o dispositivo monitoriza os erros que ocorrem no hub IoT e estão relacionados com o pipeline de mensagens da cloud para o dispositivo. Esta categoria inclui erros que ocorrem a partir de:

  • Enviar mensagens da cloud para o dispositivo (como erros não autorizados do remetente),
  • Receber mensagens da cloud para o dispositivo (como erros excedidos na contagem de entrega) e
  • Receber feedback de mensagens da cloud para o dispositivo (como erros expirados de feedback).

Esta categoria não detetará erros quando a mensagem da cloud para o dispositivo é entregue com êxito, mas depois processada incorretamente pelo dispositivo.

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

Operações de identidade do dispositivo

A categoria de operações de identidade do dispositivo monitoriza os erros que ocorrem quando tenta criar, atualizar ou eliminar uma entrada no registo de identidade do seu hub IoT. Controlar esta categoria é útil para cenários de aprovisionamento.

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

Operações de carregamento de ficheiros

A categoria de carregamento de ficheiros monitoriza os erros que ocorrem no hub IoT e estão relacionados com a funcionalidade de carregamento de ficheiros. Esta categoria inclui:

  • Erros que ocorrem com o URI de SAS, como quando expira antes de um dispositivo notificar o hub de um carregamento concluído.

  • Falhas nos carregamentos comunicados pelo dispositivo.

  • Erros que ocorrem quando um ficheiro não é encontrado no armazenamento durante Hub IoT criação de mensagens de notificação.

Esta categoria não consegue detetar erros que ocorrem diretamente enquanto o dispositivo está a carregar um ficheiro para o armazenamento.

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

Rotas

A categoria de encaminhamento de mensagens monitoriza os erros que ocorrem durante a avaliação da rota de mensagens e o estado de funcionamento do ponto final, conforme percebido pelo Hub IoT. Esta categoria inclui eventos como:

  • Uma regra é avaliada como "indefinida",
  • Hub IoT marca um ponto final como inativo ou
  • Quaisquer erros recebidos de um ponto final.

Esta categoria não inclui erros específicos sobre as próprias mensagens (como erros de limitação de dispositivos), que são comunicados na categoria "telemetria do dispositivo".

{
    "records":
    [
        {
            "time":"2019-12-12T03:25:14Z",
            "resourceId":"/SUBSCRIPTIONS/91R34780-3DEC-123A-BE2A-213B5500DFF0/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"
        }
    ]
}

Eis mais detalhes sobre o encaminhamento de registos de recursos:

Operações de dispositivo para cloud duplo

A categoria de operações do dispositivo para a cloud controla os eventos iniciados pelo dispositivo em dispositivos duplos. Estas operações podem incluir obter duplos, atualizar as propriedades comunicadas e subscrever as propriedades pretendidas.

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

Operações de duplos da cloud para o dispositivo

A categoria de operações da cloud para dispositivo duplo monitoriza os eventos iniciados pelo serviço em dispositivos duplos. Estas operações podem incluir obter duplos, atualizar ou substituir etiquetas e atualizar ou substituir as propriedades pretendidas.

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

Consultas de duplos

A categoria de consultas de duplos comunica pedidos de consulta para dispositivos duplos que são iniciados na cloud.

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

Operações de tarefas

A categoria de operações de tarefas reporta pedidos de tarefas para atualizar dispositivos duplos ou invocar métodos diretos em vários dispositivos. Estes pedidos são iniciados na cloud.

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

Métodos Diretos

A categoria métodos diretos controla as interações pedido-resposta enviadas para dispositivos individuais. Estes pedidos são iniciados na cloud.

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

Rastreio Distribuído (Pré-visualização)

A categoria de rastreio distribuído controla os IDs de correlação das mensagens que transportam o cabeçalho de contexto de rastreio. Para ativar totalmente estes registos, o código do lado do cliente tem de ser atualizado ao seguir Analisar e diagnosticar aplicações IoT ponto a ponto com Hub IoT rastreio distribuído (pré-visualização).

O correlationId está em conformidade com a proposta de Contexto de Rastreio W3C , onde contém um trace-id e um span-id.

Hub IoT registos D2C (dispositivo para a cloud)

Hub IoT regista este registo quando uma mensagem que contém propriedades de rastreio válidas chega ao Hub 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"
        }
    ]
}

Aqui, durationMs não é calculado, uma vez que o relógio do Hub IoT pode não estar sincronizado com o relógio do dispositivo, pelo que um cálculo de duração pode ser enganador. Recomendamos que escreva lógica com os carimbos de data/hora na properties secção para capturar picos na latência do dispositivo para a cloud.

Propriedade Tipo Description
messageSize Número inteiro O tamanho da mensagem do dispositivo para a nuvem em bytes
deviceId Cadeia de carateres alfanuméricos de 7 bits ASCII A identidade do dispositivo
callerLocalTimeUtc Carimbo de data/hora UTC A hora de criação da mensagem, conforme comunicado pelo relógio local do dispositivo
calleeLocalTimeUtc Carimbo de data/hora UTC A hora da chegada da mensagem ao gateway do Hub IoT, conforme comunicado pelo relógio do lado do serviço Hub IoT

Hub IoT registos de entrada

Hub IoT regista este registo quando a mensagem que contém propriedades de rastreio válidas escreve nos Hubs de Eventos internos ou incorporados.

{
    "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 Na secção, este registo contém informações adicionais sobre a entrada de mensagens.

Propriedade Tipo Description
isRoutingEnabled String Verdadeiro ou falso, indica se o encaminhamento de mensagens está ou não ativado no Hub IoT
parentSpanId String O span-id da mensagem principal, que seria o rastreio de mensagens D2C neste caso

Hub IoT registos de saída

Hub IoT regista este registo quando o encaminhamento está ativado e a mensagem é escrita num ponto final. Se o encaminhamento não estiver ativado, Hub IoT não grava este registo.

{
    "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 Na secção, este registo contém informações adicionais sobre a entrada de mensagens.

Propriedade Tipo Description
endpointName String O nome do ponto final de encaminhamento
endpointType String O tipo do ponto final de encaminhamento
parentSpanId String O span-id da mensagem principal, que seria o rastreio de mensagens de entrada Hub IoT neste caso

Configurações

Hub IoT os registos de configuração monitorizam os eventos e o erro do conjunto de funcionalidades Gestão de Dispositivos Automático.

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

Fluxos de Dispositivos (Pré-visualização)

A categoria de fluxos de dispositivos monitoriza as interações pedido-resposta enviadas para dispositivos individuais.

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

Tabelas de Registos do Azure Monitor

Esta secção refere-se a todas as tabelas Kusto dos Registos do Azure Monitor relevantes para Hub IoT do Azure e disponíveis para consulta pelo Log Analytics. Para obter uma lista destas tabelas e ligações para obter mais informações sobre o tipo de recurso Hub IoT, veja Hub IoT na referência da tabela Registos do Azure Monitor.

Para obter uma referência de todas as tabelas de Registos do Azure Monitor/Log Analytics, veja Referência da Tabela de Registos do Azure Monitor.

Consulte também