Skip to main content
Version: 3.1

Portworx Metrics for monitoring

backup_stats stats

NameDescription
px_backup_stats_backup_statusStatus for this backup (0=InProgress,1=Done,2=Failed)
px_backup_stats_backup_sizeSize in bytes for this backup
px_backup_stats_backup_duration_secondsDuration in seconds for this backup
px_backup_stats_backup_uploaded_bytes_mbsDelta bytes uploaded in MB/s from last interval for this backup
px_backup_stats_download_size_bytesSize of downloaded bytes during backup/restore from cloud
px_backup_stats_upload_size_bytesSize of uploaded bytes during backup/restore from cloud
px_backup_stats_get_apis_invokedNumber of times GET API was invoked
px_backup_stats_put_apis_invokedNumber of times PUT API was invoked

cluster stats

NameDescription
px_cluster_cpu_percentPercentage of CPU Used
px_cluster_memory_utilized_percentPercentage of memory utilization
px_cluster_disk_total_bytesTotal storage space in bytes for this node
px_cluster_disk_available_bytesAvailable storage space in bytes for this node
px_cluster_disk_utilized_bytesUtilized storage space in bytes for this node
px_cluster_pendingioNumber of read and write operations currently in progress for this node
px_cluster_trashcan_volumesNumber of volumes currently in the trashcan

cluster_status stats

NameDescription
px_cluster_status_cluster_sizeNode count for your portworx cluster. Deprecated.
px_cluster_status_sizeNode count for your portworx cluster
px_cluster_status_cluster_quorumIndicates if the cluster is in quorum. Deprecated.
px_cluster_status_quorumIndicates if the cluster is in quorum
px_cluster_status_nodes_onlineNumber of online nodes in the cluster (includes storage and storageless)
px_cluster_status_nodes_offlineNumber of offline nodes in the cluster (includes storage and storageless)
px_cluster_status_nodes_storage_downNumber of nodes where the storage is full or down
px_cluster_status_storage_nodes_onlineNumber of storage nodes that are online
px_cluster_status_storage_nodes_offlineNumber of storage nodes that are offline
px_cluster_status_storage_nodes_decommissionedNumber of storage nodes that are decommissioned

disk_stats stats

NameDescription
px_disk_stats_used_bytesTotal storage in bytes for this disk
px_disk_stats_interval_secondsinterval_seconds
px_disk_stats_io_secondsTime spent doing IO in seconds for this disk
px_disk_stats_progress_ioIO's currently in progress for this disk
px_disk_stats_disk_read_bytesTotal bytes read for this disk. Deprecated.
px_disk_stats_read_bytesTotal bytes read for this disk
px_disk_stats_write_bytes_secondsTotal written bytes for this disk. Deprecated.
px_disk_stats_written_bytesTotal written bytes for this disk
px_disk_stats_read_secondsTotal time spend reading in seconds for this disk
px_disk_stats_write_secondsTotal time spend writing in seconds for this disk
px_disk_stats_read_latency_secondsAverage time spent per read operation in seconds for this disk
px_disk_stats_write_latencyAverage time spent per write operation in seconds for this disk. Deprecated.
px_disk_stats_write_latency_secondsAverage time spent per write operation in seconds
px_disk_stats_disk_num_readsTotal number of read operations completed successfully for this disk. Deprecated.
px_disk_stats_disk_num_writesTotal number of write operations completed successfully for this disk. Deprecated.
px_disk_stats_num_readsTotal number of read operations completed successfully for this disk
px_disk_stats_num_writesTotal number of write operations completed successfully for this disk
px_disk_stats_num_reads_totalTotal number of read operations completed successfully for this disk
px_disk_stats_num_writes_totalTotal number of write operations completed successfully for this disk
px_disk_stats_written_bytes_totalTotal bytes written for this disk
px_disk_stats_read_bytes_totalTotal bytes read for this disk
px_disk_stats_read_seconds_totalTotal time spend reading in seconds for this disk
px_disk_stats_write_seconds_totalTotal time spend writing in seconds for this disk

kvdb stats

NameDescription
px_kvdb_get_requests_totalTotal number of get requests for a key
px_kvdb_snapshot_requests_totalTotal number of kvdb snapshot requests for a list of prefixes
px_kvdb_put_requests_totalTotal number of put requests for a key
px_kvdb_create_requests_totalTotal number of create requests for a key
px_kvdb_update_requests_totalTotal number of update requests for a key
px_kvdb_enumerate_requests_totalTotal number of enumerate requests for a key
px_kvdb_delete_requests_totalTotal number of delete requests for a key
px_kvdb_keys_requests_totalTotal number of list key requests for a prefix
px_kvdb_cas_requests_totalTotal number of compare and sets for a key
px_kvdb_cad_requests_totalTotal number of compare and deletes for a key
px_kvdb_lock_requests_totalTotal number of lock requests for a key
px_kvdb_unlock_requests_totalTotal number of unlock requests for a key
px_kvdb_watchkey_requests_totalTotal number of watch requests for a key from a node
px_kvdb_watchtree_requests_totalTotal number of watch requests for a prefix from a node
px_kvdb_adduser_requests_totalTotal number of add user requests
px_kvdb_removeuser_requests_totalTotal number of remove user requests
px_kvdb_grantuser_access_requests_totalTotal number of grant access requests for a user
px_kvdb_revokeuser_access_requests_totalTotal number of revoke access requests for a user
px_kvdb_addmember_requests_totalTotal number of add member requests from a node
px_kvdb_addlearner_requests_totalTotal number of add learner requests from a node
px_kvdb_removemember_requests_totalTotal number of remove member requests from a node
px_kvdb_updatemember_requests_totalTotal number of update member requests from a node
px_kvdb_listmembers_requests_totalTotal number of list member requests from a node
px_kvdb_setendpoints_requests_totalTotal number of set endpoint requests from a node
px_kvdb_getendpoints_requests_totalTotal number of get endpoint requests from a node
px_kvdb_defragment_requests_totalTotal number of defragment requests from a node
px_kvdb_watch_latency_secondsTime taken in seconds between a kvdb put and a corresponding watch update

kvdb_health_state stats

NameDescription
px_kvdb_health_state_node_viewThis node's kvdb state (1 = healthy, 2 = not healthy)
px_kvdb_health_state_cluster_viewThis node's view of other node's kvdb state (1 = healthy, 2 = not healthy)

network_io stats

NameDescription
px_network_io_bytessentNumber of bytes sent during this interval
px_network_io_received_bytesNumber of bytes received during this interval
px_network_io_sent_bytes_totalTotal number of bytes sent
px_network_io_received_bytes_totalTotal number of bytes received
px_network_io_reservation_waitsTotal number of SM waits for reservation
px_network_io_reservation_wake_upsTotal number of SM wake ups after getting the reservation

node_stats stats

NameDescription
px_node_stats_used_memUsed memory in bytes
px_node_stats_cpu_usagePercent of CPU consumption
px_node_stats_busy_threads_percentPercentage of Busy Threads
px_node_stats_thread_pool_high_priority_queue_sizeThread Pool High Priority Queue Size
px_node_stats_writeback_list_num_dirty_poolsWriteback List Number of Dirty Pools
px_node_stats_writeback_list_num_pending_log_bufsWriteback List Number of Pending Log Buffers
px_node_stats_writeback_list_low_cos_queue_sizeWriteback List Low Cos Queue Size
px_node_stats_writeback_list_high_cos_queue_sizeWriteback List High Cos Queue Size
px_node_stats_sm_run_queue_sizeStatemachine Run Queue Size
px_node_stats_kaio_pending_queue_sizeKaio Pending Queue Size
px_node_stats_request_scheduler_queue_sizeRequest Scheduler Queue Size
px_node_stats_procfs_mem_available_bytesAvailable memory in bytes
px_node_stats_procfs_mem_dirty_bytesThe total amount of memory waiting to be written back to the disk
px_node_stats_procfs_mem_writeback_bytesThe total amount of memory actively being written back to the disk
px_node_stats_procfs_mem_total_bytesTotal amount of usable RAM which is physical RAM minus a number of reserved bits and the kernel binary code
px_node_stats_procfs_mem_free_bytesThe amount of physical RAM, in bytes, left unused by the system.
px_node_stats_procfs_mem_buffers_bytesThe amount, in bytes, of temporary storage for raw disk blocks
px_node_stats_procfs_mem_cached_bytesThe amount of physical RAM, in bytes, used as cache memory
px_node_stats_procfs_mem_active_anon_bytesThe amount of anonymous and tmpfs/shmem memory, in bytes, that is in active use, or was in active use since the last time the system moved something to swap
px_node_stats_procfs_mem_inactive_anon_bytesThe amount of anonymous and tmpfs/shmem memory, in bytes, that is a candidate for eviction
px_node_stats_procfs_mem_active_file_bytesThe amount of file cache memory, in bytes, that is in active use, or was in active use since the last time the system reclaimed memory
px_node_stats_procfs_mem_inactive_file_bytesThe amount of file cache memory, in bytes, that is newly loaded from the disk, or is a candidate for reclaiming
px_node_stats_procfs_mem_unevictable_bytesThe amount of memory, in bytes, discovered by the pageout code, that is not evictable because it is locked into memory by user programs
px_node_stats_procfs_mem_mlocked_bytesThe total amount of memory, in bytes, that is not evictable because it is locked into memory by user programs
px_node_stats_procfs_mem_anon_pages_bytesThe total amount of memory, in bytes, used by pages that are not backed by files and are mapped into userspace page tables
px_node_stats_procfs_mem_mapped_bytesThe memory, in bytes, used for files that have been mmaped, such as libraries
px_node_stats_procfs_mem_sh_mem_bytesThe total amount of memory, in bytes, used by shared memory (shmem) and tmpfs
px_node_stats_num_skinnysnapsThe number of SkinnySnaps
px_node_stats_skinnysnaps_num_repls_skipsThe number of target replicas skipped for a snapshot due to SkinnySnap
px_node_stats_skinnysnaps_num_repls_snapshotsThe number of target replicas that underwent a snapshot operation due to SkinnySnap
px_node_stats_relaxed_reclaim_pendingThe number of volumes in RelaxedReclaim pending queue
px_node_stats_relaxed_reclaim_skippedThe number of volume deletes that were skipped from being delayed even when RelaxedReclaim was enabled.
px_node_stats_relaxed_reclaim_deletedThe number of volume deletes done through RelaxedReclaim
px_node_stats_num_volumesThe number of volumes hosted on this node

node_status stats

NameDescription
px_node_status_node_statusStatus of this node (https://libopenstorage.github.io/w/master.generated-api/#status)
px_node_status_license_expiryNumber of days until License (or License lease) expires (<0 means Expired)

none_stats stats

NameDescription
px_none_stats_free_memAvailable memory in bytes
px_none_stats_total_memTotal memory in bytes

pool_stats stats

NameDescription
px_pool_stats_pool_written_bytesBytes written since last interval for this pool. Deprecated.
px_pool_stats_pool_write_latency_secondsAverage time spent per write operation for this pool. Deprecated.
px_pool_stats_pool_writethroughputAverage number of bytes written per second for this pool. Deprecated.
px_pool_stats_pool_flushed_bytesNumber of flushed bytes since last interval for this pool. Deprecated.
px_pool_stats_pool_num_flushesNumber of flush(sync) operations since last interval for this pool. Deprecated.
px_pool_stats_pool_flushmsLatency for flush for this pool. Deprecated.
px_pool_stats_pool_provisioned_bytesProvisioned storage space in bytes for this pool. Deprecated.
px_pool_stats_pool_statusStatus of this Pool (0=Offline,1=Online). Deprecated.
px_pool_stats_written_bytesBytes written since last interval for this pool
px_pool_stats_num_writesNumber of write operations in the last interval for this pool
px_pool_stats_write_msTotal time in millisecond spent in writing in the last interval for this pool
px_pool_stats_write_latency_secondsAverage time spent per write operation for this pool
px_pool_stats_write_iopsAverage number of completed write operations per second for this pool
px_pool_stats_writethroughputAverage number of bytes written per second for this pool
px_pool_stats_flushed_bytesNumber of flushed bytes since last interval for this pool
px_pool_stats_num_flushesNumber of flush(sync) operations since last interval for this pool
px_pool_stats_flushmsLatency for flush for this pool
px_pool_stats_provisioned_bytesProvisioned storage space in bytes for this pool
px_pool_stats_statusStatus of this Pool (0=Offline,1=Online,2=Full,3=NotFound,4=Maintenance)
px_pool_stats_available_bytesAvailable storage space in bytes for this pool
px_pool_stats_used_bytesUsed storage space in bytes for this pool
px_pool_stats_total_bytesTotal storage space in bytes for this pool
px_pool_stats_written_bytes_totalTotal bytes written for this pool
px_pool_stats_flushed_bytes_totalTotal number of flushed bytes
px_pool_stats_num_flushes_totalTotal number of flush(sync) operations
px_pool_stats_flushms_totalTotal time spent in flush

proc_stats stats

NameDescription
px_proc_stats_virtVirtual memory in bytes
px_proc_stats_resResident set size memory in bytes
px_proc_stats_cputimeAmount of time that this process has been scheduled in user and kernel mode measured in clock ticks

px_cache stats

NameDescription
px_px_cache_statusCache enabled (0=No,1=Yes)
px_px_cache_total_blocksNumber of total blocks in the cache
px_px_cache_used_blocksNumber of used blocks in the cache
px_px_cache_dirty_blocksNumber of dirty blocks in the cache
px_px_cache_read_hitsNumber of read hits for the cache
px_px_cache_read_missNumber of read misses for the cache
px_px_cache_write_hitsNumber of write hits for the cache
px_px_cache_write_missNumber of write misses for the cache
px_px_cache_block_sizeBlock size for the cache
px_px_cache_modeMode of the cache
px_px_cache_migrate_promoteNumber of blocks promoted to the cache
px_px_cache_migrate_demoteNumber of block demoted from the cache
px_px_cache_io_mbpsApprox cache bandwidth from cache internal actions

rebalance stats

NameDescription
px_rebalance_rebalance_job_stateRebalance job state (0 = pending, 1 = running, 2 = done, 3 = paused, 4 = cancelled)
px_rebalance_provision_space_rebalanced_bytes_totalTotal provisioned space rebalanced (only counts add (since remove has equal value as add))
px_rebalance_used_space_rebalanced_bytes_totalTotal used space rebalanced (only counts add (since remove has equal value as add))
px_rebalance_volumes_rebalanced_totalTotal volumes affected by rebalance operation
px_rebalance_overloaded_pools_totalNumber of overloaded pools

volume stats

NameDescription
px_volume_usage_bytesUsed storage space in bytes for this volume
px_volume_capacity_bytesConfigured size in bytes for this volume
px_volume_halevelConfigured HA level for this volume
px_volume_currhalevelCurrent HA level for this volume
px_volume_iopriorityConfigured IO priority for this volume
px_volume_elapsed_time_since_detached_secondsSeconds elapsed since the volume is detached
px_volume_elapsed_time_since_attached_secondsSeconds elapsed since the volume is attached
px_volume_attachedAttached state for this volume (0=detached,1=attached)
px_volume_statusStatus for this volume (https://libopenstorage.github.io/w/master.generated-api#volumestatus)
px_volume_stateState for this volume (https://libopenstorage.github.io/w/master.generated-api#volumestate)
px_volume_attached_stateAttached state for this volume (valid only if volume is attached) (https://libopenstorage.github.io/w/master.generated-api#attachstate)
px_volume_fs_health_statusFilesystem health status for this volume (https://libopenstorage.github.io/w/master.generated-api#filesystemhealthstatus)
px_volume_replication_statusReplication Status for this volume (0 : up, 1 : not in quorum, 2 : resync state, 3 : degraded, 4 : detached, 5 : restore)
px_volume_fs_usage_bytesUsed storage space in bytes as reported by the filesystem for this volume
px_volume_fs_capacity_bytesTotal storage space in bytes as reported by the filesystem for this volume
px_volume_vol_read_bytesNumber of successfully read bytes during this interval for this volume. Deprecated.
px_volume_vol_written_bytesNumber of successfully written bytes during this interval for this volume. Deprecated.
px_volume_vol_readsNumber of successfully completed read operations during this interval for this volume. Deprecated.
px_volume_vol_writesNumber of successfully completed write operations during this interval for this volume. Deprecated.
px_volume_read_bytesNumber of successfully read bytes during this interval for this volume
px_volume_written_bytesNumber of successfully written bytes during this interval for this volume
px_volume_readsNumber of successfully completed read operations during this interval for this volume
px_volume_writesNumber of successfully completed write operations during this interval for this volume
px_volume_read_bytes_totalTotal number of successfully read bytes for this volume
px_volume_written_bytes_totalTotal number of successfully written bytes for this volume
px_volume_reads_totalTotal number of successfully completed read operations for this volume
px_volume_writes_totalTotal number of successfully completed write operations for this volume
px_volume_iopsNumber of successful completed I/O operations per second during this interval for this volume
px_volume_write_iopsAverage number of completed write operations per second for this volume
px_volume_read_iopsAverage number of completed read operations per second for this volume
px_volume_vol_num_sequential_writesNumber of sequential write I/O operations during this interval for this volume
px_volume_vol_num_sequential_readsNumber of sequential read I/O operations during this interval for this volume
px_volume_vol_num_random_writesNumber of random write I/O operations during this interval for this volume
px_volume_vol_num_random_readsNumber of random read I/O operations during this interval for this volume
px_volume_depth_ioNumber of I/O operations currently in progress for this volume
px_volume_readthroughputNumber of bytes read per second during this interval for this volume
px_volume_writethroughputNumber of bytes written per second during this interval for this volume
px_volume_vol_bytes_reclaimedNumber of bytes reclaimed by fstrim operation
px_volume_vol_bytes_reclaimableNumber of bytes reclaimable on the volume as seen by fstrim operation
px_volume_vol_read_latency_secondsAverage time spent per successfully completed read operation in seconds during this interval for this volume. Deprecated.
px_volume_vol_write_latency_secondsAverage time spent per successfully completed write operation in seconds during this interval for this volume. Deprecated.
px_volume_read_latency_secondsAverage time spent per successfully completed read operation in seconds for this volume
px_volume_write_latency_secondsAverage time spent per successfully completed write operation in seconds for this volume
px_volume_num_long_readsNumber of long reads for this volume
px_volume_num_long_writesNumber of long writes for this volume
px_volume_num_long_flushesNumber of long flushes for this volume
px_volume_num_db_flushesNumber of DB flushes for this volume
px_volume_replica_read_bytes_totalTotal number of successfully read bytes for this replica volume
px_volume_replica_written_bytes_totalTotal number of successfully written bytes for this replica volume
px_volume_replica_reads_totalTotal number of successfully completed read operations for this replica volume
px_volume_replica_writes_totalTotal number of successfully completed write operations for this replica volume
px_volume_replica_flushes_totalTotal number of successfully completed flush operations for this replica volume
px_volume_replica_read_ms_totalTotal time spent doing read operations in milliseconds for this replica volume
px_volume_replica_write_ms_totalTotal time doing write operations in milliseconds for this replica volume
px_volume_replica_flush_ms_totalTotal time doing write operations in milliseconds for this replica volume
px_volume_dev_depth_ioNumber of I/O operations currently in progress as reported by the kernel pxd device for this volume
px_volume_dev_writethroughputNumber of successfully written bytes per second as reported by the kernel pxd device for this volume
px_volume_dev_readthroughputNumber of successfully read bytes per second as reported by the kernel pxd device for this volume
px_volume_dev_read_latency_secondsAverage time spent per successfully completed read in seconds as reported by the kernel pxd device for this volume
px_volume_dev_write_latency_secondsAverage time spent per successfully completed write in seconds as reported by the kernel pxd device for this volume
px_volume_dev_read_bytes_totalTotal number of successfully read bytes as reported by the kernel pxd device for this volume
px_volume_dev_written_bytes_totalNumber of successfully written bytes as reported by the kernel pxd device for this volume
px_volume_dev_reads_totalTotal number of successfully completed read operations as reported by the kernel pxd device for this volume
px_volume_dev_writes_totalTotal number of successfully completed write operations as reported by the kernel pxd device for this volume
px_volume_dev_read_seconds_totalTotal time spend reading in seconds for this disk as reported by the kernel pxd device for this volume
px_volume_dev_write_seconds_totalTotal time spend writing in seconds for this disk as reported by the kernel pxd device for this volume
px_volume_unique_blocksSize(in bytes) of unique blocks for this volume
px_volume_timestamp_recordsNumber of timestamp records accumulated
px_volume_timestamp_records_per_nodeNumber of timestamp records accumulated for a node
px_volume_num_discard_opsNumber of discard operations for this volume
px_volume_discarded_bytesNumber of discarded bytes for this volume
Was this page helpful?