Dodawanie metryk niestandardowych

Dotyczy: IoT Edge 1.5 IoT Edge 1.4

Ważne

Obsługiwane są wersje usługi IoT Edge 1.5 LTS i IoT Edge 1.4 LTS. Usługa IoT Edge 1.4 LTS kończy się 12 listopada 2024 r. Jeśli korzystasz z wcześniejszej wersji, zobacz aktualizację Azure IoT Edge.

Zbierz metryki niestandardowe z modułów usługi IoT Edge oprócz wbudowanych metryk zapewnianych przez moduły systemowe. Wbudowane metryki zapewniają doskonały wgląd w kondycję wdrożenia. Jednak może być konieczne wymaganie dodatkowych informacji z modułów niestandardowych w celu ukończenia obrazu. Moduły niestandardowe można zintegrować z rozwiązaniem do monitorowania przy użyciu odpowiedniej biblioteki klienta Prometheus w celu emitowania metryk. Te dodatkowe informacje mogą włączać nowe widoki lub alerty specyficzne dla Twoich wymagań.

Repozytorium przykładowych modułów

Zobacz repozytorium azure-samples, aby zapoznać się z przykładami modułów niestandardowych instrumentowanych w celu emitowania metryk. Nawet jeśli próbka w wybranym języku nie jest jeszcze dostępna, ogólne podejście może Ci pomóc.

Konwencje nazewnictwa

Zapoznaj się z najlepszymi rozwiązaniami z witryny Prometheus docs, aby uzyskać ogólne wskazówki. Poniższe dodatkowe zalecenia mogą być przydatne w scenariuszach usługi IoT Edge.

• Dołącz nazwę modułu na początku nazwy metryki, aby wyjaśnić, który moduł emitował metryki.

• Uwzględnij nazwę centrum IoT lub nazwę aplikacji usługi IoT Central, identyfikator urządzenia usługi IoT Edge i identyfikator modułu jako etykiety (nazywane również wymiarami tagów/) w każdej metryce. Te informacje są dostępne jako zmienne środowiskowe dla każdego modułu uruchomionego przez agenta usługi IoT Edge. Takie podejście przedstawiono w przykładzie w repozytorium przykładów. Bez tego kontekstu nie można skojarzyć danej wartości metryki z określonym urządzeniem.

• Dołącz identyfikator wystąpienia do etykiet. Identyfikator wystąpienia może być dowolnym unikatowym identyfikatorem , takim jak identyfikator GUID generowany podczas uruchamiania modułu. Informacje o identyfikatorze wystąpienia mogą pomóc w uzgadnianiu ponownych uruchomień modułu podczas przetwarzania metryk modułu w zapleczu.

Konfigurowanie modułu zbierającego metryki w celu zbierania metryk niestandardowych

Gdy moduł niestandardowy emituje metryki, następnym krokiem jest skonfigurowanie modułu modułu zbierającego metryki w celu zbierania i transportu metryk niestandardowych.

Zmienna środowiskowa MetricsEndpointsCSV musi zostać zaktualizowana w celu uwzględnienia adresu URL punktu końcowego metryk modułu niestandardowego. Podczas aktualizowania zmiennej środowiskowej należy uwzględnić punkty końcowe modułu systemu, jak pokazano w przykładzie konfiguracji modułu zbierającego metryki.

Uwaga

Domyślnie punkt końcowy metryk modułu niestandardowego nie musi być mapowany na port hosta, aby umożliwić modułowi zbierającemu metryki dostęp do niego. O ile nie zostanie jawnie zastąpiona, w systemie Linux oba moduły są uruchamiane w sieci mostka platformy Docker zdefiniowanej przez użytkownika o nazwie azure-iot-edge.

Sieci platformy Docker zdefiniowane przez użytkownika obejmują domyślny program rozpoznawania nazw DNS, który umożliwia komunikację między modułami przy użyciu nazw modułów (kontenerów). Jeśli na przykład niestandardowy moduł o nazwie module1 emituje metryki na porcie HTTP 9600 w ścieżce /metrics, moduł zbierający powinien być skonfigurowany do zbierania z punktu końcowego http://module1:9600/metrics.

Uruchom następujące polecenie na urządzeniu usługi IoT Edge, aby sprawdzić, czy metryki emitowane przez moduł niestandardowy na porcie HTTP 9600 w ścieżce /metrics są dostępne:

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

Dodawanie wizualizacji niestandardowych

Po otrzymaniu metryk niestandardowych w usłudze Log Analytics możesz tworzyć niestandardowe wizualizacje i alerty. Skoroszyty monitorowania można rozszerzyć, aby dodać wizualizacje oparte na zapytaniach.

Każda metryka jest skojarzona z identyfikatorem zasobu aplikacji usługi IoT Hub lub usługi IoT Central. Dlatego możesz sprawdzić, czy niestandardowe metryki zostały pozyskane poprawnie na stronie Dzienniki skojarzonej aplikacji usługi IoT Hub lub usługi IoT Central zamiast obszaru roboczego usługi Log Analytics. Użyj tego podstawowego zapytania KQL, aby sprawdzić:

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

Po potwierdzeniu pozyskiwania możesz utworzyć nowy skoroszyt lub rozszerzyć istniejący skoroszyt. Użyj dokumentacji i zapytań skoroszytów z wyselekcjonowanych skoroszytów usługi IoT Edge jako przewodnika.

Jeśli wyniki są zadowolone, możesz udostępnić skoroszyt zespołowi lub wdrożyć je programowo w ramach wdrożeń zasobów organizacji.

Następne kroki

Zapoznaj się z dodatkowymi opcjami wizualizacji metryk za pomocą wyselekcjonowanych skoroszytów.