Skip to main content
The VMS agent collector runs on the customer host to collect metrics, checks, and logs, then pushes them to VMS Master over HTTPS.

​
Agent Deployment Overview

VMS Agent Deployment

​
Prerequisites (Agent)

​
Deployment Flow on Linux

1

1. Run the install script

  • Step: On the target host, run the script (no sudo required):
  • Check: The script prints Step 1/6 ... 6/6 progress.
  • Result: SUCCESS (verified): vms-monitor-agent <version> installed. Output of the agent install script on Linux
2

2. Check the service

  • Step: Query the service status:
  • Check: Status shows active (running).
  • Result: Binary at ~/.local/bin/vms-monitor-agent, config at ~/.config/vms-monitor-agent/agent.env. vms-monitor-agent service active and running
3

3. Verify connection logs

  • Step: Tail live logs:
  • Check: Look for the agent started line with agentKey, probes, and configVersion.
  • Result: A JSON log line appears, e.g.:
    JSON "agent started" log on Linux
Once installed, the agent appears in Agent Config (FLEET) on the Dashboard (https://<VMS_MASTER_IP>/dashboards/agent-config): Agent online in the FLEET panel on the Dashboard

​
Deployment Flow on Windows

1

1. Run the install script

  • Step: Open PowerShell (no Administrator required):
  • Check: The script prints Step 1/6 ... 6/6 progress.
  • Result: SUCCESS (verified): vms-monitor-agent <version> installed.
2

2. Check the agent status

  • Step: Inspect the auto-start task and the agent process:
  • Check: The task exists and an agent process is running.
  • Result: Binary at %LOCALAPPDATA%\vms-monitor-agent\vms-monitor-agent.exe.
3

3. Check logs / version

  • Step: Print the version:
  • Check: Prints version, commit, and build date.
  • Result: Agent is online on the Dashboard.

​
Managing the agent from the command line

After install, open a new terminal/PowerShell and use the vms-monitor-agent command (no sudo/Administrator needed). status shows whether the agent is installed / running / auto-start / version: Output of vms-monitor-agent status stop (permanent) then start again — notice running and auto-start change accordingly: Agent stop and start lifecycle
stop is permanent: it stops the process and disables auto-start. The agent does not come back after a reboot. Use start to resume or uninstall to remove.If command not found, open a new shell or use the full path (~/.local/bin/vms-monitor-agent on Linux, %LOCALAPPDATA%\vms-monitor-agent\vms-monitor-agent.exe on Windows).

​
Updating the agent

Re-run the install command:
  • Linux:
    The script compares versions and asks before replacing the binary. If already up to date, the script reports already current: Re-running the install command when already on the latest version
  • Windows:

​
Uninstalling the agent

Run uninstall from the binary, or re-fetch the script with uninstall:
  • Linux:
    Uninstalling via the vms-monitor-agent uninstall command
  • Windows:

​
Troubleshooting