Mengumpulkan dan membawa metrik

¹ Saat ini, menggunakan opsi 1 untuk langsung memindahkan metrik ke Analitik Log dari perangkat IoT Edge adalah jalur yang lebih sederhana yang memerlukan pengaturan minimal. Opsi pertama lebih disukai, kecuali skenario spesifik Anda menuntut pendekatan opsi 2 sehingga perangkat IoT Edge hanya berkomunikasi dengan IoT Hub.

Untuk mempelajari lebih lanjut tentang IoT Edge dan IoT Central, lihat Sambungkan perangkat Azure IoT Edge ke aplikasi Azure IoT Central.

Modul pengumpul metrik memerlukan ID Azure Resource Manager dari IoT hub yang dimiliki perangkat IoT Edge. Berikan ID ini sebagai nilai variabel lingkungan ResourceID.

ID sumber daya mengambil format berikut:

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

Anda dapat menemukan ID sumber daya di halaman Properti IoT hub di portal Microsoft Azure.

Atau, ambil ID dengan perintah az resource show:

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

Modul pengumpul metrik memerlukan ID Azure Resource Manager dari aplikasi IoT Central yang dimiliki perangkat IoT Edge. Berikan ID ini sebagai nilai variabel lingkungan ResourceID.

ID sumber daya mengambil format berikut:

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

Anda dapat menemukan ID sumber daya di halaman Properti aplikasi IoT Central di portal Microsoft Azure.

Atau, ambil ID dengan perintah az resource show:

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

Opsi konfigurasi UploadTarget mengontrol apakah metrik dikirim langsung ke Azure Monitor atau ke IoT Hub.

Jika Anda mengatur UploadTarget ke IoTMessage, maka metrik modul Anda akan diterbitkan sebagai pesan IoT. Pesan ini dimunculkan sebagai json yang dienkode UTF8 dari titik akhir /messages/modules/<metrics collector module name>/outputs/metricOutput. Misalnya, jika modul Pengumpul Metrik IoT Edge Anda diberi nama IoTEdgeMetricsCollector, titik akhirnya adalah /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. Formatnya sebagai berikut:

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

Opsi konfigurasi UploadTarget mengontrol apakah metrik dikirim langsung ke Azure Monitor atau ke IoT Central.

Jika Anda mengatur UploadTarget ke IoTMessage, maka metrik modul Anda akan diterbitkan sebagai pesan IoT. Pesan ini dimunculkan sebagai json yang dienkode UTF8 dari titik akhir /messages/modules/<metrics collector module name>/outputs/metricOutput. Misalnya, jika modul Pengumpul Metrik IoT Edge Anda diberi nama IoTEdgeMetricsCollector, titik akhirnya adalah /messages/modules/IoTEdgeMetricsCollector/outputs/metricOutput. Formatnya sebagai berikut:

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

Terkadang perlu untuk menyerap metrik melalui IoT Hub alih-alih mengirimkannya langsung ke Analitik Log. Misalnya, saat memantau perangkat IoT Edge di konfigurasi bertumpuk di mana perangkat anak hanya memiliki akses ke hub IoT Edge dari perangkat induknya. Contoh lain adalah saat menyebarkan perangkat IoT Edge dengan akses jaringan keluar hanya ke IoT Hub.

Untuk mengaktifkan pemantauan dalam skenario ini, modul pengumpulan metrik dapat dikonfigurasi untuk mengirim metrik sebagai pesan perangkat ke cloud (device-to-cloud/D2C) melalui modul edgeHub. Kemampuan ini dapat diaktifkan dengan mengatur variabel lingkungan UploadTarget ke IoTMessage dalam konfigurasi pengumpul.

Opsi ini memang memerlukan penyiapan tambahan, alur kerja cloud, untuk mengirimkan pesan metrik yang tiba di IoT Hub ke ruang kerja Analitik Log. Tanpa pengaturan ini, bagian lain dari integrasi seperti visualisasi dan pemberitahuan yang dikumpulkan tidak berfungsi.

Sampel alur kerja cloud

Alur kerja cloud yang mengirimkan pesan metrik dari IoT Hub ke Analitik Log tersedia sebagai bagian dari sampel pengelogan dan pemantauan IoT Edge. Sampel dapat disebarkan ke sumber daya cloud yang ada atau berfungsi sebagai referensi penyebaran produksi.

Terkadang perlu untuk menyerap metrik melalui IoT Central alih-alih mengirimkannya langsung ke Analitik Log. Misalnya, saat memantau perangkat IoT Edge di konfigurasi bertumpuk di mana perangkat anak hanya memiliki akses ke hub IoT Edge dari perangkat induknya. Contoh lain adalah saat menyebarkan perangkat IoT Edge dengan akses jaringan keluar hanya ke IoT Central.

Untuk mengaktifkan pemantauan dalam skenario ini, modul pengumpulan metrik dapat dikonfigurasi untuk mengirim metrik sebagai pesan perangkat ke cloud (device-to-cloud/D2C) melalui modul edgeHub. Kemampuan ini dapat diaktifkan dengan mengatur variabel lingkungan UploadTarget ke IoTMessage dalam konfigurasi pengumpul.

Contoh manifes penyebaran berikut menunjukkan konfigurasi:

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

Untuk melihat metrik dari perangkat IoT Edge Anda di aplikasi IoT Central Anda:

• Tambahkan antarmuka standar IoT Edge Metrics sebagai antarmuka bawaan ke templat perangkat Anda:

  

• Gunakan nilai telemetri yang ditetapkan dalam antarmuka untuk membangun dasbor apa pun yang Anda perlukan untuk memonitor perangkat IoT Edge: