[MINIFICPP-1504] Add Resource consumption data to heartbeats

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.10.0
• Assignee: Martin Zink
• Reporter: Martin Zink
• Created: 18/Feb/21 09:32
• Updated: 03/Jun/21 13:30
• Resolved: 18/May/21 08:34

Description

It would be beneficial to add CPU utilization and RAM consumption to the heartbeat. So the C2 server can monitor how much resources does the agent, and the agent's host(overall) consume.

Currently the heartbeat already contains the number of vCores, and the total RAM of the system.

Here are the proposed changes to the heartbeat JSON in the C2 Protocol:

 

...
  "deviceInfo": {
    "identifier": "",
    "systemInfo": {
       "physicalMem": 8360783872,
       "vCores": 4,
       // New fields to be added below.
       // cpuUtilization 
         // - a normalized (max == 100%) percentage value 
         // - passed as floating point in the range [0.0, 1.0]
         // - the agent would average a sliding window of system values taken at some interval
       // memoryUtilization
         // - bytes in use, whatever the system reports.
         // could exceed max physical memory due to virtual mem / swap on host.
      "cpuUtilization": 0.50,
      "memoryUtilization": 7360783872
    },
    "networkInfo": {
     ...
    }
  },
  "agentInfo": {
    ...
    "status": {
      ...
      // New nested object to be added below.
      // Same as values in systemInfo, but for the minifi agent process only
      // cpuUtilization 
        // - a normalized (max == 100%) percentage value 
        // - passed as floating point in the range [0.0, 1.0]
        // - agent will average a sliding window of system values taken at some interval
      // memoryUtilization
        // - bytes in use, whatever the system reports. 
        // could exceed max physical memory due to virtual mem / swap on host.
     "resourceConsumption": {
       "cpuUtilization": 0.10,
       "memoryUtilization": 1360783872
     },
   }
...

These new field would be optional (maybe configurable?)

This should work on all supported platforms and return platform-independent information to the C2.