This documentation supports releases of BMC Helix Continuous Optimization up to December 31, 2021. To view the latest version, select the version from the Product version menu.

Prometheus API Query


Listed is the TSCO metrics mapping to Prometheus API queries. Not include derived metrics. Only core query calculation is listed, sum by different entities are not show in this list.

Some metircs are slightly different in different version of Prometheus. Here only the old version of metrics are listed. For example for node-exporter: node_memory_MemActive (old version) → node_memory_MemActive_Byte (newer version); for kubelet: container_cpu_usage_seconds (old version) → container_cpu_usage_seconds_total (newer version)

 In the ETL if the listed metrics are empty, it will call the newer version. 

Configuration Metrics

Entity

Metrics

Prometheus Query

Component

Namespace

MEM_LIMIT_MAX

 kube_resourcequota{resource =~ \"limits.memory\", type=\"hard\"}

kube-state-metric

CREATION_TIME

 kube_namespace_created

kube-state-metric

CPU_LIMIT_MAX

 kube_resourcequota{resource =~ \"limits.cpu\", type=\"hard\"}

kube-state-metric

CPU_REQUEST_MAX

 kube_resourcequota{resource =~ \"requests.cpu|cpu\",type=\"hard\"}

kube-state-metric

MEM_REQUEST_MAX

 kube_resourcequota{resource =~ \"requests.memory|memory\", type=\"hard\"}

kube-state-metric

KPOD_NUM_MAX

 kube_resourcequota{resource =~ \"pods\", type=\"hard\"}

kube-state-metric





Pod

CREATION_TIME

 kube_pod_created

kube-state-metric

HOST_NAME

 kube_pod_info

kube-state-metric

KPOD_STATUS

 kube_pod_status_phase

kube-state-metric





node

KUBERNETES_VERSION

 kube_node_info

kube-state-metric

KPOD_NUM_MAX

 kube_node_status_capacity_pods

kube-state-metric

CREATION_TIME

 kube_node_created

kube-state-metric

CPU_NUM

 count by (instance) (sum by(instance, cpu) (node_cpu)) 

node-exporter

TOTAL_REAL_MEM

 kube_node_status_capacity_memory_bytes

kube-state-metric

OS_TYPE

 kube_node_info

kube-state-metric

TOTAL_FS_SIZE

 node_filesystem_size{mountpoint=\"/\"}

node-exporter





cluster

CPU_NUM

 sum(count by (instance) (sum by(instance, cpu) (node_cpu)))

node-exporter

TOTAL_REAL_MEM

 kube_node_status_capacity_memory_bytes

kube-state-metric

KPOD_NUM_MAX

 kube_node_status_capacity_pods

kube-state-metric

KUBERNETES_VERSION

 kube_node_info

kube-state-metric

TOTAK_FS_SIZE

 node_filesystem_size{mountpoint="/"}

node-exporter


controller



controller

CREATION_TIME

 kube_daemonset_created kube_statefulset_created kube_replicaset_created kube_replicationcontroller_created

kube-state-metric

CONTROLLER_TYPE

 kube_pod_owner

kube-state-metric





Persistent volume

ST_TYPE

 kube_persistentvolume_info

kube-state-metric

Performance Metrics

namespace

CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

namespace

CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

namespace

MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

namespace

MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

namespace

CPU_USED_NUM

 rate(container_cpu_usage_seconds_total[5m])

kubelet

namespace

MEM_USED

 container_memory_usage_bytes

kubelet

namespace

NET_IN_BYTE_RATE

 container_network_receive_bytes_total

kubelet

namespace

NET_IN_BIT_RATE

 container_network_receive_bytes_total

kubelet

namespace

NET_IN_ERROR_RATE

 container_network_receive_errors_total

kubelet

namespace

NET_OUT_BYTE_RATE

 container_network_transmit_bytes_total

kubelet

namespace

NET_OUT_BIT_RATE

 container_network_transmit_bytes_total

kubelet

namespace

NET_BIT_RATE

 avg(container_network_receive_bytes_total+container_network_transmit_bytes_total)

kubelet

namespace

NET_OUT_ERROR_RATE

 container_network_transmit_errors_total

kubelet

namespace

BYSTATUS_KPOD_NUM

 kube_pod_status_phase

kube-state-metric

namespace

KPOD_NUM

 kube_pod_status_phase

kube-state-metric

namespace

CONTAINER_NUM

 kube_pod_container_info

kube-state-metric

namespace

BYIMAGE_NUM

 kube_pod_container_info

kube-state-metric

namespace

MEM_ACTIVE

 container_memory_working_set_bytes

kubelet

namespace

CPU_UTIL

 rate(container_cpu_usage_seconds_total[5m])/container_cpu_usage_seconds_total

kubelet

namespace

BYIMAGE_MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

namespace

BYIMAGE_CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric





pod

CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

pod

CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

pod

MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

pod

MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

pod

CPU_USED_NUM

 rate(container_cpu_usage_seconds_total[5m])

kubelet

pod

MEM_USED

 container_memory_usage_bytes

kubelet

pod

NET_IN_BYTE_RATE

 container_network_receive_bytes_total

kubelet

pod

NET_IN_BIT_RATE

 container_network_receive_bytes_total

kubelet

pod

NET_IN_ERROR_RATE

 container_network_receive_errors_total

kubelet

pod

NET_OUT_BYTE_RATE

 container_network_transmit_bytes_total

kubelet

pod

NET_OUT_BIT_RATE

 container_network_transmit_bytes_total

kubelet

pod

NET_BIT_RATE

 avg(container_network_receive_bytes_total+container_network_transmit_bytes_total)

kubelet

pod

NET_OUT_ERROR_RATE

 container_network_transmit_errors_total

kubelet

pod

BYSTATUS_KPOD_NUM

 kube_pod_status_phase

kube-state-metric

pod

KPOD_NUM

 kube_pod_status_phase

kube-state-metric

pod

CONTAINER_NUM

 kube_pod_container_info

kube-state-metric

pod

BYIMAGE_NUM

 kube_pod_container_info

kube-state-metric

pod

MEM_ACTIVE

 container_memory_working_set_bytes

kubelet

pod

CPU_UTIL

 rate(container_cpu_usage_seconds_total[5m])/container_cpu_usage_seconds_total

kubelet

pod

BYIMAGE_MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

pod

BYIMAGE_CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric





node

CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

node

CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

node

MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

node

MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

node

CPU_USED_NUM

 rate(node_cpu{mode!=\"idle\", mode!=\"iowait\"}[5m])

node-exporter

node

CPU_UTIL

 (rate(node_cpu{mode!=\"idle\",mode!=\"iowait\"}[5m]))/(count by (instance) (sum by(instance,cpu) (node_cpu)) )

node-exporter

node

MEM_USED

 node_memory_MemTotal - node_memory_MemFree - node_memory_KernelStack

node-exporter

node

MEM_REAL_USED

 node_memory_MemTotal - node_memory_MemFree - node_memory_KernelStack - node_memory_Cached - node_memory_Buffers - node_memory_Slab


node

MEM_UTIL

 (node_memory_MemTotal - node_memory_MemFree - node_memory_KernelStack)/node_memory_MemTotal


node

NET_IN_BYTE_RATE

 node_network_receive_bytes

node-exporter

node

NET_IN_BIT_RATE

 node_network_receive_bytes

node-exporter

node

NET_IN_ERROR_RATE

 node_network_receive_errs

node-exporter

node

NET_OUT_BYTE_RATE

 node_network_transmit_bytes

node-exporter

node

NET_OUT_BIT_RATE

 node_network_transmit_bytes

node-exporter

node

NET_BIT_RATE

 avg(node_network_transmit_bytes+node_network_receive_bytes)

node-exporter

node

NET_OUT_ERROR_RATE

 node_network_receive_bytes

node-exporter

node

BYSTATUS_KPOD_NUM

 kube_pod_status_phase

kube-state-metric

node

KPOD_NUM

 kube_pod_status_phase

kube-state-metric

node

CONTAINER_NUM

 kube_pod_container_info

kube-state-metric

node

BYIMAGE_NUM

 kube_pod_container_info

kube-state-metric

node

MEM_ACTIVE

 node_memory_Active

node-exporter

node

BYIMAGE_MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

node

BYIMAGE_CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

node

MEM_PAGE_MAJOR_FAULT_RATE

 node_vmstat_pgmajfault

node-exporter

node

TOTAL_FS_FREE

 node_filesystem_free{mountpoint="/"}

node-exporter

node

TOTAL_FS_USED

 node_filesystem_size{mountpoint="/"}- node_filesystem_free{mountpoint="/"}

node-exporter

node

TOTAL_FS_UTIL

 1-(node_filesystem_free{mountpoint="/"}/node_filesystem_size{mountpoint="/"})

node-exporter

node

CPU_ALLOCATABLE

 kube_node_status_allocatable_cpu_cores

kube-state-metric

node

MEMORY_ALLOCATABLE

 kube_node_status_allocatable_memory_bytes

kube-state-metric





cluster

CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

cluster

CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

cluster

MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

cluster

MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

cluster

CPU_USED_NUM

 rate(node_cpu{mode!=\"idle\", mode!=\"iowait\"}[5m])

node-exporter

cluster

CPU_UTIL

 (rate(node_cpu{mode!=\"idle\",mode!=\"iowait\"}[5m]))/(count by (instance) (sum by(instance,cpu) (node_cpu)) )

node-exporter

cluster

MEM_USED

 node_memory_MemTotal - node_memory_MemFree - node_memory_KernelStack

node-exporter

cluster

MEM_REAL_USED

 node_memory_MemTotal - node_memory_MemFree - node_memory_KernelStack - node_memory_Cached - node_memory_Buffers - node_memory_Slab

node-exporter

cluster

MEM_UTIL

 (node_memory_MemTotal - node_memory_MemFree - node_memory_KernelStack)/node_memory_MemTotal

node-exporter

cluster

NET_IN_BYTE_RATE

 node_network_receive_bytes

node-exporter

cluster

NET_IN_BIT_RATE

 node_network_receive_bytes

node-exporter

cluster

NET_IN_ERROR_RATE

 node_network_receive_errs

node-exporter

cluster

NET_OUT_BYTE_RATE

 node_network_transmit_bytes

node-exporter

cluster

NET_OUT_BIT_RATE

 node_network_transmit_bytes

node-exporter

cluster

NET_BIT_RATE

 avg(node_network_transmit_bytes+node_network_receive_bytes)

node-exporter

cluster

NET_OUT_ERROR_RATE

 node_network_receive_bytes

node-exporter

cluster

BYSTATUS_KPOD_NUM

 kube_pod_status_phase

kube-state-metric

cluster

KPOD_NUM

 kube_pod_status_phase

kube-state-metric

cluster

CONTAINER_NUM

 kube_pod_container_info

kube-state-metric

cluster

BYIMAGE_NUM

 kube_pod_container_info

kube-state-metric

cluster

MEM_ACTIVE

 node_memory_Active

node-exporter

cluster

BYIMAGE_MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

cluster

BYIMAGE_CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

cluster

MEM_PAGE_MAJOR_FAULT_RATE

 node_vmstat_pgmajfault

node-exporter

cluster

TOTAL_FS_FREE

 node_filesystem_free{mountpoint="/"}

node-exporter

cluster

TOTAL_FS_USED

 node_filesystem_size{mountpoint="/"}- node_filesystem_free{mountpoint="/"}

node-exporter

cluster

TOTAL_FS_UTIL

 1-(node_filesystem_free{mountpoint="/"}/node_filesystem_size{mountpoint="/"})

node-exporter

cluster

CPU_ALLOCATABLE

 kube_node_status_allocatable_cpu_cores

kube-state-metric

cluster

MEMORY_ALLOCATABLE

 kube_node_status_allocatable_memory_bytes

kube-state-metric

cluster

SERVICE_NUM

count(kube_service_info )

kube-state-metric

cluster

SECRET_NUM

count(kube_secret_info )

kube-state-metric

cluster

JOB_NUM

count(kube_job_info )

kube-state-metric





controller

CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

controller

CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

controller

MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

controller

MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

controller

CPU_USED_NUM

 rate(container_cpu_usage_seconds_total[5m])

kubelet

controller

MEM_USED

 container_memory_usage_bytes

kubelet

controller

NET_IN_BYTE_RATE

 container_network_receive_bytes_total

kubelet

controller

NET_IN_BIT_RATE

 container_network_receive_bytes_total

kubelet

controller

NET_IN_ERROR_RATE

 container_network_receive_errors_total

kubelet

controller

NET_OUT_BYTE_RATE

 container_network_transmit_bytes_total

kubelet

controller

NET_OUT_BIT_RATE

 container_network_transmit_bytes_total

kubelet

controller

NET_BIT_RATE

 avg(container_network_receive_bytes_total+container_network_transmit_bytes_total)

kubelet

controller

NET_OUT_ERROR_RATE

 container_network_transmit_errors_total

kubelet

controller

BYSTATUS_KPOD_NUM

 kube_pod_status_phase

kube-state-metric

controller

KPOD_NUM

 kube_pod_status_phase

kube-state-metric

controller

CONTAINER_NUM

 kube_pod_container_info

kube-state-metric

controller

BYIMAGE_NUM

 kube_pod_container_info

kube-state-metric

controller

MEM_ACTIVE

 container_memory_working_set_bytes

kubelet

controller

CPU_UTIL

 rate(container_cpu_usage_seconds_total[5m])/container_cpu_usage_seconds_total

kubelet

controller

BYIMAGE_MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

controller

BYIMAGE_CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

controller

KPOD_REPLICA_UPTODATE_NUM

 kube_deployment_status_replicas_available

kube-state-metric





pv

ST_ALLOCATED

 kube_persistentvolumeclaim_resource_requests_storage_bytes

kube-state-metric

pv

ST_SIZE

 kube_persistentvolumeclaim_info

kube-state-metric





Pod Workload

CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

Pod Workload

CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

Pod Workload

MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

Pod Workload

MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

Pod Workload

CPU_USED_NUM

 rate(container_cpu_usage_seconds_total[5m])

kubelet

Pod Workload

MEM_USED

 container_memory_usage_bytes

kubelet

Pod Workload

KPOD_NUM

 kube_pod_status_phase

kube-state-metric

Pod Workload

MEM_ACTIVE

 container_memory_working_set_bytes

kubelet

Pod Workload

BYCONT_MEM_ACTIVE

 container_memory_working_set_bytes

kubelet

Pod Workload

BYCONT_IMAGE_MEM_ACTIVE

 container_memory_working_set_bytes

kubelet

Pod Workload

RESTART_COUNT

 kube_pod_container_status_restarts_total

kube-state-metric

Pod Workload

HEAPMEM_MAX

 jvm_memory_bytes_max{area=\"heap\"}

jmx-exporter

Pod Workload

NONHEAPMEM_MAX

 jvm_memory_bytes_max{area=\"nonheap\"}

jmx-exporter

Pod Workload

BYCONT_CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

Pod Workload

BYCONT_CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

Pod Workload

BYCONT_MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

Pod Workload

BYCONT_MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

Pod Workload

BYCONT_CPU_USED_NUM

 rate(container_cpu_usage_seconds_total[5m])

kubelet

Pod Workload

BYCONT_MEM_USED

 container_memory_usage_bytes

kubelet

Pod Workload

BYCONT_CPU_USED_NUM_HM

 rate(container_cpu_usage_seconds_total[5m])

kubelet

Pod Workload

BYCONT_MEM_USED_HM

 container_memory_usage_bytes

kubelet

Pod Workload

BYCONT_KPOD_NUM

 kube_pod_status_phase

kube-state-metric

Pod Workload

BYCONT_RESTART_COUNT

 kube_pod_container_status_restarts_total

kube-state-metric

Pod Workload

BYCONT_IMAGE_CPU_REQUEST

 kube_pod_container_resource_requests_cpu_cores

kube-state-metric

Pod Workload

BYCONT_IMAGE_CPU_LIMIT

 kube_pod_container_resource_limits_cpu_cores

kube-state-metric

Pod Workload

BYCONT_IMAGE_MEM_KLIMIT

 kube_pod_container_resource_limits_memory_bytes

kube-state-metric

Pod Workload

BYCONT_IMAGE_MEM_REQUEST

 kube_pod_container_resource_requests_memory_bytes

kube-state-metric

Pod Workload

BYCONT_IMAGE_CPU_USED_NUM

 rate(container_cpu_usage_seconds_total[5m])

kubelet

Pod Workload

BYCONT_IMAGE_MEM_USED

 container_memory_usage_bytes

kubelet

Pod Workload

BYCONT_IMAGE_KPOD_NUM

 kube_pod_status_phase

kube-state-metric

Pod Workload

BYCONT_IMAGE_RESTART_COUNT

 kube_pod_container_status_restarts_total

kube-state-metric


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*