JSON specification for Energy Monitoring Processed and Aggregated Metrics

All the parameters for the Processed and Aggregated metrics are same except that the Processed metrics provides only Average metrics, and it does not provide minimum and maximum records. The PCM Processed or Aggregated metrics URI for Energy Monitoring provides the following power consumption and thermal data when the AggregationEnabled parameter is enabled for a managed system.

Resource

/rest/api/pcm/ProcessedMetrics/EnergyMetrics_ManagedSystem_[Managed System Uuid]_
yyyyMMDDThhmmss+0000_yyyyMMDDThhmmss+0000_30.json
/rest/api/pcm/AggregatedMetrics/EnergyMetrics_ManagedSystem_[Managed System Uuid]_
yyyyMMDDThhmmss+0000_yyyyMMDDThhmmss+0000_[Tier frequency in seconds].json

Response

{
	"systemUtil": {
		"utilInfo": {
			"version": "String",
			"metricType": "String",
			"frequency": Number,
			"startTimeStamp": "String",
			"endTimeStamp": "String",
			"mtms": "String",
			"name": "String",
			"metricArrayOrder": ["AVG", "MIN", "MAX"],
			"uuid": "String"
		},
		"utilSamples": [{
			"sampleType": "ManagedSystem",
			"energyUtil": {
				"powerUtil": {
					"powerReading": [Float, Float, Float]
				},
				"thermalUtil": {
					"inletTemperatures": [{
							"entityId": "String",
							"entityInstance": "String",
							"temperatureReading": [Float, Float, Float]
					}],
					"cpuTemperatures": [{
							"entityId": "String",
							"entityInstance": "String",
							"temperatureReading": [Float, Float, Float]
					}],
					"baseboardTemperatures": [{
							"entityId": "String",
							"entityInstance": "String",
							"temperatureReading": [Float, Float, Float]
					}]
				}
			},
			"sampleInfo": {
				"timeStamp": "String",
				"numOfSamplesAggregated": Number,
				"status": Number
			}
		}]
	}
}
Table 1. Description of metric parameters
Metric name Description
Version Version of JSON format for Energy Monitoring.
metricType Type of the sample. The values are Processed or Aggregated.
frequency The collection cycle in seconds.
startTimeStamp Start Timestamp of the samples collected
endTimeStamp End Timestamp of the samples collected
uuid UUID of the Managed System
name name of the Managed System
mtms Machine Type, Model, and Serial number of the Managed System
metricArrayOrder AVG, MIN, and MAX. For Processed metrics, the value is AVG
utilSamples: Containing sample of Processed or Aggregated Energy Monitoring metrics.
sampleType Type of the sample. The value is ManagedSystem
energyUtil Contains the Energy & Power related data
powerUtil Power consumption data
powerReading Power consumed by the system for the specific interval, in watt
thermalUtil Data related to heat generated by the managed system
inletTemperatures Generated heat data for the Inlet
cpuTemperatures Generated heat data for the CPUs
baseboardTemperatures Generated heat data for the Baseboards
entityId The ID of the entity. The value can be Inlet, CPU, or Baseboard.
entityInstance Instance name of the entity. The value can be Inlet, CPU, or Baseboard.
temperatureReading Heat generated by the entities for the time interval, in Celsius
utilSamples: sampleInfo
timeStamp Timestamp of the sample
numOfSamplesAggregated Number of samples that are rolled up to get the sample. This attribute is available only for Aggregated metrics.
status The valid values are:
  • Status 0: all collections were success
  • Status 1: all collections were failed
  • Status 2: part of the collection was success