Skip to content
Weik.ioDocs
2026.2
Try Weik.io

Health and problems

Weik.io 2026.2

See the state of every part of the platform in Settings › Operations › Health, and what needs attention in the problem list. Product page · Video

Watch: Watching the whole installation, 3:10

The video watches the whole installation from the Home and Observability pages, then from the Health page.

On this page

Every 15 seconds, Weik.io checks the integrations you run and the platform that runs them, and raises a problem for anything that needs attention. A problem has its figures in a few words and the time it began. It also has the command that shows more. You see the same problems in the admin UI and in the CLI:

  • Home, under Needs attention
  • The Observability Overview
  • The page of the integration or API a problem concerns
  • weikio problems

Problems the platform raises#

  • An integration whose messages fail, at least 5 and at least 5 % of them in 15 minutes
  • An integration that keeps restarting, such as 6 times in 40 minutes after running out of memory
  • An integration whose memory keeps growing day after day
  • An integration that has stopped handling messages for much longer than its usual gaps
  • An API version that fails on the server side in at least 5 % of at least 20 calls in 15 minutes
  • A file transfer whose last run had errors
  • A deployment no agent runs

A file transfer’s problem quotes the run’s first error line. The problem of a deployment no agent runs has the reason and what a platform administrator does about it.

For platform administrators, Weik.io also raises problems about itself:

  • An agent that is offline or on an older build
  • An agent that is low on memory or disk
  • An agent whose credential would be too large for everything it serves
  • Message storage or a telemetry store filling up
  • Telemetry that Weik.io lost
  • A hub server cut off from the others
  • Builds stopped on a hub server whose kernel can’t limit their network connections
  • A certificate near its expiry
  • No backup in twice the backup interval, or a backup copy that failed
  • Two-factor sign-in turned off for administrators

For the threshold that raises a problem and the commands that fix it, see its page in the docs, such as A backup is overdue. All of them are in the Problems reference.

Weik.io counts problems in the metrics weikio.problem.raised and weikio.problem.active and writes a log line whenever a problem’s state changes. To forward the log lines and the metrics, set up Telemetry forwarding.

List the problems#

Terminal
$ weikio problems --env production

The output has one row for each problem:

  • The severity
  • The kind
  • The environment and project
  • What the problem is about
  • The time it began
  • FIGURE, the numbers in a few words, such as 42 of 310 failed in 15 min or 6 restarts in 40 min, out of memory
  • The problem’s title

On a terminal, the detail follows under each row. It has a sentence about the problem and, after Read it with:, the command that shows what the row is about, such as weikio status finance/erp-invoice-export --env production. When the output goes into a pipe or a file, the detail is the last column. Each problem is then one line. When there are no problems, weikio problems prints nothing on standard output and No problems found. on standard error.

In the API, each problem has the same commands in its commands member. In Settings › Operations › Health, you see each command in a command block.

The Health page#

Settings › Operations › Health is for platform administrators. There you see the state and version of each part:

  • Each backend node
  • Each APIM instance
  • The message servers
  • The telemetry stores
  • The forwarder
  • Every agent

Each part also has its figures and what to do.

In Platform logs, you see the lines that the platform writes about itself.

/settings/health
The Health page with all 10 parts online and no platform problemsThe Health page with all 10 parts online and no platform problemsThe table of parts on the Health page. The backend is online, as are the APIM instance and the message server.The table of parts on the Health page. The backend is online, as are the APIM instance and the message server.
In Health, you see the state of each part of the platform and the problems a platform admin has to act on.

A part shows To watch or an error as it fills up:

Part To watch Error
A store or a disk From 85 % of its budget, or below a fifth free From 95 %, or below a tenth free
An agent’s server More than 90 % of its memory in use More than 95 % of its memory in use

A store that deletes its oldest records once it’s full, such as an environment’s events or the log store at its cap, is never an error.

Health from the CLI#

weikio platform health checks whether the backend is alive and ready, and exits with code 6 when the hub isn’t ready or a part is offline:

Terminal
$ weikio platform health
You see
Server:     https://hub.example
Liveness:   ok
Readiness:  ok
Issuer:     https://hub.example

With a platform administrator’s key, the command also lists every part the Health page shows, then the storage lines. Each part’s line has its status and version, then its uptime and resource use. --watch redraws the view every 30 seconds and shows the platform’s latest warnings and errors under it.

weikio platform metrics hub shows the figures of message storage over the last hour. weikio platform logs backend shows the backend’s log lines.

Watch the hub from outside#

A hub that stops responding can’t raise a problem about itself. Run a check from a place that shares neither the hub’s network nor its hosting, such as a monitoring service or a server of your own:

  • The check requests GET https://acme.example/readyz/node on the backend’s name.
  • The check runs once a minute with a timeout of 10 seconds and alerts after two failed checks in a row.
  • The check verifies the certificate and fails on one that has expired or that the weikio CLI and the agents don’t trust.

The endpoint needs no sign-in and answers callers from any address, whatever the hub’s allowed networks are. The hub replies 200 with the text ready while every part it checks is ready:

  • The backend
  • The gateway
  • The message server’s listener for agent links

Otherwise the hub returns 503 with one sentence for each part that isn’t ready.

Turn the check on once the backend’s name has its first certificate. While you upgrade a hub on one server, pause the check. The API is unavailable for the number of seconds the upgrade prints on its last line.

When the check fails, look in the reply for the part that isn’t ready. Then run docker compose ps -a to see which service is down and docker compose run --rm infra weikio-backend doctor to check the rest.

On a hub of several servers, the check goes through the load balancer. Because a server cut off from the others still passes the check, also watch the problem list.

Prometheus metrics#

Each process of the platform serves its metrics in Prometheus format on an internal address. The backend serves them at http://<backend>:8080/metrics inside the hub’s network. The agent serves them at http://127.0.0.1:6006/metrics inside its container. On the names that point at the hub, /metrics returns 404.

Sign in to the live demo

Sign in with the shared viewer account. It can open every screen of the example projects but can't change anything.

E-mail
viewer@demo.weik.io
Password
try-weikio-live-demo
Open the live demo