Skip to content

Latest commit

 

History

History
 
 

Documentation

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
design
design
 
 
README.md
README.md
 
 
configmap-metrics.md
configmap-metrics.md
 
 
cronjob-metrics.md
cronjob-metrics.md
 
 
daemonset-metrics.md
daemonset-metrics.md
 
 
deployment-metrics.md
deployment-metrics.md
 
 
endpoint-metrics.md
endpoint-metrics.md
 
 
horizontalpodautoscaler-metrics.md
horizontalpodautoscaler-metrics.md
 
 
job-metrics.md
job-metrics.md
 
 
limitrange-metrics.md
limitrange-metrics.md
 
 
namespace-metrics.md
namespace-metrics.md
 
 
node-metrics.md
node-metrics.md
 
 
persistentvolume-metrics.md
persistentvolume-metrics.md
 
 
persistentvolumeclaim-metrics.md
persistentvolumeclaim-metrics.md
 
 
pod-metrics.md
pod-metrics.md
 
 
poddisruptionbudget-metrics.md
poddisruptionbudget-metrics.md
 
 
replicaset-metrics.md
replicaset-metrics.md
 
 
replicationcontroller-metrics.md
replicationcontroller-metrics.md
 
 
resourcequota-metrics.md
resourcequota-metrics.md
 
 
secret-metrics.md
secret-metrics.md
 
 
service-metrics.md
service-metrics.md
 
 
statefulset-metrics.md
statefulset-metrics.md
 
 

README.md

Documentation

This documentation is intended to be a complete reflection of the current state of the exposed metrics of kube-state-metrics.

Any contribution to improving this documentation or adding sample usages will be appreciated.

Table of Contents

Metrics Stages

Stages about metrics are grouped into three categories：

Stage Description
EXPERIMENTAL Metrics which are normally corresponds to Kubernetes API object alpha status or spec fields and can be changed at any time.
STABLE Metrics which should be very few backwards-incompatible changes outside of major version updates.
DEPRECATED Metrics which will be removed once the deprecation timeline is met.

Metrics Deprecation

  • The following non-generic resource metrics for pods are marked deprecated. They will be removed in kube-state-metrics v2.0.0. kube_pod_container_resource_requests and kube_pod_container_resource_limits are the replacements with resource labels representing the resource name and unit labels representing the resource unit.
    • kube_pod_container_resource_requests_cpu_cores
    • kube_pod_container_resource_limits_cpu_cores
    • kube_pod_container_resource_requests_memory_bytes
    • kube_pod_container_resource_limits_memory_bytes
  • The following non-generic resource metrics for nodes are marked deprecated. They will be removed in kube-state-metrics v2.0.0. kube_node_status_capacity and kube_node_status_allocatable are the replacements with resource labels representing the resource name and unit labels representing the resource unit.
    • kube_node_status_capacity_pods
    • kube_node_status_capacity_cpu_cores
    • kube_node_status_capacity_memory_bytes
    • kube_node_status_allocatable_pods
    • kube_node_status_allocatable_cpu_cores
    • kube_node_status_allocatable_memory_bytes

Exposed Metrics

Per group of metrics there is one file for each metrics. See each file for specific documentation about the exposed metrics:

Join Metrics

When an additional, not provided by default label is needed, a Prometheus matching operator can be used to extend single metrics output.

This example adds label_release to the set of default labels of the kube_pod_status_ready metric and allows you select or group the metrics by helm release label:

kube_pod_status_ready * on (namespace, pod) group_left(label_release)  kube_pod_labels