MetriBeacon
Menu

MetriBeacon Agent

Install the agent on your own machine and connect it to a monitor.

On this page

Before installing

Choose the package for your operating system and processor: Linux, macOS 14 or newer, Windows 11 or Windows Server 2022 or newer, with x64 or ARM64. npm installation needs Node.js 22 or newer; native downloads do not. You need permission on your own machine to install a background service. Linux without systemd can use foreground mode.

Install and connect

Open Servers, choose Linux / macOS or Windows and copy the installation command. Run it on your server. The latest released agent, its system service, device key and selected profile are configured automatically; no browser confirmation is needed on the server. Your operating system may ask for administrator approval.

Alternatively, install the CLI with npm or a native download and use the following commands for browser-assisted pairing.

shell
npm install -g metribeacon
metribeacon setup
metribeacon status
# Alternatives: pnpm add -g metribeacon; yarn global add metribeacon

Keep access private

Connecting to an existing account does not create another account. Setup asks separately for device data access and CLI/MCP management access. Keep identity files and keys private and out of command arguments, logs and repositories. A connection code expires after ten minutes; restart setup if it expired.

Select readings

By default, CPU usage, used memory and the system disk are selected every 10 seconds. Detected components are suggestions, not active readings. Add supported disks, network interfaces and other readings in the monitor's server profile. Optional process, file, program, SMART, container or connection checks can need a local permission policy on your own machine. Grant only the exact checks you want.

Choosing a download

Use a package offered for your platform and read its support notice. Packages for Linux ARM64, macOS x64 and Windows ARM64 have not been tested natively. macOS and Windows installers currently lack operating-system code signing and may show a warning. Follow the supplied manifest verification instructions; do not disable system protection globally. If the needed package is unavailable, do not substitute another processor architecture.

Linux, macOS 14+, Windows 11 or Server 2022+, x64 and ARM64. npm requires Node.js 22+.

Loading agent downloads…

Update an installed agent

New native installations enable remote updates with a separate key permission. An icon in the server list appears when a newer approved version is available. The workspace owner confirms each update; wait for confirmation after restart. Configuration-write permission is independent. Temporary contention returns 503 with update_busy and Retry-After: 1. Retry with the same operation_id and confirmed target; the interface retries for up to ten seconds. An accepted request is returned again without creating another update. The opaque target_id binds the approved release and source installation/version; refresh and confirm again if they change.

Native services enable owner-confirmed remote updates by default. A local administrator can use metribeacon agent remote-updates disable, enable or status; a saved local opt-out is preserved. “Allow remote updates” can also be disabled for the server key. npm and foreground installations are updated locally.

For a new native installation with an existing server key, use setup --non-interactive --device-id SERVER_ID --key-file /protected/device.key with an authenticated management identity. Setup enables the update permission once. The key must be active and limited to that server; broad or revoked keys cannot be reused. Restarts and normal updates do not change permissions.

Older installations need one local upgrade first. After upgrading, run metribeacon agent remote-updates enable as an administrator to install the updater. Offline servers are never queued for an unexpected later update.