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.
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.
| Endpunkt | Beschreibung |
|---|---|
| /health | Allgemeiner Zustand des Web-Managements |
| /health/live | Liveness-Probe |
| /health/ready | Readiness-Probe |
| /health/details | Details 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.
| Umgebungsvariable | Berschreibung | 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 |
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.
| Endpunkt | Beschreibung |
|---|---|
| / | Allgemeiner Zustand der Runtime |
| /live | Liveliness-Probe |
| /ready | Readiness-Probe und allgemeiner Zustand der Runtime |
| /details | Details 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:
|
| /TransferManager | Transfer-Manager Health-Check |
| /RuntimeLicenseManager | Lizenz-Manger Health-Check |
| /HistoricalDiagnosisStorage | Ringspeicher Health-Check |
| /TelemetryManager | Telemetrie-Manager Health-Check |