Raccogliere e trasportare le metriche

¹ Attualmente, l'uso dell'opzione 1 per il trasporto diretto delle metriche in Log Analytics dal dispositivo IoT Edge è il percorso più semplice che richiede una configurazione minima. La prima opzione è preferibile, a meno che lo scenario specifico non richieda l'approccio dell’opzione 2 in modo che il dispositivo IoT Edge comunichi solo con Hub IoT.

Per altre informazioni su IoT Edge e IoT Central, vedere Connettere dispositivi Azure IoT Edge a un'applicazione Azure IoT Central.

Il modulo metrics-collector richiede l'ID di Azure Resource Manager dell'hub IoT a cui appartiene il dispositivo IoT Edge. Fornire questo ID come valore della variabile di ambiente ResourceID.

Il formato dell’ID è il seguente:

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

L'ID della risorsa si trova nel portale di Azure, nella pagina Proprietà dell’hub IoT.

In alternativa, recuperare l'ID con il comando az resource show:

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

Il modulo metrics-collector richiede l'ID di Azure Resource Manager dell’applicazione IoT Central a cui appartiene il dispositivo IoT Edge. Fornire questo ID come valore della variabile di ambiente ResourceID.

Il formato dell’ID è il seguente:

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

L'ID della risorsa si trova nel portale di Azure, nella pagina Proprietà dell’applicazione IoT Central.

In alternativa, recuperare l'ID con il comando az resource show:

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

L’opzione di configurazione UploadTarget controlla se le metriche vengono inviate direttamente a Monitoraggio di Azure o Hub IoT.

Se si imposta UploadTarget su IoTMessage, le metriche del modulo vengono pubblicate come messaggi IoT. Questi messaggi vengono emessi come json con codifica UTF8 dall'endpoint /messages/modules/<metrics collector module name>/outputs/metricOutput. Ad esempio, se il modulo metrict-collector di IoT Edge è denominato IoTEdgeMetricsCollector, l'endpoint è /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. Il formato è il seguente:

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

L’opzione di configurazione UploadTarget controlla se le metriche vengono inviate direttamente a Monitoraggio di Azure o a IoT Central.

Se si imposta UploadTarget su IoTMessage, le metriche del modulo vengono pubblicate come messaggi IoT. Questi messaggi vengono emessi come json con codifica UTF8 dall'endpoint /messages/modules/<metrics collector module name>/outputs/metricOutput. Ad esempio, se il modulo metrict-collector di IoT Edge è denominato IoTEdgeMetricsCollector, l'endpoint è /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. Il formato è il seguente:

[{
    "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 volte è necessario inserire metriche tramite Hub IoT anziché inviarle direttamente a Log Analytics. Ad esempio, quando si monitorano dispositivi IoT Edge in una configurazione annidata in cui i dispositivi figlio hanno accesso solo all'hub IoT Edge del loro dispositivo padre. Un altro esempio consiste nella distribuzione di un dispositivo IoT Edge con accesso alla rete in uscita solo a Hub IoT.

Per abilitare il monitoraggio in questo scenario, il modulo metrics-collector può essere configurato per l’invio di metriche come messaggi da dispositivo a cloud (D2C) tramite il modulo edgeHub. La funzionalità può essere attivata impostando la variabile di ambiente UploadTarget su IoTMessage nella configurazione dell’agente di raccolta.

Questa opzione richiede una configurazione aggiuntiva, un flusso di lavoro cloud, per consegnare messaggi di metriche in arrivo in Hub IoT all'area di lavoro Log Analytics. Senza questa configurazione, le altre parti dell'integrazione, ad esempio visualizzazioni curate e avvisi, non funzionano.

Flusso di lavoro cloud di esempio

Un flusso di lavoro cloud che consegna messaggi di metriche da Hub IoT a Log Analytics è disponibile come parte dell’esempio di registrazione e monitoraggio di IoT Edge. L'esempio può essere distribuito nelle risorse cloud esistenti o funge da riferimento alla distribuzione di produzione.

A volte è necessario inserire metriche tramite IoT Central anziché inviarle direttamente a Log Analytics. Ad esempio, quando si monitorano dispositivi IoT Edge in una configurazione annidata in cui i dispositivi figlio hanno accesso solo all'hub IoT Edge del loro dispositivo padre. Un altro esempio consiste nella distribuzione di un dispositivo IoT Edge con accesso alla rete in uscita solo a IoT Central.

Per abilitare il monitoraggio in questo scenario, il modulo metrics-collector può essere configurato per l’invio di metriche come messaggi da dispositivo a cloud (D2C) tramite il modulo edgeHub. La funzionalità può essere attivata impostando la variabile di ambiente UploadTarget su IoTMessage nella configurazione dell’agente di raccolta.

Il manifesto di distribuzione di esempio seguente mostra la configurazione:

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

Per visualizzare le metriche dal dispositivo IoT Edge nell'applicazione IoT Central:

• Aggiungere l’interfaccia standard delle metriche di IoT Edge come interfaccia ereditata al modello di dispositivo:

  

• Usare i valori di telemetria definiti nell'interfaccia per compilare tutti i dashboard necessari per monitorare i dispositivi IoT Edge: