JSON specification for the SSP RAW metrics
The Shared Storage Pool (SSP) Raw metric URI provides the utilization data that is retrieved by the Hardware Management Console (HMC) from the Virtual IO Server (Node) of the SSP. The data can be obtained when the MonitorEnabled attribute for an SSP is enabled in the collection preferences.
Resource
/rest/api/pcm/SharedStoragePool/<SSPUuId>/RawMetrics/SSPLTM_ssp_pool_<SSPUuid>_yyyyMMDDThhmmss+0000.jsonResponse
{
"systemUtil":{
"utilInfo":{
"version":"String",
"metricType":"String",
"monitoringType":"String",
"mtms":"String"
},
"utilSample":{
"timeStamp":"String",
"status":"Number",
"errorInfo":[{
"errId":"String",
"errMsg":"String"
}],
"sharedStoragePoolUtil":[{
"name":"String",
"poolId":"String",
"clusterName":"String",
"clusterId":"String",
"size":"Number",
"free":"Number",
"numOfReads":"Number",
"numOfReadTransfers":"Number",
"numofReadRequestTimeouts":"Number",
"numofReadRequestFailures":"Number",
"numOfWrites":"Number",
"numOfWriteTransfers":"Number",
"numofWriteRequestTimeouts":"Number",
"numofWriteRequestFailures":"Number",
"readBytes":"Number",
"writeBytes":"Number",
"readServiceTime":"Number",
"minReadServiceTime":"Number",
"maxReadServiceTime":"Number",
"writeServiceTime":"Number",
"minWriteServiceTime":"Number",
"maxWriteServiceTime":"Number",
"nodeUtil":[{
"id":"String",
"name":"String",
"mtms":"String",
"state":"String",
"poolState":"String",
"size":"Number",
"free":"Number",
"numOfReads":"Number",
"numOfReadTransfers":"Number",
"numofReadRequestTimeouts":"Number",
"numofReadRequestFailures":"Number",
"numOfWrites":"Number",
"numOfWriteTransfers":"Number",
"numofWriteRequestTimeouts":"Number",
"numofWriteRequestFailures":"Number",
"readBytes":"Number",
"writeBytes":"Number",
"readServiceTime":"Number",
"minReadServiceTime":"Number",
"maxReadServiceTime":"Number",
"writeServiceTime":"Number",
"minWriteServiceTime":"Number",
"maxWriteServiceTime":"Number",
"tierUtil":[{
"id":"String",
"name":"String",
"size":"Number",
"free":"Number",
"numOfReads":"Number",
"numOfReadTransfers":"Number",
"numofReadRequestTimeouts":"Number",
"numofReadRequestFailures":"Number",
"numOfWrites":"Number",
"numOfWriteTransfers":"Number",
"numofWriteRequestTimeouts":"Number",
"numofWriteRequestFailures":"Number",
"readBytes":"Number",
"writeBytes":"Number",
"readServiceTime":"Number",
"minReadServiceTime":"Number",
"maxReadServiceTime":"Number",
"writeServiceTime":"Number",
"minWriteServiceTime":"Number",
"maxWriteServiceTime":"Number",
"failuregroupUtil":[{
"id":"String",
"name":"String",
"size":"Number",
"free":"Number",
"numOfReads":"Number",
"numOfReadTransfers":"Number",
"numofReadRequestTimeouts":"Number",
"numofReadRequestFailures":"Number",
"numOfWrites":"Number",
"numOfWriteTransfers":"Number",
"numofWriteRequestTimeouts":"Number",
"numofWriteRequestFailures":"Number",
"readBytes":"Number",
"writeBytes":"Number",
"readServiceTime":"Number",
"minReadServiceTime":"Number",
"maxReadServiceTime":"Number",
"writeServiceTime":"Number",
"minWriteServiceTime":"Number",
"maxWriteServiceTime":"Number",
"diskUtil":[{
"name":"String",
"id":"String",
"uid":"String",
"adapterName":"String",
"size":"Number",
"free":"Number",
"numOfReads":"Number",
"numOfReadTransfers":"Number",
"numofReadRequestTimeouts":"Number",
"numofReadRequestFailures":"Number",
"numOfWrites":"Number",
"numOfWriteTransfers":"Number",
"numofWriteRequestTimeouts":"Number",
"numofWriteRequestFailures":"Number",
"readBytes":"Number",
"writeBytes":"Number",
"readServiceTime":"Number",
"minReadServiceTime":"Number",
"maxReadServiceTime":"Number",
"writeServiceTime":"Number",
"minWriteServiceTime":"Number",
"maxWriteServiceTime":"Number",
"timeSpentInWaitQueue":"Number",
"waitQueueSize":"Number",
"totalWaitQueueSize":"Number",
"minTimeSpentInWaitQueue":"Number",
"maxTimeSpentInWaitQueue":"Number",
"numOfTimesServiceQueueIsFull":"Number",
"totalServiceQueueDepth":"Number"
}]
}]
}]
}]
}]
}
}
}
The following table provides the details the metrics.
| Metric parameter | Description |
|---|---|
| Version | Version of JSON format for SSP. The value is 1.0.0 for the first release. |
| metricType | Indicates whether the values are Raw, Processed, or Aggregated metrics. ForRraw metrics, the value is Raw. |
| monitoringType | This indicates the type of monitoring. For SSP the value is SSP. |
| mtms | Managed system model type and serial number. |
| timeStamp | Timestamp of the sample. |
| status | Status can have one of the following values:
|
| SSPUtil: Metrics in this tag should be the total of all its Nodes utilization data. | |
| poolId | SSP ID. |
| name | SSP name. |
| clusterName | Name of the cluster. |
| clusterId | UDID of the cluster. |
| size | Total 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 | The total of the SSP disks utilization. See Disk metrics table for details on each utilization metric. |
| 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. |
| size | Total size of the disks that belong to the node in megabytes. |
| Free | Total free size of the disks that belong to the node in megabytes. |
| DISK METRICS Utilization | The total of all SSP disks utilization in the node. See Disk metric table for details on each utilization metric |
| TierUtil | |
| id | Tier ID. |
| name | Tier name. |
| Size | Total size of disks in the tier in megabytes. This includes all the disks that belong to the failure groups of the tier. |
| free | Free size of this disks in the tier in megabytes. This includes all the disks that belong to the failure groups of the tier. |
| DISK METRICS Utilization | The total of all disks utilization in the tier. See Dis metrics table for details on each utilization metric |
| FailureGroupUtil | |
| id | Failure group ID. |
| name | Failure group name. |
| size | Total size of disks in the failure group in megabytes. |
| free | Size of free disks in the failure group in megabytes. |
| DISK METRICS UTILIZATION | The total of all disks utilization metrics in the failure group. See Disk metrics table for details on each utilization metric. |
| DiskUtil | |
| udid | Disk unique device identifier. |
| Uuid | Unique universal identifier. |
| name | Disk name |
| adapterName | Name of the adapter to which disk belongs to. |
| Size | Size of the disk in megabytes. |
| free | Size of the free disks in megabytes. |
| DISK METRICS Utilization | Disk utilization metrics of the disk. See Disk metric table for details on each utilization metric. |
The following table provides the details the metrics.
| 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. |
