Entities and metrics of Pure Storage REST API ETL for TrueSight Capacity Optimization

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:

IconEntity Types
Storage System
Storage Pool
Storage Volume

Entity relationship details

The following table lists the available relationship types.

Parent entityChild entityRelationship type
Storage SystemStorage PoolSA_CONTAINS_SP
Storage SystemStorage VolumeSA_CONTAINS_VOLUME
Storage PoolStorage VolumeSP_CONTAINS_VOLUME

For more information about relationships in TrueSight Capacity Optimization, refer to the topic Entity relationships.

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


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
BYCONT_PORT_NUM Number of available ports by ControllerNumber of available ports by Controller. The subobject specifies the controller name.Configuration data[3] Standard

STOGLB dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
ST_DEVICECOUNTQTYStorage Devices NumberNumber of storage devicesConfiguration data[2] Basic
ST_HOSTCNTQTYAttached Hosts NumberNumber of hosts to which devices on this array or the arrays in the group are allocatedConfiguration data[2] Basic
ST_MICROCODE Microcode versionSoftware microcode versionConfiguration data[3] Standard
ST_SID Storage Device Unique IdentifierUnique identifier of the storage deviceConfiguration data[2] Basic
ST_SYSTEM_BANDWIDTHBYTE/SSystem BandwidthBandwidth available in storage systemConfiguration data[2] Basic
ST_SYSTEM_MODEL Storage Array ModelModel of the systemConfiguration data[2] Basic
ST_SYSTEM_PORT_NUM Storage Array Port NumberTotal number of portsConfiguration data[2] Basic
ST_SYSTEM_VENDOR VendorVendorConfiguration data[2] Basic
ST_TYPE Box TypeBox TypeConfiguration data[2] Basic

STOSSW dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
BYPORT_ADDRESS Storage switch port addressStorage switch port addressConfiguration data[3] Standard
BYPORT_BANDWIDTHBIT/SBandwidth of the storage switch portBandwidth of the storage switch portConfiguration data[3] Standard
BYPORT_CONTROLLER_NAME Storage switch port controller nameStorage switch port controller nameConfiguration data[3] Standard
BYPORT_TYPE Storage switch port typeStorage switch port typeConfiguration data[3] Standard

SYSDSK dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
BYDISK_SIZEBYTESSize by DiskDisk size (bytes)Configuration data[3] Standard
BYDISK_TYPE the Disk Typethe type of the disk such as physical or virtualConfiguration data[3] Standard

Storage systems performance metrics

STOGLB dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
ST_AVAILABLE_CAPACITYBYTESAvailable CapacityCapacity not consumed (for storage systems: unused raw space plus available capacity in storage pools)Negative accumulation counter[2] Basic
ST_AVAILABLE_IN_STORAGE_POOLSBYTESAvailable Capacity in Storage PoolsSum of space not consumed in all storage poolsNegative accumulation counter[2] Basic
ST_CAPACITYBYTESStorage CapacityTotal 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_CAPACITYBYTESConfigured Volume CapacityTotal Capacity Configured for VolumesPositive accumulation counter[3] Standard
ST_CONFIGURED_VOLUME_CAPACITY_PCTPCTStorage System Configured Capacity PercentagePercentage of configured capacity in the storage systemPercentage counter[2] Basic
ST_CONSUMED_CAPACITYBYTESStorage Consumed CapacityActually consumed capacityGeneric counter, absolute value[1] Essential
ST_CONSUMED_CAPACITY_PCTPCTStorage Consumed Capacity PercentagePercentage of capacity actually consumedPercentage counter[2] Basic
ST_OVERSUBSCRIBED_CAPACITYBYTESStorage Oversubscribed CapacityStorage subscribed capacity exceeding the actual capacity of the componentGeneric counter, absolute value[2] Basic
ST_SIZEBYTESStorage SizeOverall 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_UTILPCTSystem Bandwidth UtilizationBandwidth consumed in storage systemPercentage counter[2] Basic
ST_SYSTEM_IO_RATEOP/SStorage System Operation RateTotal number of operations per second performed by the systemA frequency, in events/sec[3] Standard
ST_SYSTEM_IO_READ_RATEOP/SStorage System Read Operation RateNumber of read operations per second performed by the systemA frequency, in events/sec[3] Standard
ST_SYSTEM_IO_WRITE_RATEOP/SStorage System Write Operation RateNumber of write operations per second performed by the systemA frequency, in events/sec[3] Standard
ST_SYSTEM_SUBSCRIBED_CAPACITYBYTESStorage Subscribed CapacitySum of the host visible capacity for all volumes. Can be greater than the actual capacity of the storage system with over-subscribed thin poolsGeneric counter, absolute value[2] Basic
ST_SYSTEM_TRANSFER_BYTE_RATEBYTE/SSystem Transfer Byte RateTotal data traffic (in and out, read and write)A frequency, in events/sec[3] Standard

Storage pools configuration metrics

STOGLB dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
ST_DISK_TYPE Pool Disk TypeType of disks used for the pool. Contains the interconnection type (FC, SATA...) and rotations per minutes when available.Configuration dataNot Available
ST_POOL_DEV_COUNTQTYPool devices countPool devices countConfiguration data[2] Basic
ST_POOL_OVERSUBSCRIPTION_SITUATION Pool Oversubscription SituationIdentify 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 thresholdConfiguration data[2] Basic
ST_POOL_RAID_LEVEL Pool RAID LevelRAID level of the storage poolConfiguration data[2] Basic
ST_POOL_SUBSCRIBED_CAPACITYBYTESPool Subscribed CapacitySum of the host visible capacity for all volumes in the storage pool. Can be greater than the actual capacity of the storage pool for over-subscribed thin pools.Configuration data[2] Basic
ST_POOL_TYPE Array Pool TypeType of the poolConfiguration data[2] Basic

Storage pools performance metrics

STOGLB dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
ST_AVAILABLE_CAPACITYBYTESAvailable CapacityCapacity not consumed (for storage systems: unused raw space plus available capacity in storage pools)Negative accumulation counter[2] Basic
ST_CAPACITYBYTESStorage CapacityTotal 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_CAPACITYBYTESConfigured Volume CapacityTotal Capacity Configured for VolumesPositive accumulation counter[3] Standard
ST_CONFIG_SIZEBYTESStorage Configured SpaceOverall 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_CAPACITYBYTESStorage Consumed CapacityActually consumed capacityGeneric counter, absolute value[1] Essential
ST_CONSUMED_CAPACITY_PCTPCTStorage Consumed Capacity PercentagePercentage of capacity actually consumedPercentage counter[2] Basic
ST_OVERSUBSCRIBED_CAPACITYBYTESStorage Oversubscribed CapacityStorage subscribed capacity exceeding the actual capacity of the componentGeneric counter, absolute value[2] Basic
ST_POOL_SUBSCRIBED_CAPACITY_PCTPCTPool Subscribed Capacity PercentageSubscribed capacity, in percentage of the capacity of the storage pool. Can exceed 100% for thin pools, therefore called oversubscribedPercentage counter[2] Basic

Storage volumes configuration metrics

STOGLB dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
ST_VOLUME_HOST_VISIBLE_CAPACITYBYTESHost Volume Visible CapacityAmount of capacity that has been subscribed and can be "seen" by the hostConfiguration data[2] Basic
ST_VOLUME_MAPPED Volume MappedWhether the LUN is mapped to at least one hostConfiguration data[2] Basic
ST_VOLUME_TIME_SINCE_LAST_ACTIVITY Volume Time Since Last ActivityNumber 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 TypeStorage Volume TypeConfiguration data[2] Basic
VOLUME_EXTERNAL_ID Volume External Unique IdentifierVolume External Unique IdentifierConfiguration data[3] Standard

Storage volumes performance metrics

STOGLB dataset


TrueSight Capacity Optimization metricUnitDisplay nameDescriptionValue typeCollection level
ST_VOLUME_CONSUMED_CAPACITYBYTESVolume Consumed CapacityAmount 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_PCTPCTVolume Consumed Capacity PercentagePercentage 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 volumesPercentage counter[2] Basic
ST_VOLUME_IO_RATEOP/SVolume Operation RateTotal number of operations per second performed on the volumeA frequency, in events/sec[3] Standard
ST_VOLUME_IO_READ_RATEOP/SVolume Read Operation RateNumber of read operations per second performed on the volumeA frequency, in events/sec[3] Standard
ST_VOLUME_IO_WRITE_RATEOP/SVolume Write Operation RateNumber of write operations per second performed on the volumeA frequency, in events/sec[3] Standard
ST_VOLUME_RESPONSE_TIMEMILLISVolume Response TimeAverage time taken by the controller to complete read and write requests during the polling periodElapsed time[2] Basic
ST_VOLUME_TRANSFER_BYTE_RATEBYTE/SVolume Transfer Byte RateData traffic (read and write) on the volumeA frequency, in events/sec[3] Standard

Was this page helpful? Yes No Submitting... Thank you

Comments