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 de plataforma coletadas automaticamente para este serviço. Essas métricas também fazem parte da lista global de todas as métricas de plataforma com suporte no Azure Monitor.

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

Métricas suportadas 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 visualizar todas as colunas disponíveis.

Cabeçalhos de tabela

• Categoria - O grupo ou classificação de métricas.
• Métrica - O nome para exibição da métrica conforme aparece no portal do Azure.
• Nome na API REST - O nome da métrica conforme referido na API REST.
• Unidade - Unidade de medida.
• Agregação - O tipo de agregação padrão. Valores válidos: Média (Média), Mínima (Mín), Máxima (Máx), Total (Soma), Contagem.
• Dimensões - Dimensões disponíveis para a métrica.
• Intervalos de grãos de - tempo 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.
• DS Export- Se a métrica é exportável para os Logs do Azure Monitor por meio de configurações de diagnóstico. Para obter informações sobre como exportar métricas, consulte 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 Unidade de Contagem, 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) toda vez que a operação medida ocorre. Em seguida, o Azure Monitor soma esses 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 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. Estes valores são sempre 1.

• Para métricas de contagem de instantâneos , o Hub IoT registra uma contagem total quando a operação medida ocorre. Atualmente, existem 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 sempre uma quantidade "total", somá-las sobre a 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 métricas

Para obter informações sobre o que são dimensões métricas, consulte Métricas multidimensionais.

Este serviço tem as seguintes dimensões associadas às suas métricas.

Nome de exibição e agregação de 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 Hub IoT por categoria geral e listam métricas por seu nome para exibição, conforme atribuído no portal do Azure.

Métricas de comando da nuvem para o dispositivo:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

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

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas de operações gêmeas de nuvem para dispositivo:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas de configurações:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas de cotas diárias:

Para o número total de mensagens usadas, há suporte apenas para agregações mínimas, máximas e médias. Para obter mais informações, consulte Agregações suportadas.

Métricas do dispositivo:

Para Dispositivos totais (obsoletos) e Dispositivos conectados (obsoletos), apenas 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 suportadas.

Para dispositivos totais e dispositivos conectados, apenas as agregações mínimas, máximas e médias são válidas. Para obter mais informações, consulte Agregações suportadas.

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

Métricas de telemetria do dispositivo:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas de operações gêmeas de dispositivo para nuvem:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas da grade de eventos:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas de trabalho:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas de roteamento:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Métricas de consulta gêmeas:

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 sempre retornam 1. Para obter mais informações, consulte Agregações suportadas.

Registos do recurso

Esta seção lista os tipos de logs de recursos que você pode coletar para 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 suportados para Microsoft.Devices/IotHubs

As seções a seguir listam os tipos de categoria de log de recursos e 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 nuvem-para-dispositivo rastreia erros que ocorrem no hub IoT e estão relacionados ao pipeline de mensagens nuvem-para-dispositivo. Esta categoria inclui erros que ocorrem de:

• Envio de mensagens da nuvem para o dispositivo (como erros de remetente não autorizado),
• Receber mensagens da nuvem para o dispositivo (como erros de contagem de entregas excedidos) e
• Receber feedback de mensagens da nuvem para o dispositivo (como erros de feedback expirados).

Esta categoria não deteta erros quando a mensagem da nuvem para o dispositivo é entregue com êxito, mas depois manipulada 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 gêmeas da nuvem para o dispositivo rastreia eventos iniciados pelo serviço em gêmeos de dispositivo. Essas operações podem incluir obter gêmeos, atualizar ou substituir tags 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 gêmeas de dispositivo para nuvem

A categoria de operações de gêmeos de dispositivo para nuvem rastreia eventos iniciados por dispositivo em gêmeos de dispositivo. Essas operações podem incluir obter gêmeos, 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 de configurações

Os logs de configuração do Hub IoT rastreiam eventos e erros para o conjunto de recursos de 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 e erros. Esta categoria é útil para identificar tentativas de conexão não autorizadas e/ou alertar quando você perde a conexão com dispositivos.

Para obter um estado de ligação fiável dos dispositivos, consulte 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 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 de dispositivo rastreia erros que ocorrem quando você tenta criar, atualizar ou excluir uma entrada no registro de identidade do hub IoT. O acompanhamento dessa 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 dispositivos (visualização)

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

Categoria de telemetria do dispositivo

A categoria de telemetria de dispositivo rastreia erros que ocorrem no hub IoT e estão relacionados ao pipeline de telemetria. Esta categoria inclui erros que ocorrem ao enviar eventos de telemetria (como limitação) e ao receber eventos de telemetria (como leitor não autorizado). Esta categoria não pode detetar erros causados por 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 rastreia as interações solicitação-resposta enviadas para 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 rastreio distribuído (pré-visualização)

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 rastreamento distribuído do Hub IoT (visualização).

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

Logs do Hub IoT D2C (do dispositivo para a nuvem)

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

Aqui, não é calculado, durationMs pois o relógio do Hub IoT pode não estar em sincronia com o relógio do dispositivo e, portanto, um cálculo de duração pode ser enganoso. Recomendamos escrever lógica usando os carimbos de data/hora na seção para capturar picos de latência do dispositivo para a properties nuvem.

Logs de entrada do Hub IoT

O Hub IoT registra esse log quando uma mensagem contendo propriedades de rastreamento válidas grava 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 carregamento de ficheiros

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

• Erros que ocorrem com o URI SAS, como quando ele expira antes que um dispositivo notifique o hub de um carregamento concluído.
• Carregamentos 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.

Esta categoria não pode detetar 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 trabalho

A categoria de operações de trabalhos relata solicitações de trabalho para atualizar gêmeos de dispositivo 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. Esta categoria inclui eventos como:

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

Esta categoria não inclui erros específicos sobre as próprias mensagens (como erros de limitação do dispositivo), 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 o roteamento de logs de recursos:

• Lista de códigos de erro do 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 gêmeos de dispositivo 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 as tabelas de Logs do Azure Monitor relevantes para este serviço, que estão disponíveis para consulta pelo Log Analytics usando consultas 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

Registo 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 possíveis do provedor de recursos no log de atividades.

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

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

Conteúdos relacionados

• Consulte Monitorar o Hub IoT do Azure para obter uma descrição do monitoramento do Hub IoT.
• Consulte Monitorar recursos do Azure com o Azure Monitor para obter detalhes sobre o monitoramento de recursos do Azure.