Fathym
Menu
fAIOpenXThe LoopHolonicAboutDocsBlogLog in to OpenX
Docs menu

Workspace status

Goal: See at a glance how each part of your workspace is doing, and open any part to see the things behind its answer.

Each part of your workspace (its databases, its connected devices, its sign-in setup, its mail, its provenance log and any part added later) reports how it is doing. OpenX puts those reports together in one place: the Status panel, with a page for each part.

Open the Status panel

Choose Workspace > Status. The panel opens floating; drag its title bar to dock it, as with any panel. It reads the status when it opens, when you come back to its tab and when something in the workspace changes; while the tab is in front of you it also reads about once a minute. A tab in the background reads nothing. See How the workspace stays up to date.

The top line is the whole workspace: OK, Needs attention, Problem or Unknown. Below it, each part has its own line, with how many of its things are in each state, for example "1 problem, 2 ok".

  • Unknown never means fine. A part whose report could not be read shows "This part of the workspace status could not be read." and counts as unknown.
  • This status may be out of date shows when the last report is more than two minutes old. An old report reads Unknown at best, but an old Problem stays a Problem.
  • A workspace that has not reported yet says so: "The workspace has not reported how it is doing yet."

Closed it? Workspace > Status brings it back.

A page for each part

The status pages list every part, including parts that are not shown in the panel, each with a link to its own page. They live at your workspace's address followed by /status, for example https://<your workspace address>/workspace/status.

A part's page shows each of its things: its name, its state, what is wrong when something is, and when that was last known. A part with nothing to list says "Nothing to list." An address naming a part your workspace does not have says so; it never shows an empty page.

Details hidden

Whoever may see how the workspace is doing sees every part's summary: its state and its counts. The things behind a part are shown only to someone who may read them. When a caller does not hold the right a part asks for, that part keeps its summary and names the missing right: "Details hidden: needs" and the right's name. "A or B" means either right is enough; "A and B" means both are needed.

The whole workspace's state still counts every part, hidden or not, so a hidden part with a problem still shows in the top line.

Today this applies to programs that call your workspace's API (GET /ox-api/status) with an API key or an app identity. People signed in to the workspace see every part in full.

On this page