Health

Maverics exposes a /status endpoint, which can be polled by an external service to determine liveness. A healthy Orchestrator will return an HTTP 200 when a GET request is made to the status endpoint:

curl https://<MAVERICS SERVER>/status

{
    "status": "up"
}

Maverics also periodically produces diagnostic logs, referred to here as ‘heartbeat logs’. Heartbeat logs contain basic diagnostic information, including the Orchestrator ID, version, and config version currently running.

Configuration options

Location

location defines the path that the health endpoint will be served on. If location is unset, the default endpoint of /status is served.

Heartbeat

heartbeat defines the configuration of heartbeat logs. Heartbeat logs periodically produce diagnostic information about the currently running Orchestrator.

By default, heartbeat logs are produced once every minute at the INFO log level.

Disabled

Heartbeat logs are on by default. Set disabled: true to turn off heartbeat logs.

Interval

interval can be used to configure the frequency of heartbeat logs. interval is parsed using Go’s time.Duration format.

Log Level

logLevel is the log level heartbeat logs will be produced on. Can be info or debug.

Examples

In this example, the status endpoint will be served on /status-check.

health:
  location: /status-check
  heartbeat:
    disabled: false
    interval: 3600s
    logLevel: info

Heartbeat log

ts=2025-04-23T18:22:34.923977Z level=info service=telemetry msg=heartbeat orchestrator_id=6ee0965d-fdf1-4d62-b8e7-4c41ec0c23ae orchestrator_version=0.110.0 configuration_version=2.0 cpu_count=10 cpu_usage=1.61 total_memory="32768.00 MB" memory_usage="46.75 MB" active_goroutines=15