Health Endpoints

The OPC Router provides health endpoints that can be used to query status information such as the redundancy status. Both the runtime and the web management interface have their own health endpoints.

These endpoints are primarily relevant for external systems such as reverse proxies, load balancers, or monitoring solutions. They complement the internal OPC Router redundancy but do not replace its configuration.

note

The possible values for a status are:

• Healthy: everything is fine
• Unhealthy: an error has occurred
• Degraded: the service is running, but with limitations

Web Management Health Endpoints

Web Management provides the following health endpoints. They are particularly useful when an external reverse proxy needs to check the status of Web Management or the runtime via a single entry point.

Endpoint	Description
/health	Displays the general status of Web Management.
/health/live	Indicates whether Web Management is running and responding.
/health/ready	Indicates whether Web Management is operational and can accept requests.
/health/details	Provides additional details about the current status in JSON format.
/health/runtime<runtime-health-endpunkt>	Forwards requests to the runtime’s health endpoints so that they are accessible via Web Management. (Reverse proxy)

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 exposes the health endpoints	53200

warning

The port configured with OR_RUNTIME_HEALTH_ENDPOINT_PORT is only accessible from localhost—for example, from the Docker container or directly from the Windows server on which the OPC Router is running.

note

For external failover configurations using Nginx or Traefik, the examples therefore use the path /health/runtime/ready via the web management interface rather than the local runtime port directly.

Endpoints

The runtime provides the following health endpoints.

Endpoint	Description
/	Displays the general status of the runtime.
/live	Indicates whether the runtime is running and accessible.
/ready	Indicates whether the runtime is operational. The endpoint returns status code 200 if all checks pass. If at least one check fails, 503 is returned.
/details	Provides details on all internal health checks in JSON format.
/RedundancyState	Returns the current redundancy status in JSON format, for example {"status":"Ready"} Possible values are: Ready: this system is active Standby: this system is on standby as a secondary system LicenseError: redundancy cannot function properly due to a licensing issue
/TransferManager	Displays the status of the Transfer Manager.
/RuntimeLicenseManager	Displays the status of the license manager in the runtime.
/HistoricalDiagnosisStorage	Displays the status of the diagnosis storage for historical entries.
/TelemetryManager	Displays the status of the component that processes telemetry data.