Skip to main content
hirocli metrics provides terminal access to the workspace server’s resource monitoring. It communicates with the running server over HTTP, so the server must be running with metrics enabled.
Metrics collection is disabled by default. Enable it persistently with hirocli setup --metrics or for a single run with hirocli start --metrics. See Setup and uninstall and Server ops.

​
status

hirocli metrics status --workspace <name>
Shows the metrics collector’s current configuration and runtime state. Output includes:
  • whether the collector is enabled
  • collection interval in seconds
  • ring buffer capacity and current fill count
  • how long the collector has been running

​
Options

OptionDescription
--workspace, -WTarget workspace name.

​
Example

hirocli metrics status --workspace home

Metrics collector status
Enabled          true
Interval         2.0 s
History size     1800
History count    423
Uptime           14 min 6 s

​
snapshot

hirocli metrics snapshot --workspace <name>
Fetches and displays the latest metrics snapshot as a formatted table. The snapshot covers:
  • Server process — CPU percent, RSS memory, virtual memory, thread count
  • Channel plugins — per-plugin CPU, RSS, thread count, alive status
  • Disk — usage percent, read rate, write rate
  • Network — bytes sent/received per second, packet rates
  • System-wide — total CPU percent, memory used/total

​
Options

OptionDescription
--workspace, -WTarget workspace name.

​
Example

hirocli metrics snapshot --workspace home

​
live

hirocli metrics live --workspace <name> [--interval N]
Opens a live-updating terminal dashboard that polls GET /metrics and refreshes the display in place. Press Ctrl+C to stop. The dashboard is rendered with rich and uses the same table layout as snapshot, refreshing at the specified interval.

​
Options

OptionDescription
--workspace, -WTarget workspace name.
--intervalRefresh interval in seconds. Defaults to 2.

​
Example

# Live dashboard, refresh every 2 seconds (default)
hirocli metrics live --workspace home

# Slower refresh to reduce noise
hirocli metrics live --workspace home --interval 5

​
Enabling metrics

Metrics collection is controlled at two levels:

​
Persistent (written to config.json)

# Enable metrics and save to config
hirocli setup --workspace home --metrics

# Enable with a custom interval
hirocli setup --workspace home --metrics --metrics-interval 5.0

# Disable metrics in config
hirocli setup --workspace home --no-metrics

​
Ephemeral (for a single server run)

# Start with metrics on — not saved to config
hirocli start --workspace home --metrics

# Start with admin UI and metrics together
hirocli start --workspace home --admin --metrics

# Restart with metrics on
hirocli restart --workspace home --metrics
The --metrics flag on start and restart behaves the same as --admin: it overrides the config value for that server run without persisting the change.

​
Runtime configure

While the server is running, you can toggle metrics or change the interval without restarting: 
# Enable at runtime
curl -X POST http://localhost:18080/metrics/configure \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

# Change interval
curl -X POST http://localhost:18080/metrics/configure \
  -H "Content-Type: application/json" \
  -d '{"interval": 5.0}'
The change takes effect immediately. The admin UI’s Metrics page also exposes these controls visually.
For architecture details — how the collector is implemented, what each metric measures, and the REST API contract — see Metrics monitoring.