Health-Endpunkte

Der OPC Router stellt Health-Endpunkte bereit, über die sich Zustandsinformationen wie der Redundanzstatus abfragen lassen. Sowohl die Runtime als auch das Web-Management verfügen über eigene Health-Endpunkte.

Diese Endpunkte sind vor allem für externe Systeme wie Reverse Proxys, Load Balancer oder Monitoring-Lösungen relevant. Sie ergänzen die interne OPC-Router-Redundanz, ersetzen deren Konfiguration aber nicht.

hinweis

Die möglichen Werte für einen Zustand sind:

• Healthy: alles ist in Ordnung
• Unhealthy: es liegt ein Fehler vor
• Degraded: der Dienst läuft, aber mit Einschränkungen

Health-Endpunkte des Web-Managements

Das Web-Management stellt folgende Health-Endpunkte zur Verfügung. Sie eignen sich insbesondere dann, wenn ein externer Reverse Proxy den Status des Web-Managements oder der Runtime über einen einheitlichen Einstiegspunkt prüfen soll.

Endpunkt	Beschreibung
/health	Zeigt den allgemeinen Zustand des Web-Managements an.
/health/live	Zeigt, ob das Web-Management grundsätzlich läuft und antwortet.
/health/ready	Zeigt, ob das Web-Management betriebsbereit ist und Anfragen annehmen kann.
/health/details	Liefert zusätzliche Einzelheiten zum aktuellen Zustand im JSON-Format.
/health/runtime<Runtime-Health-Endpunkt>	Leitet Anfragen an die Health-Endpunkte der Runtime weiter, damit diese über das Web-Management erreichbar sind. (Reverse Proxy)

Health-Endpunkte der Runtime

Konfiguration

Die Health-Endpunkte der Runtime können über folgende Umgebungsvariablen konfiguriert werden.

Umgebungsvariable	Beschreibung	Standardwert
OR_ENABLE_HEALTH_ENDPOINT	Aktiviert die Bereitstellung aller Health-Endpunkte	true
OR_RUNTIME_HEALTH_ENDPOINT_PORT	Port, auf dem die Runtime die Health-Endpunkte bereitstellt	53200

warnung

Der mit OR_RUNTIME_HEALTH_ENDPOINT_PORT konfigurierte Port ist nur von localhost aus erreichbar, also zum Beispiel aus dem Docker-Container oder direkt vom Windows-Server, auf dem der OPC Router läuft.

hinweis

Für externe Failover-Konfigurationen mit Nginx oder Traefik wird in den Beispielen deshalb der Pfad /health/runtime/ready über das Web-Management verwendet und nicht der lokale Runtime-Port direkt.

Endpunkte

Die Runtime stellt folgende Health-Endpunkte zur Verfügung.

Endpunkt	Beschreibung
/	Zeigt den allgemeinen Zustand der Runtime an.
/live	Zeigt, ob die Runtime grundsätzlich läuft und erreichbar ist.
/ready	Zeigt, ob die Runtime betriebsbereit ist. Der Endpunkt liefert den Statuscode 200, wenn alle Prüfungen erfolgreich sind. Wenn mindestens eine Prüfung fehlschlägt, wird 503 zurückgegeben.
/details	Liefert Einzelheiten zu allen internen Zustandsprüfungen im JSON-Format.
/RedundancyState	Liefert den aktuellen Redundanzstatus im JSON-Format, zum Beispiel {"status":"Ready"} Mögliche Werte sind: Ready: dieses System ist aktiv Standby: dieses System wartet als Sekundärsystem LicenseError: die Redundanz kann wegen eines Lizenzproblems nicht korrekt arbeiten
/TransferManager	Zeigt den Zustand des Transfer-Managers.
/RuntimeLicenseManager	Zeigt den Zustand des Lizenz-Managers in der Runtime an.
/HistoricalDiagnosisStorage	Zeigt den Zustand des Diagnosespeichers für historische Einträge an.
/TelemetryManager	Zeigt den Zustand der Komponente an, die Telemetriedaten verarbeitet.