Skip to content

Latest commit

 

History

History
163 lines (135 loc) · 4.21 KB

reports.md

File metadata and controls

163 lines (135 loc) · 4.21 KB

Reports

PowerAPI toolkit is modular, which means any sensor can be plugged to any monitoring tool as long as the needed information is provided. We fixed the way of encoding the information. Those encoding are called Reports.

A report type specify the json fields that has to be provided to pass information of a certain kind. All reports types have a common basis:

  • timestamp: at the format "YYYY-MM-DDThh:mm:ss.sss". The timestamp indicates when the data was collected, not when it was processed.

  • target: The target refers to the entity being measured. For example, if a report contains data related to a specific program, domain, or other entity, the target identifies that subject. In this context, it corresponds to the cgroup name.

  • sensor: it's a name field that is used to identify the reports produced by or computed thanks to a sensor.

Therefore, a report shall match the following description:

{  
  "timestamp":$timestamp,
  "target":$target,
  "sensor":$sensor,
  $report_specific_fields
}

A valid JSON-Schema to can be found here.

In the following sections we specify the $report_specific_fields for each type of report.

HWPC Reports

A HWPC Report is used to report performance counters and RAPL. Its specific fields are the following:

  • groups: a list of subreport that can be of three kind, rapl, core and msr.

    Each group is represented in the same way:

  {
    $type: {
      $core_number : {
        $socket_number : {
          Each counter name and their measured value for the type/core_number/socket_number considered triplet
        }
      }
    }
  }

Below you can find an example of HWPC Report:

{
  "timestamp": "2023-01-13T09:51:22.630",
  "sensor": "sensor_test",
  "target": "influxdb",
  "groups": {
    "core": {
      "0": {
        "0": {
          "CPU_CLK_THREAD_UNHALTED:THREAD_P": 75510,
          "CPU_CLK_THREAD_UNHALTED:REF_P": 2271,
          "time_enabled": 167403,
          "time_running": 167403,
          "LLC_MISSES": 1077,
          "INSTRUCTIONS_RETIRED": 31693
        },
        "1": {
          "CPU_CLK_THREAD_UNHALTED:THREAD_P": 43801,
          "CPU_CLK_THREAD_UNHALTED:REF_P": 1318,
          "time_enabled": 99324,
          "time_running": 99324,
          "LLC_MISSES": 750,
          "INSTRUCTIONS_RETIRED": 15011
        }
      }
    }
  }
}
{
  "timestamp" : "2023-01-13T09:51:22.630",
  "sensor" : "sensor_test",
  "target" : "all",
  "groups" : {
    "rapl" : {
      "0" : {
        "1" : {
			      "RAPL_ENERGY_PKG" : 5709496320,
			      "time_enabled" : 1006717449,
			      "time_running" : 1006717449
          }
      }
    },
    "msr" : {
      "0" : {
        "0" : {
          "MPERF" : 29646849,
	        "APERF" : 12319312,
	        "TSC" : 2122153094,
	        "time_enabled" : 1006580601,
	        "time_running" : 1006580601
        },
        "1" : {
          "MPERF" : 20587012,
          "APERF" : 19838920,
          "TSC" : 2122185970,
	        "time_enabled" : 1006560540,
	        "time_running" : 1006560540
        }
      }
    }
  }
}

Power Reports

A Power Report is used to transfer information about power consumption estimations. Its specific fields are the following:

  • power: a power value in Watts.

Below you find an exemple of Power Report:

{
  "timestamp": "2023-01-14T12:37:37.168817",
  "sensor": "formula_group",
  "target": "all",
  "power": 42
}