Entities and metrics of Storage - Pure Storage REST API Extractor Service
This topic contains the following sections:
Entity list
The following table lists all the available entities. The “Icon” column shows how the entity appears in the console user interface:
Icon | Entity Types |
|---|---|
| Storage System |
| Storage Pool |
| Storage Volume |
Entity relationship details
The following table lists the available relationship types.
Parent entity | Child entity | Relationship type |
|---|---|---|
Storage System | Storage Pool | SA_CONTAINS_SP |
Storage System | Storage Volume | SA_CONTAINS_VOLUME |
Storage Pool | Storage Volume | SP_CONTAINS_VOLUME |
For more information about relationships in BMC Helix Continuous Optimization, refer to the topic Entity relationships.
Lookup details
Pure Storage REST API ETL for BMC Helix Continuous Optimization defines the following lookup fields:
Entity type | Lookup fields |
|---|---|
Storage System | DEFAULT |
Storage Pool | DEFAULT |
Storage Volume | DEFAULT |
Metric details
This topic lists the Configuration and Performance metrics collected by the Pure Storage REST API ETL module for entities such as storage systems, storage pools, and storage volumes.
Storage systems configuration metrics
STOCONT dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| ST_DEVICECOUNT | QTY | Storage Devices Number | Number of storage devices | Configuration data | [2] Basic |
| ST_HOSTCNT | QTY | Attached Hosts Number | Number of hosts to which devices on this array or the arrays in the group are allocated | Configuration data | [2] Basic |
| ST_MICROCODE | Microcode version | Software microcode version | Configuration data | [3] Standard | |
| ST_SID | Storage Device Unique Identifier | Unique identifier of the storage device | Configuration data | [2] Basic | |
| ST_SYSTEM_BANDWIDTH | BIT/S | System Bandwidth | Bandwidth available in storage system | Configuration data | [2] Basic |
| ST_SYSTEM_MODEL | Storage Array Model | Model of the system | Configuration data | [2] Basic | |
| ST_SYSTEM_PORT_NUM | Storage Array Port Number | Total number of ports | Configuration data | [2] Basic | |
| ST_SYSTEM_VENDOR | Vendor | Vendor | Configuration data | [2] Basic | |
| ST_TYPE | Box Type | Box Type | Configuration data | [2] Basic |
STOGLB dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| ST_DEVICECOUNT | QTY | Storage Devices Number | Number of storage devices | Configuration data | [2] Basic |
| ST_HOSTCNT | QTY | Attached Hosts Number | Number of hosts to which devices on this array or the arrays in the group are allocated | Configuration data | [2] Basic |
| ST_MICROCODE | Microcode version | Software microcode version | Configuration data | [3] Standard | |
| ST_SID | Storage Device Unique Identifier | Unique identifier of the storage device | Configuration data | [2] Basic | |
| ST_SYSTEM_BANDWIDTH | BIT/S | System Bandwidth | Bandwidth available in storage system | Configuration data | [2] Basic |
| ST_SYSTEM_MODEL | Storage Array Model | Model of the system | Configuration data | [2] Basic | |
| ST_SYSTEM_PORT_NUM | Storage Array Port Number | Total number of ports | Configuration data | [2] Basic | |
| ST_SYSTEM_VENDOR | Vendor | Vendor | Configuration data | [2] Basic | |
| ST_TYPE | Box Type | Box Type | Configuration data | [2] Basic |
STOSSW dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| BYPORT_ADDRESS | Storage switch port address | Storage switch port address | Configuration data | [3] Standard | |
| BYPORT_BANDWIDTH | BIT/S | Bandwidth of the storage switch port | Bandwidth of the storage switch port | Configuration data | [3] Standard |
| BYPORT_CONTROLLER_NAME | Storage switch port controller name | Storage switch port controller name | Configuration data | [3] Standard | |
| BYPORT_TYPE | Storage switch port type | Storage switch port type | Configuration data | [3] Standard |
SYSDSK dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| BYDISK_SIZE | BYTES | Size by Disk | Disk size (bytes) | Configuration data | [3] Standard |
| BYDISK_TYPE | the Disk Type | the type of the disk such as physical or virtual | Configuration data | [3] Standard |
Storage systems performance metrics
STOGLB dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| ST_AVAILABLE_CAPACITY | BYTES | Available Capacity | Capacity not consumed (for storage systems: unused raw space plus available capacity in storage pools) | Negative accumulation counter | [2] Basic |
| ST_AVAILABLE_IN_STORAGE_POOLS | BYTES | Available Capacity in Storage Pools | Sum of space not consumed in all storage pools | Negative accumulation counter | [2] Basic |
| ST_CAPACITY | BYTES | Storage Capacity | Total capacity (for storage systems: unused raw space plus sum of the capacity for all storage pools) | Generic counter, absolute value | [2] Basic |
| ST_CONFIGURED_VOLUME_CAPACITY | BYTES | Configured Volume Capacity | Total Capacity Configured for Volumes | Positive accumulation counter | [3] Standard |
| ST_CONFIGURED_VOLUME_CAPACITY_PCT | PCT | Configured Volume Capacity Percentage | Configured volume capacity, in percentage of the capacity of the component. Can exceed 100% for thin pools and storage systems with thin pools | Percentage counter | [2] Basic |
| ST_CONSUMED_CAPACITY | BYTES | Storage Consumed Capacity | Actually consumed capacity | Generic counter, absolute value | [1] Essential |
| ST_CONSUMED_CAPACITY_PCT | PCT | Storage Consumed Capacity Percentage | Percentage of capacity actually consumed | Percentage counter | [2] Basic |
| ST_OVERSUBSCRIBED_CAPACITY | BYTES | Storage Oversubscribed Capacity | Storage subscribed capacity exceeding the actual capacity of the component | Generic counter, absolute value | [2] Basic |
| ST_SIZE | BYTES | Storage Size | Overall size of the component (for a storage system, this value is the sum of the raw size of all disks. For a storage pool this value is the external size) | Generic counter, absolute value | [2] Basic |
| ST_SYSTEM_BANDWIDTH_UTIL | PCT | System Bandwidth Utilization | Bandwidth consumed in storage system | Percentage counter | [2] Basic |
| ST_SYSTEM_IO_RATE | OP/S | Storage System Operation Rate | Total number of operations per second performed by the system | A frequency, in events/sec | [3] Standard |
| ST_SYSTEM_IO_READ_RATE | OP/S | Storage System Read Operation Rate | Number of read operations per second performed by the system | A frequency, in events/sec | [3] Standard |
| ST_SYSTEM_IO_WRITE_RATE | OP/S | Storage System Write Operation Rate | Number of write operations per second performed by the system | A frequency, in events/sec | [3] Standard |
| ST_SYSTEM_SUBSCRIBED_CAPACITY | BYTES | Storage Subscribed Capacity | Sum of the host visible capacity for mapped volumes. Can be greater than the actual capacity of the storage system with over-subscribed thin pools | Generic counter, absolute value | [2] Basic |
| ST_SYSTEM_TRANSFER_BYTE_RATE | BYTE/S | System Transfer Byte Rate | Total data traffic (in and out, read and write) | A frequency, in events/sec | [3] Standard |
Storage pools configuration metrics
STOGLB dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| ST_DISK_TYPE | Pool Disk Type | Type of disks used for the pool. Contains the interconnection type (FC, SATA...) and rotations per minutes when available. | Configuration data | Not Available | |
| ST_POOL_DEV_COUNT | QTY | Pool devices count | Pool devices count | Configuration data | [2] Basic |
| ST_POOL_OVERSUBSCRIPTION_SITUATION | Pool Oversubscription Situation | Identify the over-subscribed pools in danger i.e. thin pools where Subscribed Capacity Percentage is greater than 100 % and the Consumed Capacity Percentage crosses the threshold | Configuration data | [2] Basic | |
| ST_POOL_RAID_LEVEL | Pool RAID Level | RAID level of the storage pool | Configuration data | [2] Basic | |
| ST_POOL_TYPE | Array Pool Type | Type of the pool | Configuration data | [2] Basic |
Storage pools performance metrics
STOGLB dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| ST_AVAILABLE_CAPACITY | BYTES | Available Capacity | Capacity not consumed (for storage systems: unused raw space plus available capacity in storage pools) | Negative accumulation counter | [2] Basic |
| ST_CAPACITY | BYTES | Storage Capacity | Total capacity (for storage systems: unused raw space plus sum of the capacity for all storage pools) | Generic counter, absolute value | [2] Basic |
| ST_CONFIGURED_VOLUME_CAPACITY | BYTES | Configured Volume Capacity | Total Capacity Configured for Volumes | Positive accumulation counter | [3] Standard |
| ST_CONFIG_SIZE | BYTES | Storage Configured Space | Overall size of the component (for a storage system, this value is the sum of the raw size of all disks. For a storage pool this value is the external size) | Generic counter, absolute value | [2] Basic |
| ST_CONSUMED_CAPACITY | BYTES | Storage Consumed Capacity | Actually consumed capacity | Generic counter, absolute value | [1] Essential |
| ST_CONSUMED_CAPACITY_PCT | PCT | Storage Consumed Capacity Percentage | Percentage of capacity actually consumed | Percentage counter | [2] Basic |
| ST_OVERSUBSCRIBED_CAPACITY | BYTES | Storage Oversubscribed Capacity | Storage subscribed capacity exceeding the actual capacity of the component | Generic counter, absolute value | [2] Basic |
| ST_POOL_SUBSCRIBED_CAPACITY | BYTES | Pool Subscribed Capacity | Sum of the host visible capacity for mapped volumes in the storage pool. Can be greater than the actual capacity of the storage pool for over-subscribed thin pools. | Generic counter, absolute value | [2] Basic |
| ST_POOL_SUBSCRIBED_CAPACITY_PCT | PCT | Pool Subscribed Capacity Percentage | Subscribed capacity, in percentage of the capacity of the storage pool. Can exceed 100% for thin pools, therefore called oversubscribed | Percentage counter | [2] Basic |
Storage volumes configuration metrics
STOGLB dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| ST_VOLUME_HOST_VISIBLE_CAPACITY | BYTES | Host Volume Visible Capacity | Amount of capacity that has been subscribed and can be "seen" by the host | Configuration data | [2] Basic |
| ST_VOLUME_MAPPED | Volume Mapped | Whether the LUN is mapped to at least one host | Configuration data | [2] Basic | |
| ST_VOLUME_TIME_SINCE_LAST_ACTIVITY | Volume Time Since Last Activity | Number of days since the last read or write operation has been observed on the monitored volume. | Configuration data | [2] Basic | |
| ST_VOLUME_TYPE | Storage Volume Type | Storage Volume Type | Configuration data | [2] Basic | |
| VOLUME_EXTERNAL_ID | Volume External Unique Identifier | Volume External Unique Identifier | Configuration data | [3] Standard |
Storage volumes performance metrics
STOGLB dataset
| Metric | Unit | Display name | Description | Value type | Collection level |
| ST_VOLUME_CONSUMED_CAPACITY | BYTES | Volume Consumed Capacity | Amount of capacity that has been actually consumed by the host (for thin volumes, this value will typically be less than the host visible capacity. For traditional volumes this value always equals the host visible capacity) | Positive accumulation counter | [2] Basic |
| ST_VOLUME_CONSUMED_CAPACITY_PCT | PCT | Volume Consumed Capacity Percentage | Percentage of the volume subscribed capacity that has been actually consumed by the host. Will be typically less than 100% for thin volumes. Will be exactly 100% for all traditional volumes | Percentage counter | [2] Basic |
| ST_VOLUME_IO_RATE | OP/S | Volume Operation Rate | Total number of operations per second performed on the volume | A frequency, in events/sec | [3] Standard |
| ST_VOLUME_IO_READ_RATE | OP/S | Volume Read Operation Rate | Number of read operations per second performed on the volume | A frequency, in events/sec | [3] Standard |
| ST_VOLUME_IO_WRITE_RATE | OP/S | Volume Write Operation Rate | Number of write operations per second performed on the volume | A frequency, in events/sec | [3] Standard |
| ST_VOLUME_RESPONSE_TIME | MILLIS | Volume Response Time | Average time taken by the controller to complete read and write requests during the polling period | Elapsed time | [2] Basic |
| ST_VOLUME_TRANSFER_BYTE_RATE | BYTE/S | Volume Transfer Byte Rate | Data traffic (read and write) on the volume | A frequency, in events/sec | [3] Standard |
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*