Coletar e transportar métricas

1 Atualmente, usar a opção 1 para transportar métricas diretamente para o Log Analytics a partir do dispositivo IoT Edge é o caminho mais simples que requer configuração mínima. A primeira opção é preferida, a menos que seu cenário específico exija a abordagem da opção 2 para que o dispositivo IoT Edge se comunique apenas com o Hub IoT.

Para saber mais sobre o IoT Edge e o IoT Central, consulte Conectar dispositivos do Azure IoT Edge a um aplicativo do Azure IoT Central.

O módulo coletor de métricas requer a ID do Azure Resource Manager do hub IoT ao qual o dispositivo IoT Edge pertence. Forneça essa ID como o valor da variável de ambiente ResourceID .

O ID do recurso tem o seguinte formato:

/subscriptions/<subscription id>/resourceGroups/<resource group name>/providers/Microsoft.Devices/IoTHubs/<iot hub name>

Você pode encontrar a ID do recurso na página Propriedades do hub IoT no portal do Azure.

Ou, você recupera o ID com o comando az resource show :

az resource show -g <resource group> -n <hub name> --resource-type "Microsoft.Devices/IoTHubs"

O módulo coletor de métricas requer a ID do Azure Resource Manager do aplicativo IoT Central ao qual o dispositivo IoT Edge pertence. Forneça essa ID como o valor da variável de ambiente ResourceID .

O ID do recurso tem o seguinte formato:

/subscriptions/<subscription id>/resourceGroups/<resource group name>/providers/Microsoft.IoTCentral/IoTApps/<iot central app name>

Você pode encontrar a ID do recurso na página Propriedades do aplicativo IoT Central no portal do Azure.

Ou, você recupera o ID com o comando az resource show :

az resource show -g <resource group> -n <application name> --resource-type "Microsoft.IoTCentral/IoTApps"

A opção de configuração UploadTarget controla se as métricas são enviadas diretamente para o Azure Monitor ou para o Hub IoT.

Se você definir UploadTarget como IoTMessage, as métricas do módulo serão publicadas como mensagens IoT. Essas mensagens são emitidas como json codificado em UTF8 do ponto de extremidade /messages/modules/<metrics collector module name>/outputs/metricOutput. Por exemplo, se o módulo IoT Edge Metrics Collector for chamado IoTEdgeMetricsCollector, o ponto de extremidade será /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. O formato é o seguinte:

[{
    "TimeGeneratedUtc": "<time generated>",
    "Name": "<prometheus metric name>",
    "Value": <decimal value>,
    "Label": {
        "<label name>": "<label value>"
    }
}, {
    "TimeGeneratedUtc": "2020-07-28T20:00:43.2770247Z",
    "Name": "docker_container_disk_write_bytes",
    "Value": 0.0,
    "Label": {
        "name": "AzureMonitorForIotEdgeModule"
    }
}]

A opção de configuração UploadTarget controla se as métricas são enviadas diretamente para o Azure Monitor ou para o IoT Central.

Se você definir UploadTarget como IoTMessage, as métricas do módulo serão publicadas como mensagens IoT. Essas mensagens são emitidas como json codificado em UTF8 do ponto de extremidade /messages/modules/<metrics collector module name>/outputs/metricOutput. Por exemplo, se o módulo IoT Edge Metrics Collector for chamado IoTEdgeMetricsCollector, o ponto de extremidade será /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. O formato é o seguinte:

[{
    "TimeGeneratedUtc": "<time generated>",
    "Name": "<prometheus metric name>",
    "Value": <decimal value>,
    "Label": {
        "<label name>": "<label value>"
    }
}, {
    "TimeGeneratedUtc": "2020-07-28T20:00:43.2770247Z",
    "Name": "docker_container_disk_write_bytes",
    "Value": 0.0,
    "Label": {
        "name": "AzureMonitorForIotEdgeModule"
    }
}]

Às vezes, é necessário ingerir métricas por meio do Hub IoT em vez de enviá-las diretamente para o Log Analytics. Por exemplo, ao monitorar dispositivos IoT Edge em uma configuração aninhada em que os dispositivos filho têm acesso apenas ao hub IoT Edge de seu dispositivo pai. Outro exemplo é ao implantar um dispositivo IoT Edge com acesso de rede de saída apenas ao Hub IoT.

Para habilitar o monitoramento nesse cenário, o módulo coletor de métricas pode ser configurado para enviar métricas como mensagens de dispositivo para nuvem (D2C) por meio do módulo edgeHub. O recurso pode ser ativado definindo a UploadTarget variável de ambiente como IoTMessage na configuração do coletor.

Essa opção requer configuração extra, um fluxo de trabalho na nuvem, para entregar mensagens de métricas que chegam ao Hub IoT para o espaço de trabalho do Log Analytics. Sem essa configuração, as outras partes da integração, como visualizações selecionadas e alertas, não funcionam.

Exemplo de fluxo de trabalho na nuvem

Um fluxo de trabalho na nuvem que fornece mensagens de métricas do Hub IoT para o Log Analytics está disponível como parte do exemplo de registro e monitoramento do IoT Edge. O exemplo pode ser implantado em recursos de nuvem existentes ou servir como uma referência de implantação de produção.

Às vezes, é necessário ingerir métricas por meio do IoT Central em vez de enviá-las diretamente para o Log Analytics. Por exemplo, ao monitorar dispositivos IoT Edge em uma configuração aninhada em que os dispositivos filho têm acesso apenas ao hub IoT Edge de seu dispositivo pai. Outro exemplo é ao implantar um dispositivo IoT Edge com acesso de rede de saída apenas ao IoT Central.

Para habilitar o monitoramento nesse cenário, o módulo coletor de métricas pode ser configurado para enviar métricas como mensagens de dispositivo para nuvem (D2C) por meio do módulo edgeHub. O recurso pode ser ativado definindo a UploadTarget variável de ambiente como IoTMessage na configuração do coletor.

O exemplo de manifesto de implantação a seguir mostra a configuração:

{
  "modulesContent": {
    "$edgeAgent": {
      "properties.desired": {
        "schemaVersion": "1.0",
        "runtime": {
          "type": "docker",
          "settings": {
            "minDockerVersion": "v1.25",
            "loggingOptions": "",
            "registryCredentials": {}
          }
        },
        "systemModules": {
          "edgeAgent": {
            // ...
          },
          "edgeHub": {
            // ...
          }
        },
        "modules": {
          "SimulatedTemperatureSensor": {
            // ...
          },
          "AzureMonitorForIotEdgeModule": {
            "settings": {
                "image": "mcr.microsoft.com/azureiotedge-metrics-collector:1.0",
                "createOptions": "{\"HostConfig\":{\"LogConfig\":{\"Type\":\"json-file\",\"Config\":{\"max-size\":\"4m\",\"max-file\":\"7\"}}}}"
            },
            "type": "docker",
            "env": {
              "UploadTarget": {
                "value": "IotMessage"
              },
              "ResourceId": {
                "value": "/subscriptions/{your subscription id}/IOTC/providers/Microsoft.IoTCentral/IoTApps/{your app name}"
              },
              "MetricsEndpointsCSV": {
                "value": "http://edgeHub:9600/metrics,http://edgeAgent:9600/metrics"
              },
              "ScrapeFrequencyInSecs": {
                "value": "30"
              },
              "AllowedMetrics": {
                "value": ""
              },
              "BlockedMetrics": {
                "value": ""
              },
              "CompressForUpload": {
                "value": "false"
              },
              "TransformForIoTCentral": {
                "value": "true"
              }
            },
            "status": "running",
            "restartPolicy": "always",
            "version": "1.0"
          }
        }
      }
    },
    "$edgeHub": {
      "properties.desired": {
        "schemaVersion": "1.0",
        "routes": {
          "temperatureupload": "FROM /messages/modules/SimulatedTemperatureSensor/outputs/temperatureOutput INTO $upstream",
          "metricupload": "FROM /messages/modules/AzureMonitorForIotEdgeModule/outputs/metricOutput INTO $upstream"
        },
        "storeAndForwardConfiguration": {
          "timeToLiveSecs": 7200
        }
      }
    },
    "SimulatedTemperatureSensor": {
      // ...
    },
    "AzureMonitorForIotEdgeModule": {
      "properties.desired": {
        "schemaVersion": "1.0",
        "scrapeFrequencySecs": 30,
        "metricsFormat": "Json",
        "syncTarget": "IoTHub"
      }
    }
  }
}

Para visualizar as métricas do seu dispositivo IoT Edge no seu aplicativo IoT Central:

• Adicione a interface padrão do IoT Edge Metrics como uma interface herdada ao seu modelo de dispositivo:

  

• Use os valores de telemetria definidos na interface para criar os painéis necessários para monitorar seus dispositivos IoT Edge: