Zum Hauptinhalt springen
Version: 5.4

Health-Endpunkte

Der OPC Router verfügt über Health-Endpunkte, über die sich Daten zum Zustand des OPC Routers abfragen lassen, z.B. der Redundanzstatus. Sowohl die Laufzeit als auch das Web Management stellen Health-Endpunkte zur Verfügung.

hinweis

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

  • Healthy
  • Unhealthy
  • Degraded

Health-Endpunkte des Web-Managements

Das Web-Management stellt folgende Health-Endpunkte zur Verfügung.

EndpunktBeschreibung
/healthAllgemeiner Zustand des Web-Managements
/health/liveLiveness-Probe
/health/readyReadiness-Probe
/health/detailsDetails zum Status im JSON Format
/health/runtime<Runtime Health-Endpunkt>Reverse Proxy zu den Health-Endpunkten der Runtime

Health-Endpunkte der Runtime

Konfiguration

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

UmgebungsvariableBerschreibungStandardwert
OR_ENABLE_HEALTH_ENDPOINTAktiviert die Bereitstellung aller Health-Endpunktetrue
OR_RUNTIME_HEALTH_ENDPOINT_PORTPort, auf dem die Runtime die Health-Endpunkte bereitstellt53200
warnung

Der Port, der mit OR_RUNTIME_HEALTH_ENDPOINT_PORT konfiguriert wurde, ist nur von localhost aus erreichbar, z.B. von dem Docker Container oder dem Windows Server, in/auf dem der OPC Router läuft.

Endpunkte

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

EndpunktBeschreibung
/Allgemeiner Zustand der Runtime
/liveLiveliness-Probe
/ready

Readiness-Probe und allgemeiner Zustand der Runtime

Gibt den Statuscode 200 Zurück, wenn alle Health-Checks erfolgreich sind.
Andernfalls wird der Statuscode 503 zurückgegeben.

/detailsDetails zu allen Health-Checks im JSON Format
/RedundancyState

Aktueller Redundanzstatus im JSON Format z.B.

{"status":"Ready"}

Die Möglichen Werte für den Redundanz-Status sind:

  • Ready
  • Standby
  • LicenseError
/TransferManagerTransfer-Manager Health-Check
/RuntimeLicenseManagerLizenz-Manger Health-Check
/HistoricalDiagnosisStorageRingspeicher Health-Check
/TelemetryManagerTelemetrie-Manager Health-Check