Arcane.system.metrics()

This focused page is derived from the mechanically checked full member inventory.

Syntax

Arcane.system.metrics()

Parameters

None

Return value

Promise<metrics>

Description

Gets allowed machine metrics.

Overview

Arcane.system.metrics() reads a bounded machine resource snapshot. It requires system.metrics.read on a Core host, changes nothing, and emits no event. Metrics are local-machine data; retain only what the UI needs and do not use them as a stable device fingerprint.

Result

The exact result is {architecture, logicalProcessors, loadAverage, memory, uptimeSeconds}. loadAverage is the operating system's load-average array rounded to three decimals. memory is exactly {totalBytes, freeBytes, usedBytes}, with usedBytes computed as the nonnegative difference. Uptime is the whole number of seconds reported by the OS.

This is an observation, not an admission decision. Local-model APIs apply their own hardware and memory policy; do not infer model eligibility from these values.

Errors and recovery

METHOD_NOT_ALLOWED means the application lacks system.metrics.read. Transport failure means the snapshot is unavailable; keep the last value visibly stale or clear it rather than reporting zero resources.

Example

const metrics = await Arcane.system.metrics();
const freeGiB = metrics.memory.freeBytes / (1024 ** 3);

console.log(metrics.logicalProcessors, `${freeGiB.toFixed(1)} GiB free`);

Reference group

Platform, installation, users, and system