JSON Specification for SSP Processed and Aggregated Metrics

The JSON specification for the Shared Storage Pool (SSP) processed and aggregated metrics. All the parameters for the Processed and Aggregated metrics are same except that the Processed metrics provides only Average value, while Aggregated metrics provide Average, Maximum, and Minimum values.

PCM Processed or aggregated metrics URI provides the following SSP utilization data when the AggregationEnabled attribute for an SSP is enabled.

Resource

/rest/api/pcm/ProcessedMetrics/SharedStoragePool_[SSPUuid]_yyyyMMDDThhmmss+0000_300.json

/rest/api/pcm/AggregatedMetrics/SharedStoragePool_[SSPUuiD]_yyyyMMDDThhmmss+0000_

[Tier frequency in seconds].json

Response

{

	"systemUtil":{

		"utilInfo":{

			"version":"String",

			"metricType":"String",

			"frequency":"Number",

			"startTimeStamp":"String",

			"endTimeStamp":"String",

			"uuid":"String",

			"name":"String",

			"poolId":"String",

			"clusterId":"String",

			"clusterName":"String",

			"clusterUuid":"String",

			"metricArrayOrder":[ "AVG", "MIN", "MAX"]

		},

		"utilSamples":[{

			"poolUtil":{

				"nodeUtil":[{

					"id":"Number",

					"name":"String",

					"mtms":"String",

					"poolState":"String",

					"tierUtil":[{

						"id":"Number",

						"name":"SYSTEM",

						"failureGrpUtil":[{

							"id":"String",

							"name":"Default",

							"diskUtil":[{

								"name":"String",

								"id":"String",

								"uid":"String",

								"adapterName":"String",

								"timeSpentInWaitQueue":[ "Float", "Float", "Float" ],

								"numofTimesServiceQueueIsFull":[ "Float", "Float", "Float" ],

								"size":["Float", "Float", "Float"],

								"free":["Float", "Float", "Float" ],

								"numOfReads":["Float", "Float", "Float" ],

								"numOfWrites":["Float", "Float", "Float" ],

								"readBytes":["Float", "Float", "Float"],

								"writeBytes":["Float", "Float", "Float" ],

								"transmittedBytes":["Float", "Float", "Float" ],

								"numOfReadRequestTimeouts":["Float", "Float", "Float"],

								"numOfReadRequestFailures":["Float", "Float", "Float"],

								"numOfWriteRequestTimeouts":["Float", "Float", "Float" ],

								"numOfWriteRequestFailures":["Float", "Float", "Float" ],

								"numOfReadTransfers":["Float", "Float", "Float" ],

								"numOfWriteTransfers":["Float", "Float", "Float" ],

								"readServiceTime":["Float", "Float", "Float" ],

								"writeServiceTime":["Float", "Float", "Float" ]

							}],

							"size":["Float", "Float", "Float" ],

							"free":["Float", "Float", "Float" ],

							"numOfReads":["Float", "Float", "Float" ],

							"numOfWrites":["Float", "Float", "Float"],

							"readBytes":["Float", "Float", "Float" ],

							"writeBytes":["Float", "Float", "Float" ],

							"transmittedBytes":["Float", "Float", "Float" ],

							"numOfReadRequestTimeouts":["Float", "Float", "Float" ],

							"numOfReadRequestFailures":["Float", "Float", "Float" ],

							"numOfWriteRequestTimeouts":["Float", "Float", "Float" ],

							"numOfWriteRequestFailures":["Float", "Float", "Float" ],

							"numOfReadTransfers":["Float", "Float", "Float" ],

							"numOfWriteTransfers":["Float", "Float", "Float" ],

							"readServiceTime":["Float", "Float", "Float" ],

							"writeServiceTime":["Float", "Float", "Float" ]

						}],

						"size":["Float", "Float", "Float" ],

						"free":["Float", "Float", "Float" ],

						"numOfReads":["Float", "Float", "Float" ],

						"numOfWrites":["Float", "Float", "Float" ],

						"readBytes":["Float", "Float", "Float" ],

						"writeBytes":["Float", "Float", "Float"],

						"transmittedBytes":["Float", "Float", "Float" ],

						"numOfReadRequestTimeouts":["Float", "Float", "Float" ],

						"numOfReadRequestFailures":["Float", "Float", "Float"],

						"numOfWriteRequestTimeouts":["Float", "Float", "Float"],

						"numOfWriteRequestFailures":["Float", "Float", "Float"],

						"numOfReadTransfers":["Float", "Float", "Float"],

						"numOfWriteTransfers":["Float", "Float", "Float"],

						"readServiceTime":["Float", "Float", "Float"],

						"writeServiceTime":["Float", "Float", "Float"]

					}],

					"size":["Float", "Float", "Float"],

					"free":["Float", "Float", "Float"],

					"numOfReads":["Float", "Float", "Float"],

					"numOfWrites":["Float", "Float", "Float"],

					"readBytes":["Float", "Float", "Float"],

					"writeBytes":["Float", "Float", "Float"],

					"transmittedBytes":["Float", "Float", "Float"],

					"numOfReadRequestTimeouts":["Float", "Float", "Float"],

					"numOfReadRequestFailures":["Float", "Float", "Float"],

					"numOfWriteRequestTimeouts":["Float", "Float", "Float"],

					"numOfWriteRequestFailures":["Float", "Float", "Float"],

					"numOfReadTransfers":["Float", "Float", "Float"],

					"numOfWriteTransfers":["Float", "Float", "Float"],

					"readServiceTime":["Float", "Float", "Float"],

					"writeServiceTime":["Float", "Float", "Float"]

				}],

				"size":["Float", "Float", "Float"],

				"free":["Float", "Float", "Float"],

				"numOfReads":["Float", "Float", "Float"],

				"numOfWrites":["Float", "Float", "Float"],

				"readBytes":["Float", "Float", "Float"],

				"writeBytes":["Float", "Float", "Float"],

				"transmittedBytes":["Float", "Float", "Float"],

				"numOfReadRequestTimeouts":["Float", "Float", "Float"],

				"numOfReadRequestFailures":["Float", "Float", "Float"],

				"numOfWriteRequestTimeouts":["Float", "Float", "Float"],

				"numOfWriteRequestFailures":["Float", "Float", "Float"],

				"numOfReadTransfers":["Float", "Float", "Float"],

				"numOfWriteTransfers":["Float", "Float", "Float"],

				"readServiceTime":["Float", "Float", "Float"],

				"writeServiceTime":["Float", "Float", "Float"]

			},

			"sampleInfo":{

				"timeStamp":"String",

				"numOfSamplesAggregated":"Number",

				"status":"Number"

			}

		}]

	}

}

The following tables provides the details of the metrics.

Table 1. Descriptions of the metric parameters
Metric parameter	Description
Version	Version of JSON format for SSP. The value is 1.0.0 for the first release.
metricType	This indicates whether the values are Raw, Processed, or Agregated metrics.
frequency	Indicates the collection cycle time in seconds.
startTimeStamp	Start timestamp of the samples collected.
endTimeStamp	End timestamp of the samples collected.
uuid	UUID of the SSP.
name	SSP name.
poolId	Pool ID.
clusterName	Cluster name.
clusterId	Cluster ID.
clusterUuid	Cluster UUID.
metricArrayOrder	The values are AVG, MIN, and MAX. For Processed metrics, the value is AVG.
utilSamples: poolUtil: Containing sample of Processed and Aggregated SSP metrics.
size	Average size of the disks that belong to the SSP in megabytes.
Free	Total free size of the disks that belong to the SSP in megabytes.
DISK METRICS Utilization	Total of all disks utilization metrics in the specific failure group. See the Disk metrics table for details on each utilization metric.
utilSamples: poolUtil: NodeUtil: Metrics in this tag should be the total of all the SSP Disks utilization in this Node.
id	VIOS node ID.
mtms	Machine and serial number.
name	VIOS node name.
state	State of the VIOS node. The values are Running and Not Running.
poolState	State of the pool in this node. The values are UP or DOWN.
FailureGroupUtil
id	Failure group ID.
name	Failure group Name.
size	Size of the disks that belong to this node in megabytes.
free	Free size of the disks that belong to this node in megabytes.
DISK METRICS UTILIZATION	The total of all disks utilization metrics in this failure group. See the Disk metrics table for details on each utilization metric.
utilSamples: poolUtil: NodeUtil:TierUtil
Id	Tier ID.
Name	Tier name.
Size	Total size of disks in the tier in megabytes. This does not include all the disks that belongs to the failure groups of the tier.
Free	Free size of the disks in this tier in megabytes. This includes all the disks that belongs to the failure groups of the tier.
DISK METRICS Utilization	The total of all disks utilization in this tier. See the Disk metrics table for details on each utilization metric.
utilSamples: poolUtil: NodeUtil: TierUtil :FailureGroupUtil
Id	Failure group ID.
Name	Failure group name.
Size	Size of disks in the failure group in bytes.
Free	Free size of the disks in this failure group in bytes.
DISK METRICS UTILIZATION	The total of all the disks utilization metrics in this failure group. See the Disk metrics table for details on each utilization metric.
utilSamples: poolUtil: NodeUtil: TierUtil :FailureGroupUtil DiskUtil
id	Disk-unique device identifier.
UID	Unique universal identifier.
Name	Disk name.
adapterName	Name of the adapter to which the disk belongs.
Size	Size of the disk in megabytes.
free	Free size of the disk in megabytes.
DISK METRICS Utilization	Disk Utilization metrics of this disk. See the Disk metric table for details on each utilization metric.
utilSamples: sampleInfo
timeStamp	Timestamp of the sample
numOfSamplesAggregated	This attribute is only present for Aggregated metrics.
status	Status can have one of the following values: 0: all collections are successful 1: all collections have failed 2: part of the collection is successful

Table 2. Descriptions of the Disk metric parameters
Metric parameter	Description
numofReads	Total number of reads.
numofWrites	Total number of writes.
readBytes	Total bytes read.
writeBytes	Total bytes written.
serviceQueueDepth	Number of times a request is sent to the disks that are not completed yet. This parameter is available only in DiskUtil metric.
numofTimesServiceQueueIsFull	Number of times when the service queue full event has occurred. This parameter is available only in DiskUtil metric.
readServiceTime	Read service time in nanoseconds.
numofReadRequestTimeouts	Number of read request timeouts.
numofReadRequestFailures	Number of failed read requests.
minReadServiceTime	Minimum read service time in nanoseconds.
writeServiceTime	Write Service time in nanoseconds.
minWriteServiceTime	Minimum write service time in Nanoseconds.
maxWriteServiceTime	Maximum write service time in Nanoseconds.
numofWriteRequestTimeouts	Number of write request timeouts.
numofWriteRequestFailures	Number of failed write requests .
waitQueueSize	Number of requests waiting to be sent to disk. This parameter is available only in DiskUtil metric.
totalWaitQueuesize	Accumulated sampled wait queue depth. This parameter is available only in DiskUtil metric.
timeSpentInWaitQueue	Accumulated wait queue time. This parameter is available only in DiskUtil metric.
minTimeSpentInWaitQueue	Minimum wait queue time. This parameter is available only in DiskUtil metric.
maxTimeSpentInWaitQueue	Maximum wait queue time. This parameter is available only in DiskUtil metric.
TotalServiceQueueDepth	Accumulated service queue depth. This parameter is available only in DiskUtil metric.
NumOfReadTransfers	Number of read transfers.
NumOfWriteTransfers	Number of write transfers.

Last updated: Fri, June 23, 2017