Skip to content

Status badges and health checks

In the admin: Dashboard, open an app, then Badge.

A badge is the small pill on an app tile. Each app can have three kinds.

The Badge section of an app: Health Check, Fixed Label and Live ActivityThe Badge section of an app: Health Check, Fixed Label and Live Activity

Shows whether the service is up.

  • Ping reads the HTTP status of a URL.
  • Container reads the container state from Docker. It needs a socket proxy such as docker-socket-proxy, its address in SOCKET_PROXY_URL, and Docker Container Health Checks on in General. Never mount the Docker socket into Stackyard.

A problem shows a red !. Hover it for the reason. Turn on Hide Healthy Badge in General to hide the green state.

Up to 10 characters of text, in a colour you pick.

Badge colours are Accent, Success, Warning, Danger and Info. Each is drawn for the display mode it is shown in. The colour wheel opens the system colours and a colour code for anything else.

A number from any API. Enter the API URL, add a header if the API needs a key, and press Fetch. Stackyard lists every number in the response. Pick one.

Tick Secret on a header to keep its value on the server. Poll sets how often it reads, in seconds.

One API can feed up to five values. Press Add Label for each.

Two labels, each with Value, Label Text, Color, Unit and Show FromTwo labels, each with Value, Label Text, Color, Unit and Show From
  • Show From keeps a value hidden below that count.
  • The tile shows the first value that has something to report. A second pill behind it means more.
  • Hover, tap or focus the badge to list all values.
  • Show as a Single Badge adds them into one number.

Counts above 99 show as 99+.

A tile draws one badge. If an app has a health check, a fixed label and live activity together, the tile shows the first that applies:

OrderBadgeWhen it shows
1Health problemThe service is down. It hides everything else, so a fault is never masked by a number.
2Live activityA value has reached its Show From.
3Fixed labelNothing above applies.
4Healthy dotThe service is up and nothing else shows. Hidden by Hide Healthy Badge.

The others stay available in the list that opens on hover or tap.

A folder shows the badge of the app inside it that is reporting.

When a poll fails, the last value stays on the tile, dimmed with a dashed outline. A failed poll never reads as zero.