Konfigurieren des OpenTelemetry-Adapters
Rufen Sie in der Startansicht die Registerkarte Einstellungen auf und wählen Sie auf der linken Seite Serververbindungen aus.
Konfigurieren Sie im Fenster Open Telemetry die folgenden Parameter:
Feld
Beschreibung
Ein/Aus
Aktiviert/deaktiviert den Adapter.
Bekanntgabe sensibler Daten
Aktiviert/deaktiviert den Export sensibler Daten, wie etwa IP und IMEI, an den Client.
Prometheus-Scrape aktivieren
Aktiviert den HTTP-Server für den /metrics-Endpunkt der Prometheus-Scrapes.
Prometheus-Anschluss
Konfiguriert den Anschluss, auf den der HTTP-Server lauscht.
Die Einstelloption wird nur angezeigt, wenn Prometheus aktiviert ist.
Prometheus-Authentifizierung
Aktiviert die grundlegende Authentifizierung für Prometheus-Scrapes.
Die Einstelloption wird nur angezeigt, wenn Prometheus aktiviert ist.
Benutzername
Geben Sie den Benutzernamen ein, der beim Scraping verwendet werden soll.
Die Einstelloption wird nur angezeigt, wenn die Prometheus-Authentifizierung aktiviert ist.
Passwort
Geben Sie das Passwort ein, das beim Scraping verwendet werden soll. Das Passwort wird in Klartext angezeigt.
Die Einstelloption wird nur angezeigt, wenn die Prometheus-Authentifizierung aktiviert ist.
OTLP-/HTTP-Push aktivieren
Aktiviert die OTLP-/HTTP-Exportfunktion, sodass diese regelmäßige Aktualisierungen senden kann.
OTLP-Metriken (URL)
Geben Sie den für die OTLP-/HTTP-Metriken vorgesehenen Endpunkt ein, an den die Exportfunktion die Daten im Protobuf-Format senden soll.
Die Einstelloption wird nur angezeigt, wenn OTLP aktiviert ist.
Aktualisierungsintervall
Das Polling-Intervall, in dem der Adapter Metrikdaten vom Werkzeug/der Steuerung abfragen wird, und das Aktualisierungsintervall, in dem der Adapter diese Daten an den OTLP-/HTTP-Endpunkt exportiert.
Als Name des Dienstes verwendet der Adapter in den Nachrichten den unter „IAM-Name“ konfigurierten Namen der Steuerung. Sollte kein IAM-Name angegeben sein, wird der Name des Dienstes im Export mit px2system angegeben.
Prometheus-Informationsmetriken
Statische Systeminformationen werden als OpenTelemetry-Informationsmetriken gesendet. Die Daten stehen dann in Labels zur Verfügung.
Metrisch | Typ | Einheit | Beschreibung |
|---|---|---|---|
px2system_device_info | gauge | 1 | Statische px2system-Metadaten, exportiert als *_infostyle-Metriken mit 1 als festem Wert. |
cellular_enabled | gauge | 1 | 1, wenn in der Konfiguration der Steuerung „Mobilfunk“ aktiviert ist; 0, wenn ein Mobilfunknetz vorhanden, aber deaktiviert ist. Wird nur ausgegeben, wenn ein Mobilfunknetz vorhanden ist. |
cellular_connection_info | gauge | 1 | Wird nur ausgegeben (mit einem festen Wert von 1), wenn ein Mobilfunknetz vorhanden und aktiviert ist. |
cellular_up | gauge | 1 | 1, wenn die letzte Telemetrie-Abfrage zum Mobilfunknetz frisch ist und alle Werte numerisch sind; andernfalls 0. Wird ausgegeben, wenn ein Mobilfunknetz vorhanden und aktiviert ist (Abfrage kann ausstehen); Angabe ist Null, wenn keine Verbindung zum Mobilfunknetz besteht. |
cellular_signal_sample_age_seconds | gauge | s | Zeitraum seit der letzten Mobilfunknetzabfrage in Sekunden. -1, wenn keine Abfrage vorliegt oder die Abfrage abgelaufen/ungültig ist. |
cellular_signal_rsrp_dbm | gauge | dBm | Eingangsstärke des Referenzsignals. Wird nur ausgegeben, wenn cellular_signal_up==1. |
cellular_signal_rsrq_db | gauge | dB | Eingangsqualität des Referenzsignals. Wird nur ausgegeben, wenn ein Mobilfunknetz vorhanden und aktiviert ist und eine Verbindung besteht. |
cellular_signal_rssi_dbm | gauge | dBm | Indikator zur Stärke des Eingangssignals. Wird nur ausgegeben, wenn ein Mobilfunknetz vorhanden und aktiviert ist und eine Verbindung besteht. |
cellular_signal_snr_db | gauge | dB | Signal-Rausch-Verhältnis. Wird nur ausgegeben, wenn ein Mobilfunknetz vorhanden und aktiviert ist und eine Verbindung besteht. |
cellular_signal_tx_dbm | gauge | dBm | Übertragungsleistung. Wird nur ausgegeben, wenn ein Mobilfunknetz vorhanden und aktiviert ist und eine Verbindung besteht. |
wifi_enabled | gauge | 1 | 1, wenn in der Konfiguration der Steuerung „WLAN-Client“ aktiviert ist; 0, wenn ein WLAN-Client vorhanden, aber deaktiviert ist. Wird nur ausgegeben, wenn ein WLAN-Client vorhanden ist. |
wifi_connection_info | gauge | 1 | Wird nur ausgegeben (mit einem festen Wert von 1), wenn ein WLAN vorhanden und aktiviert ist und eine WLAN-Abfrage vorliegt. |
wifi_up | gauge | 1 | 1, wenn die letzte WLAN-Abfrage frisch ist und alle Werte numerisch sind; andernfalls 0. Wird nur ausgegeben, wenn ein WLAN vorhanden und aktiviert ist (Abfrage kann ausstehen). Null bedeutet, dass keine WLAN-Verbindung besteht. |
wifi_signal_sample_age_seconds | gauge | s | Zeitraum seit der letzten WLAN-Abfrage in Sekunden. -1, wenn keine Abfrage vorliegt oder die Abfrage abgelaufen/ungültig ist. |
wifi_signal_rssi_dbm | gauge | dBm | Indikator zur Stärke des WLAN-Eingangssignals. Wird nur ausgegeben, wenn ein WLAN vorhanden und aktiviert ist und eine Verbindung besteht. |
wifi_link_quality_percent | gauge | % | Qualität der WLAN-Verbindung. Wird nur ausgegeben, wenn ein WLAN vorhanden und aktiviert ist und eine Verbindung besteht. |
wifi_tx_bitrate_mbps | gauge | Mbit/s | Theoretische maximale TX-Bitrate im WLAN. Wird nur ausgegeben, wenn ein WLAN vorhanden und aktiviert ist und eine Verbindung besteht. |
wifi_rx_bitrate_mbps | gauge | Mbit/s | Theoretische maximale RX-Bitrate im WLAN. Wird nur ausgegeben, wenn ein WLAN vorhanden und aktiviert ist und eine Verbindung besteht. |
Metrik | Labelschlüssel | Sensibel | Anmerkungen |
|---|---|---|---|
px2system_device_info | service_name | nein | Der konfigurierte IAM-Name; ohne Angabe wird „px2system“ ausgegeben. |
px2system_device_info | tool_serial | nein | Werkzeugkennung. Wird ausgegeben, wenn eine Werkzeugkennung zur Verfügung steht. |
px2system_device_info | tool_model | nein | Werkzeugmodell-Kennung. Wird ausgegeben, wenn eine Werkzeugkennung zur Verfügung steht. |
cellular_connection_info | technology | nein | Beispielwerte: „4G“, „5G“. Wird ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular_connection_info | pci | nein | Physical Cell ID. Wird ausgegeben, wenn sie vom Modem zur Verfügung gestellt wird. |
cellular_connection_info | carrier_name | nein | Name des Übermittlers/Betreibers. Wird ausgegeben, wenn er vom Modem zur Verfügung gestellt wird. |
cellular_connection_info | carrier_mcc | nein | Mobile Country Code Wird ausgegeben, wenn er vom Modem zur Verfügung gestellt wird. |
cellular_connection_info | carrier_mnc | nein | Mobile Network Code. Wird ausgegeben, wenn er vom Modem zur Verfügung gestellt wird. |
cellular_connection_info | apn | ja | Konfigurierter Name des Zugangspunktes; unterliegt der Beschränkung durch die Konfiguration von exposeSensitiveData. |
cellular_connection_info | ip_address | ja | Die vom Mobilfunkmodem verwendete IP-Adresse; unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
cellular_connection_info | imei | ja | International Mobile Equipment Identity für das Modem; unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
cellular_connection_info | sim_iccid | ja | SIM-Seriennummer (nur wenn vorhanden); unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
cellular_connection_info | frequency_band | nein | Vom Mobilfunkmodem verwendetes Frequenzband. Wird ausgegeben, wenn dies vom Modem zur Verfügung gestellt wird. |
cellular_connection_info | bandwidth | nein | Vom Mobilfunkmodem verwendete Bandbreite. Wird ausgegeben, wenn dies vom Modem zur Verfügung gestellt wird. |
cellular_connection_info | mtu | nein | Maximale Übertragungseinheit. Wird ausgegeben, wenn dies vom Modem zur Verfügung gestellt wird. |
cellular_connection_info | imsi | ja | SIM International Mobile Subscriber Identity; unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi_connection_info | channel | nein | WLAN-Kanal. Wird ausgegeben, wenn er vom System zur Verfügung gestellt wird. |
wifi_connection_info | ssid | ja | Der unverwechselbare Name des WLAN-Netzwerks; unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi_connection_info | bssid | ja | Unverwechselbare MAC für den unverwechselbaren AP; unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi_connection_info | mac_address | ja | MAC-Adresse der WLAN-Karte; unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi_connection_info | ipv4 | ja | Die vom WLAN verwendete IP-Adresse; unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
OTLP-/HTTP-Informationsmetriken
Metrik | Einheit | Beschreibung |
|---|---|---|
cellular.enabled | 1 | 1, wenn in der Konfiguration der Steuerung „Mobilfunk“ aktiviert ist; andernfalls 0. Wird nur ausgegeben, wenn ein Mobilfunknetz vorhanden ist. |
cellular.up | 1 | 1, wenn die letzte Mobilfunknetzabfrage numerisch ist; andernfalls 0. Wird ausgegeben, wenn ein Mobilfunknetz vorhanden und aktiviert ist; kann als 0 ausgegeben werden, wenn keine Abfrage vorliegt bzw. die Abfrage ungültig ist und dementsprechend keine Verbindung besteht. |
cellular.signal.sample_age | s | Zeitraum seit der letzten Mobilfunknetzabfrage in Sekunden. -1, wenn wenn keine Abfrage vorliegt bzw. die Abfrage ungültig ist. |
cellular.signal.rsrp | dBm | Eingangsstärke des Referenzsignals. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein Mobilfunknetz vorhanden und aktiviert sein und eine Verbindung zu diesem Netz bestehen. |
cellular.signal.rsrq | dB | Eingangsqualität des Referenzsignals. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein Mobilfunknetz vorhanden und aktiviert sein und eine Verbindung zu diesem Netz bestehen. |
cellular.signal.rssi | dBm | Indikator zur Stärke des Eingangssignals. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein Mobilfunknetz vorhanden und aktiviert sein und eine Verbindung zu diesem Netz bestehen. |
cellular.signal.snr | dB | Signal-Rausch-Verhältnis. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein Mobilfunknetz vorhanden und aktiviert sein und eine Verbindung zu diesem Netz bestehen. |
cellular.signal.tx_power | dBm | Übertragungsleistung. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein Mobilfunknetz vorhanden und aktiviert sein und eine Verbindung zu diesem Netz bestehen. |
wifi.enabled | 1 | 1, wenn in der Konfiguration der Steuerung „WLAN“ aktiviert ist; andernfalls 0. Wird nur ausgegeben, wenn ein WLAN-Client vorhanden ist. |
wifi.up | 1 | 1, wenn die letzte WLAN-Abfrage numerisch ist; andernfalls 0. Wird ausgegeben, wenn ein WLAN vorhanden und aktiviert ist; kann als 0 ausgegeben werden, wenn keine Abfrage vorliegt bzw. die Abfrage ungültig ist und dementsprechend keine Verbindung besteht. |
wifi.signal.sample_age | s | Zeitraum seit der letzten WLAN-Abfrage in Sekunden. -1, wenn wenn keine Abfrage vorliegt bzw. die Abfrage ungültig ist. |
wifi.signal.rssi | dBm | Indikator zur Stärke des WLAN-Eingangssignals. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein WLAN vorhanden und aktiviert sein und eine Verbindung zu diesem WLAN bestehen. |
wifi.link.quality | % | Qualität der WLAN-Verbindung. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein WLAN vorhanden und aktiviert sein und eine Verbindung zu diesem WLAN bestehen. |
wifi.link.tx_bitrate | Mbit/s | Theoretische maximale TX-Bitrate im WLAN. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein WLAN vorhanden und aktiviert sein und eine Verbindung zu diesem WLAN bestehen. |
wifi.link.rx_bitrate | Mbit/s | Theoretische maximale RX-Bitrate im WLAN. Wird nur ausgegeben, wenn die Abfrage numerisch ist. Zudem muss ein WLAN vorhanden und aktiviert sein und eine Verbindung zu diesem WLAN bestehen. |
Schlüssel | Sensibel | Anmerkungen |
|---|---|---|
service.name | nein | Der konfigurierte IAM-Name; ohne Angabe wird „px2system“ ausgegeben. |
tool.serial_number | nein | Werkzeug-Seriennummer Wird nur ausgegeben, wenn mindestens eine Domain vorhanden und aktiviert ist und die Seriennummer des Werkzeugs zur Verfügung steht. |
tool.model | nein | Werkzeugmodell. Wird nur ausgegeben, wenn mindestens eine Domain vorhanden und aktiviert ist und das Werkzeugmodell zur Verfügung steht. |
cellular.present | nein | Wird als „wahr“ ausgegeben, wenn ein Mobilfunknetz vorhanden ist (selbst, wenn es deaktiviert ist). Ist im System kein Mobilfunknetz gegeben, erfolgt die Ausgabe „falsch“. |
cellular.radio.tech | nein | Beispielwerte: „4G“, „5G“. Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.carrier.name | nein | Name des Übermittlers/Betreibers. Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.carrier.mcc | nein | Mobile Country Code Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.carrier.mnc | nein | Mobile Network Code. Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.frequency.band | nein | Frequenzband des Mobilfunknetzes. Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.frequency.bandwidth | nein | Bandbreite des Mobilfunknetzes. Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.link.mtu | nein | Maximale Übertragungseinheit. Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.pci | nein | Physical Cell Identity. Wird bei Vorhandensein ausgegeben, wenn „Mobilfunk“ aktiviert ist. |
cellular.ip | ja | IP-Adresse für das Mobilfunkmodem. Wird ausgegeben, wenn „Mobilfunk“ aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
cellular.apn | ja | Name des konfigurierten Zugangspunktes. Wird ausgegeben, wenn „Mobilfunk“ aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
cellular.imei | ja | International Mobile Equipment Identity für das Modem. Wird ausgegeben, wenn „Mobilfunk“ aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
cellular.imsi | ja | SIM International Mobile Subscriber Identity. Wird ausgegeben, wenn „Mobilfunk“ aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
cellular.sim.iccid | ja | SIM-Seriennummer, Nur falls vorhanden; wird ausgegeben, wenn „Mobilfunk“ aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi.present | nein | Wird als „wahr“ ausgegeben, wenn ein WLAN-Client vorhanden ist (selbst, wenn er deaktiviert ist). Ist im System kein WLAN gegeben, erfolgt die Ausgabe „falsch“. |
wifi.channel | nein | WLAN-Kanal für das System. Wird ausgegeben, wenn WLAN vorhanden und aktiviert ist. |
wifi.ssid | ja | Der unverwechselbare Name des WLAN-Netzwerks. Wird ausgegeben, wenn WLAN vorhanden und aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi.bssid | ja | Die unverwechselbare MAC für den unverwechselbaren AP. Wird ausgegeben, wenn WLAN vorhanden und aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi.mac_address | ja | MAC-Adresse für die WLAN-Karte. Wird ausgegeben, wenn WLAN vorhanden und aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
wifi.ipv4 | ja | IP-Adresse, die vom WLAN verwendet wird. Wird ausgegeben, wenn WLAN vorhanden und aktiviert ist. Unterliegt der Beschränkung durch die Konfiguration zur Bekanntgabe sensibler Daten. |
Prometheus-Authentifizierung
Wenn bei OpenTelemetry die Prometheus-Authentifizierung aktiviert ist, müssen die Clients im Authentifizierungs-Header der GET-Anfrage (Scrape) den richtigen Benutzernamen und das entsprechende Passwort mitsenden. Sollten die Anmeldedaten fehlen oder falsch sein, antwortet der Server mit „401 Unauthorized“. Die Authentifizierung hat Priorität: Der Server gibt selbst dann die Fehlermeldung 401 zurück, wenn bei der Anfrage der falsche Pfad verwendet wird. Sind die Anmeldedaten korrekt, antwortet der Server, als wenn die Authentifizierung deaktiviert wäre: 200 mit dem Scrape für einen korrekten Pfad oder „404 Not Found“ bei einem falschen Pfad.
Das Passwort wird gespeichert und im OpenTelemetry-Fenster aus Gründen der Benutzerfreundlichkeit bewusst in Klartext angezeigt. Diese Entscheidung richtet sich an kontrollierte Betriebsumgebungen, in denen der Zugriff auf die Benutzeroberfläche beschränkt ist. Die Benutzer sollten in der Managementschnittstelle angemessene Zugangskontrollen einsetzen.
Umgang mit Fehlern bei Prometheus
Wenn ein Client einen von /metrics abweichenden Pfad scrapt, gibt der Server einen HTTP 404-Fehler aus. Ist die Authentifizierung aktiviert, konsultieren Sie in Bezug auf den Umgang mit Fehlern den Abschnitt zur Authentifizierung. Ist Prometheus nicht aktiviert, kommt es bei der Anfrage des Client zu einer Zeitüberschreitung.
Umgang mit Fehlern bei OTLP/HTTP
Die Exportfunktion arbeitet mit einer dauerhaften Verbindung (Keep-Alive) zum OTel Collector. Sie öffnet die Verbindung beim ersten Push mit Verzögerung und nutzt die Netzwerkverbindung dann auch für folgende Pushes. Sollte die Verbindung fehlschlagen, wird versucht, die Netzwerkverbindung erneut zu verwenden, wenn dies möglich ist.
Sollte für den Export keine Verbindung zustande kommen, nutzt der Adapter ein Backoff-Verfahren mit einem Jitter von ± 25 % für folgende Anfrageversuche. Für die Backoff-Anfragen gilt eine Höchstgrenze von 30 Sekunden. Nach 10 aufeinander folgenden Fehlschlägen wartet der Adapter 5 Minuten, bevor die nächsten Versuche unternommen werden.
Behebbare Fehler in der HTTP-Antwort, bei denen für erneute Versuche das Backoff-Verfahren verwendet wird:
Es kann keine Verbindung zum Endpunkt aufgebaut werden.
Fehler senden/lesen (Verbindung wurde beendet und ein erneuter Verbindungsaufbau versucht).
HTTP-Antwortstatus:
408 (Zeitüberschreitung)
429 (Rückfahren der Taktfrequenz)
Alle 5xx (Serverfehler)
Nicht behebbare Fehler (Unterbrechung bis zur Änderung der Konfiguration):
Alle HTTP-Antworten aus dem 4xx-Bereich.
Ungültige Metriken (URL).
https:// konfiguriert (TLS nicht unterstützt)
Wenn keine Telemetrie-Abfrage vorliegt (beispielsweise beim Hochfahren), wird der Adapter dies nicht als Fehler betrachten und nicht ins Backoff-Verfahren wechseln.
