Skip to main content
Version: 1.2.0

Single Node Deployment: Agent

To download, install, and test run the VirtualMetric Agent binary, follow the instructions below.

System Requirements​

VirtualMetric applications support the amd64 and arm64 versions of Windows, Linux, and macOS. Their minimum requirements are:

  • CPU: 1 core - We recommend using a machine with at least 2 CPU cores. As our system uses a vectorized pipeline and can utilize all available cores, having multiple cores will improve performance

  • Memory: 150MB - Depending on the volumes you need to handle, more memory will improve performance

  • Disk: 250MB - Depending on the amount of temporary data you need storage, more disk space will improve performance

    If you need to retain logs for extended periods or minimize potential data loss in case of unexpected failures, consider allocating additional disk space accordingly.

Agent is a single binary that requires no dependencies, so you can easily download and place it anywhere on your system. It can be installed on a traditional server, on an on-premises virtual machine, or in the cloud. It can also be deployed as an Azure App Service for a serverless configuration.

Installation​

You can install Agent online or offline, depending on your system's internet access.

info

In both the online and offline procedures below, we will assume you will use our default installation directory for your platform.

PlatformDefault Installation Directory
WindowsC:\Program Files\VirtualMetric
Linux/opt/virtualmetric
macOS/Applications/virtualmetric

However, if you choose to install the package elsewhere, just replace these with the directory of your choice which you must create beforehand.

This guide assumes you are installing Agent as a service. If you do not have the necessary privileges to run it as a service, you can configure Agent to run as a Scheduled Task (on Windows) or a Cron job (on Linux/macOS) to ensure it starts automatically after a reboot.

caution

Agent does not require administrative privileges to run as a background process. However, if you choose to install it as a service, administrative privileges are required.

Once installed, you can run Agent as a service with regular user privileges.

Online​

If your system has internet access, you can use our automated installation scripts for a quick setup.

To install as a background process:

Invoke-WebRequest dl.vget.me | Invoke-Expression

To install as a service:

$p="C:\Program Files\VirtualMetric"
Invoke-WebRequest dl.vget.me | Invoke-Expression
note

The dl.vget.me file contains our official installation script that performs the steps listed below.

The script will

  • detect your operating system and architecture
  • download the appropriate version
  • install and configure the binary based on your selected method (service or background process)
  • launch the executable

Offline​

For systems without internet access, you can download and install Agent manually. Choose the appropriate binary for your system from the table below:

Operating SystemDownload Link
WindowsAgent for AMD64
Agent for ARM64
LinuxAgent for AMD64
Agent for ARM64
macOSAgent for AMD64
Agent for ARM64

Once you have downloaded the binary, open a terminal with admin privileges. Choose or create the directory where you want to run Agent if you haven't already done so, and copy the downloaded binary to it. Then, navigate to that directory.

Copy-Item -Path %USERPROFILE%\Downloads\vmetric-agent.exe -Destination "C:\Program Files\VirtualMetric"
Set-Location "C:\Program Files\VirtualMetric"

Post-Installation​

Once you are done with the placement of the binary, you have to decide whether you want to run the application as a service or in the background.

As a regular user, you can run Agent as a background process:

.\vmetric-agent -background

If you do have the required (i.e. administrative) privileges, you can install/uninstall Agent as a service with the following command:

.\vmetric-agent -service [install | uninstall]

Then, you can start/stop the service like so:

.\vmetric-agent -service [start | stop]
warning

Do not use Stop-Process or kill (using a ProcessId orPID) as this may corrupt the data of running processes.

You can verify its status by using the following commands:

The Status column will display Running or Stopped

Get-Service vmetric-agent

Status   Name               DisplayName
------   ----               -----------
Running  vmetric-agent      VirtualMetric Agent
Back To Introduction