README.md

StatUtils

Collection of utilities for querying hardware statistics and information for Anvil! systems;

perfmonitor

Perfomonitor is a server returning system performance data upon a request;

Release

Navigate to releases page to grab the latest version of perfmonitor. Platform-specific bundles contain ready-to-use executables as well as instructions on how to install it on the target system.

HTTP Interface

Current performance stats can be accessed at HTTP port :9159 & route /sysstats:

$ curl -i "http://{{vm_host}}:9159/sysstats"

On both platforms, stats include the following performance indicators:

• cpu utilization — % Processor Time is the percentage of elapsed time that the processor spends to execute a non-Idle thread (CPU Utilization, see Microsoft Docs)
• memory available (in bytes)
• disk size, used and freeSpace (all in bytes)

For windows, instanceName indicates cpu instance and deviceID stores disk drive letter:

{
   "status": "success",
   "message": "",
   "data": {
      "system": {
         "machine": "win.host",
         "platform": "windows",
         "softwareVersion": "0.0.0"
      },
      "cpu": {
         "stats": [
            {
               "counterType": "Timer100NsInverse",
               "defaultScale": "0",
               "instanceName": "_total",
               "multipleCount": "1",
               "path": "\\\\desktop-fo9p270\\processor information(_total)\\% processor time",
               "rawValue": "689984375000",
               "secondValue": "132054295798539933",
               "status": "0",
               "timeBase": "10000000",
               "timestamp": "6\/19\/2019 10:52:59 AM",
               "timestamp100NSec": "132054151798539933",
               "utilization": "9.41475786277403"
            }
            { ... }
         ],
         "date": "20190619145258" // UNIX timestamp in UTC
      },
      "disk": {
         "stats": [
            {
               "deviceID": "C:",
               "freeSpace": "18850095104",
               "size": "42340446208",
               "used": "23490351104"
            },
            { ... }
        ],
         "date": "20190619145256"
      },
      "memory": {
         "stats": [
            {
               "counterType": "NumberOfItems64",
               "defaultScale": "4294967290",
               "instanceName": "",
               "multipleCount": "1",
               "path": "\\\\desktop-fo9p270\\memory\\available bytes",
               "rawValue": "1515257856",
               "secondValue": "0",
               "status": "0",
               "timeBase": "10000000",
               "timestamp": "6\/19\/2019 10:52:58 AM",
               "timestamp100NSec": "132054151780150000",
               "available": "1515257856"
            }
         ],
         "date": "20190619145256"
      }
   }
}

Identification of hardware devices on linux differs from the windows output (for example, cpuName for cpu stats along with a combination of filesystem and mounted can be used). Note that disk query reports slightly modified df command output and you will need to filter out some filesystems.

{
   "status": "success",
   "message": "",
   "data": {
      "system": { ... },
      "cpu": {
         "stats": [
            {
               "cpuName": "cpu1",
               "utilization": "16.580311"
            },
            { ... }
         ],
         "date": "20190619145258"
      },
      "disk": {
         "stats": [
            {
               "1B-blocks": "229397671936",
               "filesystem": "/dev/mapper/fedora_localhost--live-home",
               "freeSpace": "175291777024",
               "mounted": "/home",
               "size": "229397671936",
               "use%": "20%",
               "used": "42381766656"
            },
            { ... }
        ],
         "date": "20190619145256"
      },
      "memory": {
         "stats": [
            {
               "available": "16094851072",
               "total": "33646678016",
               "used": "16707964928"
            }
         ],
         "date": "20190619145256"
      }
   }
}

You can find os of the vm perfmonitor is running on by querying:

$ curl -i "http://{{vm_host}}:9159/platform"

{
   "status": "success",
   "message": "",
   "data": {
      "machine":"my.hostname",
      "platform":"linux", // or "windows"
      "softwareVersion": "0.2.0" // perfmonitor version
   }
}

Development

Building & development requires golang binary release present on your system, navigate to the official "Getting Started" page to grab the latest version.

Note that it can be installed on fedora systems as:

$ dnf install golang -y

Package Installation

Grab the latest perfmonitor by running:

# installs in ~/go/src/github.com/Seneca-CDOT/StatUtils
go get github.com/Seneca-CDOT/StatUtils 

Compilation

The .exe can be built for windows (on linux) as:

GOOS=windows GOARCH=amd64 go build -o perfmonitor.exe

Or it can be compiled on windows as:

$env:GOOS="windows"; $env:GOARCH="amd64";C:\Go\bin\go build -o perfmonitor.exe

Linux executable can be created with the following command:

GOOS=linux GOARCH=amd64 go build -o perfmonitor

Running Windows

Open PowerShell as Administrator and run the following command:

Set-ExecutionPolicy RemoteSigned

Start perfmonitor by running:

./perfmonitor.exe

Running Linux

Start perfmonitor by running:

./perfmonitor

Pushing new Release

Executables for the app can be automatically packaged & released on github releases page. A new build/release pipeline can be triggered by bumping app version returned by perfmonitor -version command (AppVersion defined in perfstats/sysstat.go). Build results can be viewed on StatUtils build page.