Health endpoints

The OPC Router has health endpoints that can be used to query data on the status of the OPC Router, e.g., the redundancy status. Both the runtime and the web management provide health endpoints.

note

The possible values for a status are:

• Healthy
• Unhealthy
• Degraded

Health endpoints of web management

Web management provides the following health endpoints.

Endpoint	Description
/health	General status of web management
/health/live	Liveness probe
/health/ready	Readiness probe
/health/details	Details on the status in JSON format
/health/runtime<runtime health-endpunkt="">	Reverse proxy to the runtime health endpoints

Runtime health endpoints

Configuration

The runtime health endpoints can be configured using the following environment variables.

Environment variable	Description	Default value
OR_ENABLE_HEALTH_ENDPOINT	Enables the provision of all health endpoints	true
OR_RUNTIME_HEALTH_ENDPOINT_PORT	Port on which the runtime provides the health endpoints	53200

warning

The port configured with OR_RUNTIME_HEALTH_ENDPOINT_PORT is only accessible from localhost, e.g., from the Docker container or the Windows server on which the OPC Router is running.

Endpoints

The runtime provides the following health endpoints.

Endpoint	Description
/	General status of the runtime
/live	Liveliness probe
/ready	Readiness probe and general status of the runtime Returns status code 200 if all health checks are successful. Otherwise, status code 503 is returned.
/details	Details of all health checks in JSON format
/RedundancyState	Current redundancy status in JSON format, e.g. {"status":"Ready"} The possible values for the redundancy status are: Ready Standby LicenseError
/TransferManager	Transfer Manager health check
/RuntimeLicenseManager	License Manager health check
/HistoricalDiagnosisStorage	Ring memory health check
/TelemetryManager	Telemetry manager health check