Health Endpoints
The OPC router provides health endpoints that can be used to query data about the status of the OPC router, e.g. the redundancy state. Both the Runtime and the Web Management provide health endpoints.
The possible values for a status are:
- Healthy
- Unhealthy
- Degraded
Health endpoints of the Web Management
The Web Management provides the following health endpoints.
| Endpoint | Description |
|---|---|
| /health | General state of the Web Management |
| /health/live | Liveness probe |
| /health/ready | Readiness probe |
| /health/details | Details on the status in JSON format |
| /health/runtime<Runtime health endpoint> | Reverse proxy to the health endpoints of the Runtime |
Health Endpoints of the Runtime
Configuration
The Heath endpoints of the Runtime can be configured using the following environment variables.
| Environment variable | Description | Default value |
|---|---|---|
OR_ENABLE_HEALTH_ENDPOINT | Activates the provision of all health endpoints | true |
OR_RUNTIME_HEALTH_ENDPOINT_PORT | Port on which the Runtime provides the health endpoints | 53200 |
The port configured with OR_RUNTIME_HEALTH_ENDPOINT_PORT is only accessible from localhost, e.g. from the Docker container or the Windows server in/on which the OPC router is running.
Endpoints
The Runtime provides the following health endpoints.
| endpoint | description |
|---|---|
| / | General state of the Runtime |
| /live | Liveliness probe |
| /ready | Readiness probe and general state of the Runtime |
| /details | Details of all health checks in JSON format |
| /RedundancyState | Current Redundancy state in JSON format e.g. {"status": "Ready"}The possible values for the redundancy status are:
|
| /TransferManager | Transfer Manager health check |
| /RuntimeLicenseManager | License Manager health check |
| /HistoricalDiagnosisStorage | Circular Storage health check |
| /TelemetryManager | Telemetry Manager health check |