Referência de dados de monitoramento do Hub IoT do Azure

Este artigo contém todas as informações de referência de monitoramento para este serviço.

Consulte Monitorar o Azure IoT para obter detalhes sobre os dados que você pode coletar para o Hub IoT e como usá-los.

Métricas

Esta seção lista todas as métricas da plataforma coletadas automaticamente para este serviço. Essas métricas também fazem parte da lista global de todas as métricas da plataforma com suporte no Azure Monitor.

Para obter informações sobre retenção de métricas, consulte Visão geral das métricas do Azure Monitor.

Métricas com suporte para Microsoft.Devices/IoTHubs

A tabela a seguir lista as métricas disponíveis para o tipo de recurso Microsoft.Devices/IoTHubs.

• Nem todas as colunas podem estar presentes em todas as tabelas.
• Algumas colunas podem estar além da área de visualização da página. Selecione Expandir tabela para exibir todas as colunas disponíveis.

Títulos de tabela

• Categoria: o grupo ou classificação de métricas.
• Métrica: o nome de exibição da métrica como aparece no portal do Azure.
• Nome na API REST: o nome da métrica, conforme mencionado na API REST.
• Unidade: unidade de medida
• Agregação – o tipo de agregação padrão. Valores válidos: Médio (Méd.), Mínimo (Mín.), Máximo (Máx.), Total (Soma), Contagem.
• Dimensões - Dimensões disponíveis para a métrica.
• Intervalos de agregação: os - em que a métrica é amostrada. Por exemplo, PT1M indica que a métrica é amostrada a cada minuto, PT30M a cada 30 minutos, PT1H a cada hora e assim por diante.
• Exportação de DS: se a métrica é exportável para os Logs do Azure Monitor via configurações de diagnóstico. Para obter mais informações sobre exportação de métricas, consulte as Criar configurações de diagnóstico no Azure Monitor.

Agregações suportadas

A coluna Tipo de Agregação na tabela corresponde à agregação padrão usada quando a métrica é selecionada para um gráfico ou alerta.

Para a maioria das métricas, todos os tipos de agregação são válidos. Para métricas de contagem com um valor de coluna Unit de Count, apenas algumas agregações são válidas. As métricas de contagem podem ser de dois tipos:

• Para métricas de contagem de ponto único , o Hub IoT registra um único ponto de dados (essencialmente um 1) sempre que a operação medida ocorre. Em seguida, o Azure Monitor soma esses pontos de dados na granularidade especificada. Exemplos de métricas de ponto único são mensagens de telemetria enviadas e entregas de mensagens C2D concluídas. Para essas métricas, o único tipo de agregação relevante é Total (Soma). O portal permite que você escolha mínimo, máximo e médio. Esses valores são sempre 1.

• Para métricas de contagem de instantâneos , o Hub IoT registra uma contagem total quando ocorre a operação medida. Atualmente, há três métricas de instantâneo emitidas pelo Hub IoT: número total de mensagens usadas, total de dispositivos e dispositivos conectados. Como essas métricas apresentam uma quantidade "total" todas as vezes, somá-las na granularidade especificada não faz sentido. O Azure Monitor limita você a selecionar média, mínimo e máximo para o tipo de agregação para essas métricas.

Dimensões de métrica

Para obter mais informações sobre o que são dimensões de métrica, confira Métricas multidimensionais.

Este serviço tem as dimensões a seguir associadas a essas métricas.

Nome de exibição e agregação das métricas

As tabelas a seguir fornecem mais informações sobre as métricas descritas na tabela anterior. Eles mostram as métricas da plataforma do Hub IoT por categoria geral e listam as métricas por seu nome de exibição, conforme atribuído no portal do Azure.

Métricas de comando da nuvem para o dispositivo:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de métodos diretos da nuvem para o dispositivo:

Para métricas com um valor de Unidade de Contagem , somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de operações da nuvem para o dispositivo gêmeo:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de configurações:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de cota diária:

Para Número total de mensagens usadas, somente agregações mínimas, máximas e médias são suportadas. Para obter mais informações, consulte Agregações com suporte.

Métricas do dispositivo:

Para Total de dispositivos (preterido) e Dispositivos conectados (preterido), somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Para dispositivos totais e dispositivos conectados, somente as agregações mínima, máxima e média são válidas. Para obter mais informações, consulte Agregações com suporte.

O total de dispositivos e os dispositivos conectados não podem ser exportados por meio das configurações de diagnóstico.

Métricas de telemetria do dispositivo:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de operações do dispositivo para o gêmeo da nuvem:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas da Grade de Eventos:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de trabalhos:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de roteamento:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Métricas de consulta gêmea:

Para métricas com um valor de Unidade de Contagem, somente a agregação total (soma) é válida. As agregações mínimas, máximas e médias sempre retornam 1. Para obter mais informações, consulte Agregações com suporte.

Logs de recursos

Esta seção lista os tipos de logs de recursos que você pode coletar para o este serviço. A seção extrai da lista de todos os tipos de categoria de logs de recursos com suporte no Azure Monitor.

Logs de recursos com suporte para Microsoft.Devices/IotHubs

As seções a seguir listam os tipos de categoria de log de recursos e os esquemas coletados para o Hub IoT do Azure. Os eventos são emitidos apenas para erros em algumas categorias.

Categoria de comandos da nuvem para o dispositivo

A categoria de comandos de nuvem para dispositivo rastreia erros que ocorrem no hub IoT e estão relacionados ao pipeline de mensagens da nuvem para o dispositivo. Essa categoria inclui erros que ocorrem de:

• Envio de mensagens da nuvem para o dispositivo (como erros de remetente não autorizados),
• Receber mensagens da nuvem para o dispositivo (como erros de contagem de entrega excedida) e
• Recebendo feedback de mensagens da nuvem para o dispositivo (como erros de feedback expirado).

Essa categoria não captura erros quando a mensagem da nuvem para o dispositivo é entregue com êxito, mas tratada 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"
        }
    ]
}

Categoria de operações gêmeas da nuvem para o dispositivo

A categoria de operações de gêmeo de nuvem para dispositivo rastreia eventos iniciados pelo serviço em dispositivos gêmeos. Essas operações podem incluir obter gêmeo digital, atualizar ou substituir etiquetas, e atualizar ou substituir as propriedades desejadas.

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

Categoria de operações de gêmeo do dispositivo para a nuvem

A categoria de operações do dispositivo para a nuvem gêmeo rastreia eventos iniciados pelo dispositivo em dispositivos gêmeos. Essas operações podem incluir obter gêmeo, atualizar propriedades relatadas e assinar as propriedades desejadas.

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

Categoria Configurações

Os logs de configuração do Hub IoT rastreiam eventos e erros para o conjunto de recursos do Gerenciamento Automático de Dispositivos.

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

Categoria Conexões

A categoria de conexões rastreia eventos de conexão e desconexão de dispositivos de um hub IoT, assim como erros. Essa categoria é útil para identificar tentativas de conexão não autorizadas e/ou alertar quando você perde a conexão com dispositivos.

Para obter o status de conexão confiável dos dispositivos, consulte Monitorar o status da conexã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 como usar logs de conexões para monitorar a conectividade do dispositivo, consulte Monitorar, diagnosticar e solucionar problemas de conectividade do dispositivo com o Hub IoT do Azure.

Categoria de operações de identidade do dispositivo

A categoria de operações de identidade do dispositivo rastreia erros que ocorrem quando você tenta criar, atualizar ou excluir uma entrada no registro de identidade do hub IoT. Acompanhar essa categoria é útil para cenários de provisionamento.

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

Categoria de fluxos de dispositivo (versão prévia)

A categoria de fluxos de dispositivos rastreia as interações de solicitação-resposta enviadas a 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"
         }
    ]
}

Categoria de telemetria do dispositivo

A categoria de telemetria do dispositivo rastreia erros que ocorrem no hub IoT e estão relacionados ao pipeline de telemetria. Essa categoria inclui erros que ocorrem ao enviar eventos de telemetria (como limitação) e ao receber eventos de telemetria (como acesso não autorizado). Essa categoria não pode capturar 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"
        }
    ]
}

Categoria de métodos diretos

A categoria de métodos diretos acompanha as interações solicitação-resposta enviadas a dispositivos individuais. Essas solicitações são iniciadas na nuvem.

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

Categoria de rastreamento distribuído (versão prévia)

A categoria de rastreamento distribuído rastreia as IDs de correlação para mensagens que carregam o cabeçalho de contexto de rastreamento. Para habilitar totalmente esses logs, o código do lado do cliente deve ser atualizado seguindo Analisar e diagnosticar aplicativos IoT de ponta a ponta com o rastreamento distribuído do Hub IoT (versão prévia).

O está correlationId em conformidade com a proposta do W3C Trace Context , onde contém um trace-id e um span-id.

Logs D2C (dispositivo para nuvem) do Hub IoT

O Hub IoT registra esse log quando uma mensagem contendo propriedades de rastreamento 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"
        }
    ]
}

Logs de entrada do Hub IoT

O Hub IoT registra esse log quando a mensagem que contém propriedades de rastreamento válidas é gravada em Hubs de Eventos internos ou internos.

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

Na seção, esse log contém informações adicionais sobre a properties entrada de mensagens.

Logs de saída do Hub IoT

O Hub IoT registra esse log quando o roteamento está habilitado e a mensagem é gravada em um ponto de extremidade. Se o roteamento não estiver habilitado, o Hub IoT não registrará esse log.

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

Na seção, esse log contém informações adicionais sobre a properties entrada de mensagens.

Categoria de operações de upload de arquivo

A categoria de upload de arquivo rastreia erros que ocorrem no hub IoT e estão relacionados à funcionalidade de upload de arquivo. Esta categoria inclui:

• Erros que ocorrem com o URI SAS, como quando ele expira antes de um dispositivo notificar o hub sobre um upload concluído.
• Envios com falha relatados pelo dispositivo.
• Erros que ocorrem quando um arquivo não é encontrado no armazenamento durante a criação da mensagem de notificação do Hub IoT.

Essa categoria não pode capturar erros que ocorrem diretamente enquanto o dispositivo está carregando um arquivo 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"
        }
    ]
}

Categoria de operações de trabalhos

A categoria de operações de trabalho relata solicitações de trabalho para atualizar dispositivos gêmeos ou invocar métodos diretos em vários dispositivos. Essas solicitações são iniciadas na nuvem.

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

Categoria de rotas

A categoria de roteamento de mensagens rastreia erros que ocorrem durante a avaliação da rota de mensagens e a integridade do ponto de extremidade, conforme percebido pelo Hub IoT. Essa categoria inclui eventos como:

• Uma regra é avaliada como "indefinida"
• Hub IoT marca um ponto de extremidade como morto
• Quaisquer erros recebidos de um ponto de extremidade

Essa categoria não inclui erros específicos sobre as mensagens em si (como erros de limitação de dispositivos), que são relatados na categoria "telemetria do dispositivo".

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

Aqui estão mais detalhes sobre logs de recursos de roteamento:

• Lista de códigos de erro de log de recursos de roteamento
• Lista de logs de recursos de roteamento operationNames

Categoria de consultas gêmeas

A categoria de consultas gêmeas relata solicitações de consulta para dispositivos gêmeos iniciados na nuvem.

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

Tabelas de Logs do Azure Monitor

Esta seção lista todas as tabelas dos Logs do Azure Monitor relevantes para este serviço e disponíveis para consulta pela análise de logs usando o Kusto. As tabelas contêm dados de log de recursos e possivelmente mais, dependendo do que é coletado e roteado para elas.

IoT Hub Microsoft.Devices/IotHubs

• AzureActivity
• AzureMetrics
• AzureDiagnostics
• IoTHubDistributedTracing
• InsightsMetrics

Log de atividades

A tabela vinculada lista as operações que podem ser registradas no log de atividades desse serviço. Essas operações são um subconjunto de todas as operações do provedor de recursos possíveis no log de atividades.

Para obter mais informações sobre o esquema de entradas do log de atividades, confira Esquema do log de atividades.

• Operações do provedor de recursos Microsoft.Devices

Conteúdo relacionado

• Consulte Monitorar o Hub IoT do Azure para obter uma descrição do monitoramento do Hub IoT.
• Confira Monitorar recursos do Azure com o Azure Monitor para ver informações detalhadas sobre o monitoramento dos recursos do Azure.