Coletar e transportar métricas

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

Para saber mais sobre o IoT Edge e o IoT Central, confira Conectar dispositivos Azure IoT Edge a um aplicativo 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.

A ID do recurso tem o seguinte formato:

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

É possível encontrar a ID do recurso na página Propriedades do Hub IoT no portal do Azure.

Também é possível recuperá-la 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 IoT Central ao qual o dispositivo IoT Edge pertence. Forneça essa ID como o valor da variável de ambiente ResourceID.

A ID do recurso tem o seguinte formato:

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

É possível encontrar a ID do recurso na página Propriedades do aplicativo IoT Central no portal do Azure.

Também é possível recuperá-la 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 ao Azure Monitor ou ao Hub IoT.

Se você definir UploadTarget como IoTMessage, as métricas do módulo serão publicadas como mensagens de IoT. Essas mensagens são emitidas pelo terminal /messages/modules/<metrics collector module name>/outputs/metricOutput como um JSON codificado em UTF-8. Por exemplo, se o módulo coletor de métricas do IoT Edge for nomeado IoTEdgeMetricsCollector, o ponto de extremidade será /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. A formato funciona da seguinte maneira:

[{
    "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 ao Azure Monitor ou ao IoT Central.

Se você definir UploadTarget como IoTMessage, as métricas do módulo serão publicadas como mensagens de IoT. Essas mensagens são emitidas pelo terminal /messages/modules/<metrics collector module name>/outputs/metricOutput como um JSON codificado em UTF-8. Por exemplo, se o módulo coletor de métricas do IoT Edge for nomeado IoTEdgeMetricsCollector, o ponto de extremidade será /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. A formato funciona da seguinte maneira:

[{
    "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 ao Log Analytics. Por exemplo, ao monitorar dispositivos IoT Edge em uma configuração aninhada em que os dispositivos filhos têm acesso apenas ao hub do IoT Edge do dispositivo pai. Outro exemplo é a implantação de um dispositivo IoT Edge com acesso de rede de saída apenas ao Hub IoT.

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

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

Amostra de fluxo de trabalho de nuvem

Um fluxo de trabalho em nuvem que entrega mensagens de métricas do IoT Hub para o Log Analytics está disponível como parte da amostra de monitoramento e log do IoT Edge. Ela pode ser implantada em recursos de nuvem existentes ou usada 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 ao Log Analytics. Por exemplo, ao monitorar dispositivos IoT Edge em uma configuração aninhada em que os dispositivos filhos têm acesso apenas ao hub do IoT Edge do dispositivo pai. Outro exemplo é a implantação de um dispositivo IoT Edge com acesso de rede de saída apenas ao IoT Central.

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

O manifesto de implantação de exemplo 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 dispositivo IoT Edge no aplicativo IoT Central:

• Adicione a interface padrão Métricas do IoT Edge como uma interface herdada ao modelo de dispositivo:

  

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