Skip to content

System Info

openwcs-docs-agent edited this page Jun 12, 2026 · 3 revisions

System Info

The System info screen (Administration · ADMIN-only) is the operator's single view of the health, version and logs of every backend service and device adapter. It is aggregated by the gateway, so it works whether or not a service exposes its own UI.

Service health & version

GET /api/system/services (gateway) probes every configured service + Go adapter and returns, per service: name, kind (java | go), health status (UP / DOWN / UNKNOWN — Spring health for Java, reachability for Go adapters), version, commit, buildTime, and the gateway probe latencyMs. The screen shows a {up}/{total} up summary badge, auto-refreshes every 10 s (toggleable), and sorts unhealthy services to the top so problems surface first. The table is searchable by name/kind/status/version/commit.

Note: GET /api/system/services is also used by the UI's reconnecting overlay — while the gateway is unreachable the overlay probes this endpoint every 2.5 s so that recovery is detected even if no other screen is actively polling (see Architecture — UI resilience).

Service logs

Every service and adapter writes a daily-rotated per-service log file to a shared openwcs-logs Docker volume (Java services via libs/common logback-spring.xml; Go adapters via a daily writer). The gateway reads these files back — no Docker socket is used, so logs survive container recreation. Files are retained for ~14 days.

  • GET /api/system/services/{name}/logs?tail=&date= — the last tail lines (default 200) of a service's log for date (yyyy-MM-dd; most recent day when omitted).
  • GET /api/system/services/{name}/log-days — the days (newest first) a service has logs for, driving the day picker.

From the table, a Logs button opens a modal log viewer (filter + tail + refresh) shared with the full-page view; Open as page navigates to /system-info/logs/:name for a roomier, searchable log view.

Access

The whole screen and the /api/system/** endpoints are ADMIN-only.

Operator in-app help

The screen has a Help button (top bar) that opens a contextual drawer covering: how to read the health table and confirm a deploy landed, how to open log files and filter them, and if/then troubleshooting for common scenarios (unhealthy services, empty log days, gateway-down patterns).

Related: Services · Architecture · Security · Deployment Guide.

Clone this wiki locally