Skip to main content

Function: calculateSiteStatus()

function calculateSiteStatus(site: SiteForStatus):
    | "unknown"
    | "degraded"
    | "down"
    | "paused"
    | "pending"
    | "up"
    | "mixed";

Defined in: shared/utils/siteStatus.ts:126

Calculates the overall operational status for a site based on the statuses of its monitors.

Parameters​

site​

SiteForStatus

The SiteForStatus object representing the site to evaluate.

Returns​

"unknown" | "degraded" | "down" | "paused" | "pending" | "up" | "mixed"

The operational status as a SiteStatus value.

Remarks​

The operational status reflects the aggregate health of all monitors:

  • Returns "up" if all monitors are up.
  • Returns "down" if all monitors are down.
  • Returns "degraded" if all monitors are degraded.
  • Returns "pending" if all monitors are pending.
  • Returns "paused" if all monitors are paused.
  • Returns "mixed" if monitors have different statuses.
  • Returns "unknown" if there are no monitors.

Example​

const status = calculateSiteStatus(site);
// status: "up" | "down" | "degraded" | "pending" | "paused" | "mixed" | "unknown"