FAIRVISOR Docs
⌘K
GitHub fairvisor.com

fairvisor status

fairvisor status queries a running edge’s /readyz and /metrics endpoints and formats a human-readable summary.

Synopsis

fairvisor status [--edge-url=URL] [--format=table|json]

Options

Flag Env var Default Description
--edge-url FAIRVISOR_EDGE_URL http://localhost:8080 Base URL of the running edge
--format — table Output format: table or json

Table output

Status:          ready
Policy version:  42
SaaS:            connected
Decisions:       15,230

JSON output

{
  "status": "ready",
  "policy_version": 42,
  "saas": "connected",
  "decisions": 15230
}

Fields

Field Source Values
status GET /readyz ready or not_ready
policy_version fairvisor_bundle_version metric integer
saas fairvisor_saas_reachable metric connected (1) or disconnected (0)
decisions fairvisor_decisions_total metric total count across all labels

Examples

# Check local instance
fairvisor status

# Check a remote instance
fairvisor status --edge-url http://edge.internal:8080

# Parse JSON output in scripts
STATUS=$(fairvisor status --format json | jq -r .status)
[ "$STATUS" = "ready" ] || exit 1

Exit codes

Code Meaning
0 Edge is reachable and ready
2 Edge is unreachable or returned non-200

MD