Sammeln und Transportieren von Metriken

¹ Derzeit ist der Einsatz von Option 1 für eine direkte Übertragung von Metriken vom IoT Edge-Gerät an Log Analytics der einfachere Weg, bei dem nur ein minimaler Setup-Aufwand erforderlich ist. Die erste Option wird demnach bevorzugt, es sei denn, Ihr spezifisches Szenario erfordert Option 2, bei der das IoT Edge-Gerät nur mit IoT Hub kommuniziert.

Weitere Informationen zu IoT Edge und IoT Central finden Sie unter Verbinden von Azure IoT Edge-Geräten in einer Azure IoT Central-Anwendung.

Das Metrikensammler-Modul benötigt die Azure Resource Manager-ID des IoT Hubs, zu dem das IoT Edge-Gerät gehört. Geben Sie diese ID als Wert für die ResourceID-Umgebungsvariable an.

Die Ressourcen-ID hat das folgende Format:

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

Sie finden die Ressourcen-ID auf der Seite Eigenschaften des IoT Hubs im Azure-Portal.

Oder Sie rufen die ID mit dem Befehl az resource show ab:

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

Für das Metrikensammler-Modul ist die Azure Resource Manager-ID der IoT Central-Anwendung erforderlich, zu der das IoT Edge-Gerät gehört. Geben Sie diese ID als Wert für die ResourceID-Umgebungsvariable an.

Die Ressourcen-ID hat das folgende Format:

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

Sie finden die Ressourcen-ID im Azure-Portal auf der Seite Eigenschaften der IoT Central-Anwendung.

Oder Sie rufen die ID mit dem Befehl az resource show ab:

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

Die Konfigurationsoption UploadTarget steuert, ob Metriken direkt an Azure Monitor oder an IoT Hub gesendet werden.

Wenn Sie UploadTarget auf IoTMessage festlegen, werden Ihre Modulmetriken als IoT-Nachrichten veröffentlicht. Diese Nachrichten werden als UTF8-codierter JSON-Code vom /messages/modules/<metrics collector module name>/outputs/metricOutput-Endpunkt ausgegeben. Wenn Ihr IoT Edge Metrics Collector-Modul beispielsweise den Namen "IoTEdgeMetricsCollector" hat, lautet /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutputder Endpunkt . Das Format ist wie folgt:

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

Die Konfigurationsoption UploadTarget steuert, ob Metriken direkt an Azure Monitor oder an IoT Central gesendet werden.

Wenn Sie UploadTarget auf IoTMessage festlegen, werden Ihre Modulmetriken als IoT-Nachrichten veröffentlicht. Diese Nachrichten werden als UTF8-codierter JSON-Code vom /messages/modules/<metrics collector module name>/outputs/metricOutput-Endpunkt ausgegeben. Wenn Ihr IoT Edge Metrics Collector-Modul beispielsweise den Namen "IoTEdgeMetricsCollector" hat, lautet /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutputder Endpunkt . Das Format ist wie folgt:

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

Manchmal ist es notwendig, Metriken über IoT Hub aufzunehmen, anstatt sie direkt an Log Analytics zu senden. Dies ist z. B. der Fall, wenn Sie IoT Edge-Geräte in einer geschachtelten Konfiguration überwachen, bei der untergeordnete Geräte nur Zugriff auf den IoT Edge-Hub ihres übergeordneten Geräts haben. Ein weiteres Beispiel ist die Bereitstellung eines IoT Edge-Geräts mit ausgehenden Netzwerkzugriff nur auf IoT Hub.

Um die Überwachung in diesem Szenario zu ermöglichen, kann das Metrikensammler-Modul so konfiguriert werden, dass Metriken als D2C-Nachrichten (Device-to-Cloud) über das edgeHub-Modul gesendet werden. Die Funktion wird aktiviert, indem die UploadTarget-Umgebungsvariable bei der Konfiguration des Sammlers auf IoTMessagefestgelegt wird.

Diese Option erfordert zusätzliches Setup, einen Cloudworkflow, um Metrikmeldungen, die beim IoT Hub ankommen, an den Log Analytics-Arbeitsbereich zu übermitteln. Ohne diese Einrichtung funktionieren die anderen Teile der Integration wie kuratierte Visualisierungen und Warnungen nicht.

Beispiel für einen Cloudworkflow

Ein Cloudworkflow, der Metriknachrichten von IoT Hub an Log Analytics übermittelt, ist als Bestandteil des IoT Edge-Protokollierungs- und -Überwachungbeispiels verfügbar. Das Beispiel kann in vorhandenen Cloudressourcen bereitgestellt werden oder als Referenz für eine Produktionsbereitstellung dienen.

Manchmal ist es notwendig, Metriken über IoT Central aufzunehmen, anstatt sie direkt an Log Analytics zu senden. Dies ist z. B. der Fall, wenn Sie IoT Edge-Geräte in einer geschachtelten Konfiguration überwachen, bei der untergeordnete Geräte nur Zugriff auf den IoT Edge-Hub ihres übergeordneten Geräts haben. Ein weiteres Beispiel ist die Bereitstellung eines IoT Edge-Geräts mit ausgehenden Netzwerkzugriff nur auf IoT Central.

Um die Überwachung in diesem Szenario zu ermöglichen, kann das Metrikensammler-Modul so konfiguriert werden, dass Metriken als D2C-Nachrichten (Device-to-Cloud) über das edgeHub-Modul gesendet werden. Die Funktion wird aktiviert, indem die UploadTarget-Umgebungsvariable bei der Konfiguration des Sammlers auf IoTMessagefestgelegt wird.

Das folgende Beispiel eines Bereitstellungsmanifests zeigt die Konfiguration:

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

So zeigen Sie die Metriken von Ihrem IoT Edge-Gerät in Ihrer IoT Central-Anwendung an:

• Fügen Sie die Standardschnittstelle für IoT Edge-Metriken als geerbte Schnittstelle zu Ihrer Gerätevorlage hinzu:

  

• Verwenden Sie die in der Schnittstelle definierten Telemetriewerte zum Erstellen aller Dashboards, die Sie zum Überwachen Ihrer IoT Edge-Geräte benötigen: