Menambahkan metrik kustom

  • Artikel

Berlaku untuk:Tanda centang IoT Edge 1.5 IoT Edge 1.5 Tanda centang IoT Edge 1.4 IoT Edge 1.4

Penting

IoT Edge 1.5 LTS dan IoT Edge 1.4 LTS adalah rilis yang didukung. IoT Edge 1.4 LTS adalah akhir masa pakai pada 12 November 2024. Jika Anda menggunakan rilis sebelumnya, lihat Memperbarui IoT Edge.

Kumpulkan metrik khusus dari modul IoT Edge Anda selain metrik bawaan yang menyediakan modul sistem. Metrik bawaan memberikan visibilitas dasar yang bagus ke dalam kesehatan penyebaran Anda. Namun, Anda mungkin memerlukan informasi tambahan dari modul kustom untuk menyelesaikan gambar. Modul kustom dapat diintegrasikan ke dalam solusi pemantauan Anda dengan menggunakan pustaka klien Prometheus yang sesuai untuk memancarkan metrik. Informasi tambahan ini dapat mengaktifkan tampilan atau peringatan baru khusus untuk kebutuhan Anda.

Repositori modul sampel

Lihat repo sampel azure untuk contoh modul kustom yang diinstrumenkan untuk memancarkan metrik. Bahkan jika sampel dalam bahasa pilihan Anda belum tersedia, pendekatan umum dapat membantu Anda.

Konvensi penamaan

Konsultasikan praktik terbaik dari dokumen Prometheus untuk panduan umum. Rekomendasi tambahan berikut ini dapat membantu skenario IoT Edge.

  • Sertakan nama modul di awal nama metrik untuk memperjelas modul mana yang telah memancarkan metrik.

  • Sertakan nama hub IoT atau nama aplikasi IoT Central, ID perangkat IoT Edge, dan ID modul sebagai label (juga disebut tag/dimensi)di setiap metrik. Informasi ini tersedia sebagai variabel lingkungan untuk setiap modul yang dimulai oleh agen IoT Edge. Pendekatan tersebut ditunjukkan oleh contoh dalam sampel repo. Tanpa konteks ini, tidak mungkin untuk mengaitkan nilai metrik tertentu ke perangkat tertentu.

  • Sertakan ID instans dalam label. ID instans dapat menjadi ID unik seperti GUID yang dihasilkan selama startup modul. Informasi ID instans dapat membantu menyesuaikan hidupkan ulang modul saat memproses metrik modul di backend.

Mengonfigurasi kolektor metrik untuk mengumpulkan metrik kustom

Setelah modul kustom memancarkan metrik, langkah selanjutnya adalah mengonfigurasi modul kolektor metrik untuk mengumpulkan dan mengangkut metrik kustom.

Variabel lingkungan MetricsEndpointsCSV harus diperbarui untuk menyertakan URL titik akhir metrik modul kustom. Saat memperbarui variabel lingkungan, pastikan untuk menyertakan titik akhir modul sistem seperti yang ditunjukkan dalam contoh konfigurasi kolektor metrik.

Catatan

Secara default, titik akhir metrik modul kustom tidak perlu dipetakan ke port host untuk memungkinkan kolektor metrik mengaksesnya. Kecuali secara eksplisit ditimpa, di Linux, kedua modul dimulai pada jaringan jembatan Docker yang ditentukan pengguna bernama azure-iot-edge.

Jaringan Docker yang ditentukan pengguna mencakup pemecah masalah DNS default yang memungkinkan komunikasi antar-modul menggunakan nama modul (kontainer). Misalnya, jika modul kustom bernama module1 memancarkan metrik pada port http 9600 di path /metrics, kolektor harus dikonfigurasi untuk mengumpulkan dari endpoint http://module1:9600/metrics.

Jalankan perintah berikut pada perangkat IoT Edge untuk menguji apakah metrik yang dipancarkan oleh modul kustom pada port http 9600 di path /metrics dapat diakses:

sudo docker exec replace-with-metrics-collector-module-name curl http://replace-with-custom-module-name:9600/metrics

Menambahkan visualisasi kustom

Setelah menerima metrik kustom di Log Analytics, Anda dapat membuat visualisasi dan peringatan khusus. Buku kerja pemantauan dapat ditambahkan untuk menambahkan visualisasi yang didukung kueri.

Setiap metrik dikaitkan dengan ID sumber daya hub IoT atau aplikasi IoT Central. Karena itulah Anda dapat memeriksa apakah metrik kustom Anda terserap dengan benar dari halaman Log hub IoT yang terkait atau aplikasi IoT Central alih-alih ruang kerja Log Analytics pendukung. Gunakan kueri KQL dasar ini untuk memverifikasi:

InsightsMetrics
| where Name == 'replace-with-custom-metric-name'

Setelah Anda mengonfirmasi penyerapan, Anda dapat membuat buku kerja baru atau menambah buku kerja yang sudah ada. Gunakan dokumen buku kerja dan kueri dari buku kerja IoT Edge yang dikumpulkan sebagai panduan.

Saat senang dengan hasilnya, Anda dapat berbagi buku kerja dengan tim Anda atau menyebarkannya secara terprogram sebagai bagian dari penerapan sumber daya organisasi Anda.

Langkah berikutnya

Jelajahi opsi visualisasi metrik tambahan dengan buku kerja yang dikumpulkan.