CHANGELOG.md

v2.14.0 / 2024-11-08

Note

• This release builds with Golang v1.23.3

• This release builds with k8s.io/client-go: v0.31.2

• This release removes kube_endpoint_address_not_ready and kube_endpoint_address_available which have been deprecated in 2022. Please use kube_endpoint_addressas a replacement.

• [BUGFIX] Use --track-unscheduled-pods to select unscheduled pods in Daemonset sharding by @CatherineF-dev in kubernetes#2388

• [BUGFIX] Install tools so VERSION gets set by @mrueg in kubernetes#2456

• [BUGFIX] Syntax errors in kube-state-metrics.libsonnet by @jeffmccune in kubernetes#2454

• [BUGFIX] Set kube_job_status_failed metric even when there are no job.Status.Conditions present by @richabanker in kubernetes#2485

• [BUGFIX] de-duplication of custom resource metrics by @bartlettc22 in kubernetes#2502

• [BUGFIX] Configure sharding every time MetricsHandler.Run runs by @wallee94 in kubernetes#2478

• [BUGFIX] Panic in util.GVRFromType for core objects by @L3n41c in kubernetes#2535

• [BUGFIX] Big memory value overflow by @leiwingqueen in kubernetes#2540

• [BUGFIX] Expose empty labels by @mrueg in kubernetes#2539

• [BUGFIX] CustomResourceMetrics: Convert status condition Unknown to a valid value by @Haleygo in kubernetes#2536

• [CHANGE] Remove deprecated endpoint address metric by @mrueg in kubernetes#2527

• [FEATURE] Add new metric kube_job_status_suspended by @Indresh2410 in kubernetes#2542

• [FEATURE] Move endpoint ports into address metric by @mrueg in kubernetes#2503

• [ENHANCEMENT] Use concurrent map when storing metrics by @rarruda in kubernetes#2510

v2.13.0 / 2024-07-18

Note

• This release builds with Golang v1.22.5.

• This release builds with k8s.io/client-go: v0.30.3.

• This release adds read and write timeouts for requests. The defaults might have an impact on scrapes that take a long time.

• [BUGFIX] Pod autosharding: transition from labelselector to fieldselector by @pkoutsovasilis in kubernetes#2347

• [ENHANCEMENT] Add automatic detection of memory limits by @SuperQ in kubernetes#2447

• [FEATURE] Add readyz endpoint by @rexagod in kubernetes#2442

• [FEATURE] Add livez endpoint by @rexagod in kubernetes#2418

• [FEATURE] Add kube_persistentvolume_volume_mode metric by @ricardoapl in kubernetes#2370

• [FEATURE] Add read and write timeouts by @Pokom in kubernetes#2412

v2.12.0 / 2024-04-02

Note

• This release addresses a critical issue where scraping the exposition data for certain types caused metrics-backends to crash: kubernetes#2248.

• This release builds with k8s.io/client-go: v0.29.3.

• [BUGFIX] Fallback to gauge for protobuf-based negotiations by @rexagod in kubernetes#2270

• [ENHANCEMENT] Add kube_pod_container_status_last_terminated_timestampby @tetianakravchenko in kubernetes#2291

• [FEATURE] Allow prefixing expandable paths by @rexagod in kubernetes#2052

v2.11.0 / 2024-03-04

Note

This release builds with Golang v1.21.8.

• [ENHANCEMENT] Add OpenSSF Scorecard to README by @dalehenries in kubernetes#2277
• [ENHANCEMENT] Generate OpenVX data for every release by @shafeeqes in kubernetes#2276
• [ENHANCEMENT] Add restartPolicy to kube_pod_init_container_info metric by @changhyuni in kubernetes#2240
• [FEATURE] Add kube_node_status_addresses metric by @stonith in kubernetes#2252
• [FEATURE] Add namespace label to endpointslice metrics by @mrueg in kubernetes#2266
• [FEATURE] Add opt-in kube_persistentvolume_csi_attributes metric by @machadovilaca in kubernetes#2133
• [FEATURE] Add new metric kube_pod_scheduler metric by @adinhodovic in kubernetes#2222
• [FEATURE] Support filtering annotations allow-list by * by @xonvanetta in kubernetes#2234
• [ENHANCEMENT] Support scraping pod metrics that are still in scheduling status and have no assigned nodes by @mickeyzzc in kubernetes#2217
• [FEATURE] Add backend resource info for kube_ingress_path by @rohitphatak in kubernetes#2109

v2.10.1 / 2023-10-09

Note

• This release addresses a regression introduced in #2105.

• [BUGFIX] Remove FieldSelector from non-namespaced resources by @mrueg and @dgrisonnet in #2190

• [ENHANCEMENT] Bump Go to v1.20.8

v2.10.0 / 2023-08-31

Note

• Label and annotation metrics aren't exposed by default anymore to reduce the memory usage of the default configuration of kube-state-metrics. Before this change, they used to only include the name and namespace of the objects which is not relevant to users not opting in these metrics.

• [BUGFIX] Log no _info suffix in name only once per reading the configuration for custommetrics by @chrischdi in kubernetes#2157

• [BUGFIX] Don't crash on non-existent valueFrom path values by @chihshenghuang in kubernetes#2140

• [BUGFIX] Index out of range in metrics_store.SanitizeHeaders by @mrueg in kubernetes#2166

• [BUGFIX] Always extract the headers but only write it when we have custommetrics by @chrischdi in kubernetes#2154

• [BUGFIX] Add filtering for Lease metrics by @ntoofu in kubernetes#2122

• [FEATURE] Implement kube_pod_status_initialized_time by @opeco17 in kubernetes#2148

• [FEATURE] Disable labels and annotations metrics when metric-annotations-… by @opeco17 in kubernetes#2145

• [FEATURE] Add webhooks client config service metrics by @dgrisonnet in kubernetes#2114

• [FEATURE] Support kube_persistentvolumeclaim_deletion_timestamp by @maxime1907 in kubernetes#2074

• [FEATURE] Support kube_persistentvolume_deletion_timestamp by @maxime1907 in kubernetes#2075

• [FEATURE] Adds new metric kube_pod_service_account by @swarup-stripe in kubernetes#2096

• [FEATURE] Add volumemode to PVC info metric by @machadovilaca in kubernetes#2134

• [FEATURE] Enable metric-annotations-allowlist and metric-labels-allowlist for ResourceQuota by @opeco17 in kubernetes#2175

• [FEATURE] Allow field KV general matching by @rexagod in kubernetes#2067

• [FEATURE] Support hot reload for kubeconfig by @opeco17 in kubernetes#2144

• [FEATURE] Add support for endpoint topology routing hints by @MarkSRobinson in kubernetes#2090

v2.9.2 / 2023-05-30

This release does not incorporate any user-facing changes. Re-running release procedures as the process for the previous release failed. Changes are listed in v2.9.0.

v2.9.1 / 2023-05-29

This release does not incorporate any user-facing changes. Re-running release procedures as the process for the previous release failed. Changes are listed in v2.9.0.

v2.9.0 / 2023-05-23

The changes mentioned below are only the user-facing ones. For a list of the complete set of changes, refer the changelog associated with the release tag.

Note

• The deprecated experimental VerticalPodAutoscaler metrics are no longer supported, and have been removed. We recommend to use CustomResourceState metrics to gather metrics from custom resources like the Vertical Pod Autoscaler.

• #2004 regulated label names to adhere with OTel-Prometheus standards, so existing label names that do not follow the same may be replaced by the ones that do. Please refer to the PR for more details.

• [BUGFIX] Adhere to OTel-Prometheus standard for labels #2004 @rexagod

• [BUGFIX] Respect relative paths for label resolutions #2007 @rexagod

• [BUGFIX] Support LabelsFromPath functionality for Info-typed metrics #2048 @murphd40

• [CHANGE] Remove VerticalPodAutoscaler #2017 @mrueg

• [ENHANCEMENT] Add StatefulSet Start Ordinal metrics for KEP-3335 #1959 @pwschuurman

• [ENHANCEMENT] Add namespace label to kube_lease_renew_time #2073 @A-Hilaly

• [ENHANCEMENT] Add parameters for PodSecurity #2042 @jcpunk

• [ENHANCEMENT] Add support for multi cluster prometheus alerts #2058 @jkroepke

• [ENHANCEMENT] Don't crash on non-existent path values #1998 @rexagod

• [ENHANCEMENT] Only use OpenMetrics and Text in contentType #2024 @CatherineF-dev

• [ENHANCEMENT] Update go version to 1.20.4 #2056 @RamakrishnanArun

• [FEATURE] Add support for variable VKs in CRS config #1851 @rexagod

• [FEATURE] Support quantities and percentages #1989 @mrueg

• [FEATURE] Use prometheus/exporter-toolkit landing page #2034 @mrueg

v2.8.2 / 2023-03-17

• [BUGFIX] Only use OpenMetrics and Text in contentType #2024 @CatherineF-dev

v2.8.1 / 2023-02-22

• [BUGFIX] Don't crash on non-existent paths @rexagod #1998
• [BUGFIX] Fix public Builder compatibility with BuilderInterface @clamoriniere #1994

v2.8.0 / 2023-02-10

Note: The --version flag was removed as kube-state-metrics version also provides the same information. See #1956

Note: Experimental CustomResourceState changed their labels for better usability. See #1942 kube_crd_uptime{group="myteam.io", kind="Foo", version="v1"} -> kube_customresource_uptime{customresource_group="myteam.io", customresource_kind="Foo", customresource_version="v1"}

• [CHANGE] Prefix Group, Version and Kind labels for CustomResourceState Metrics #1942 @bavarianbidi
• [CHANGE] Fix empty string for "owner_*" dimensions #1923 @pawcykca
• [CHANGE] Remove broken --version flag, replace by version command #1956 @bjorand
• [FEATURE] Add metrics for EndpointSlices #1910 @mrueg
• [FEATURE] Add metrics for config file changes #1916 @mrueg
• [FEATURE] Add metrics for CustomResource State config file change #1928 @mrueg
• [FEATURE] Reload Kube-State-Metrics on CustomResourceState config file change #1930 @mrueg
• [FEATURE] Make CustomResourceState metrics type dynamic #1930 @rexagod
• [FEATURE] Add kube_pod_status_qos_class to pod metrics #1932 @frezes
• [FEATURE] Add kube_pod_status_ready_time and kube_pod_status_containers_ready_time metrics #1938 @ryanrolds
• [FEATURE] Enrich UserAgent with more information about kube-state-metrics #1960 @mrueg
• [FEATURE] Convert True/False to 1.0/0.0 values in CustomResourceState metrics #1963 @jabdoa2
• [FEATURE] Expose metrics in OpenMetrics format #1974 @mrueg
• [BUGFIX] Handle unit length valueFrom values #1958 @rexagod
• [ENHANCEMENT] Build with kubernetes 1.26 #1933 @mrueg

v2.7.0 / 2022-11-25

Note: Experimental VerticalPodAutoscaler metrics are considered deprecated in this release and will be removed in v2.9.0. Please use CustomResourceStateMetrics to gather metrics from VPA resources. See: #1718

Note: Experimental CustomResourceState changed their naming convention for better usability. The name of the CRD used to be interpolated into the name of the metric which made it impossible to aggregate a CRD across different versions. This was changed to have the GVK information represented as labels: kube_myteam_io_v1_Foo_uptime -> kube_crd_uptime{group="myteam.io", kind="Foo", version="v1"} See: #1847

• [CHANGE] Deprecate VerticalPodAutoscaler metrics #1835 @rexagod
• [CHANGE] Recommend kube-scheduler metrics for container resource limits and requests #1849 @rexagod
• [FEATURE] Add experimental kube_pod_container_status_last_terminated_exitcode metric #1752 @ssabo
• [FEATURE] Introduce custom-resources-only flag #1813 @bavarianbidi
• [FEATURE] Allow allowlist filtering by wildcard key #1823 @rexagod
• [FEATURE] Add ContainerResourceSourceType to hpa spec and target metrics #1831 @whitebear009
• [FEATURE] Represent group, version and kind of a resource as labels #1850 @rexagod
• [FEATURE] Sharding metrics per node via fieldSelector #1864 @CatherineF-dev
• [FEATURE] Add experimental StatefulSet retention policy metrics #1876 @mattcary
• [FEATURE] Allow labelFromKey field for all applicable metric types #1880 @rexagod
• [FEATURE] Introduce Viper, allow hot-reload on config change #1827 @rexagod
• [FEATURE] Introduce Cobra, allow configuration via environment variables #1834 @rexagod
• [FEATURE] Add experimental kube_node_deletion_timestamp metric #1890 @rexagod
• [FEATURE] Support autoscaling/v2 resources for HorizontalPodAutoscaler #1906 @JoaoBraveCoding
• [FEATURE] Add IngressClass metrics #1905 @kaitoii11
• [ENHANCEMENT] Import Kubernetes metrics stability framework #1844 @CatherineF-dev
• [ENHANCEMENT] Promote kube_pod_container_status_waiting_reason and kube_deployment_status_replicas_ready to stable #1821 @CatherineF-dev
• [ENHANCEMENT] Build with Kubernetes 1.25 and go 1.19 #1819 @mrueg
• [BUGFIX] Handle singular labels in allowlist #1826 @rexagod
• [BUGFIX] Do not expose ingress path metric when service is nil #1841 @evir35
• [BUGFIX] Allow lease metrics to be exported across all namespaces #1845 @lantingchiang

v2.6.0 / 2022-08-26

• [FEATURE] Add local storage labels to kube_persistentvolume_info #1814 @nabokihms
• [FEATURE] Add support for StateSet and Info metrics for Custom-Resource State #1777 @chrischdi
• [FEATURE] Add support for Rolebinding resource metrics #1799 @kaitoii11
• [FEATURE] Add new kube_horizontalpodautoscaler_status_target_metric #1725 @tanguyfalconnet
• [FEATURE] Add support for Role and Clusterrole resource metrics #1759 @kaitoii11
• [FEATURE] Add support for the ServiceAccount resource metrics #1773 @Serializator
• [FEATURE] Add metric for pod tolerations #1769 @Serializator
• [FEATURE] Add new kube_endpoint_address metric #1761 @bavarianbidi
• [FEATURE] Support reading the timestamp fields of custom resources #1766 @dontan001
• [ENHANCEMENT] Migrate to structured logging #1807 @dmpe
• [ENHANCEMENT] Switch registry vanity domain from k8s.gcr.io to registry.k8s.io #1750 @mrueg
• [ENHANCEMENT] Graduate new endpoint metrics to stable #1812 @bavarianbidi
• [BUGFIX] Fix label name for kube_pod_nodeselector #1756 @yosshi825
• [BUGFIX] Fix Custom-Resource State Metrics not to contain underscores #1754 @chrischdi
• [BUGFIX] Fix kube_node_status_allocatable unit doc #1760 @jumbosushi

v2.5.0 / 2022-06-03

• [FEATURE] Add experimental Custom-Resource State Metrics #1710 @iamnoah
• [FEATURE] Add kube_pod_ips metric #1740 @bjschafer
• [FEATURE] Add kube_pod_nodeselector metric #1675 @geojaz
• [FEATURE] Add CSIPersistentVolumeSource to persistent volume metric #1727 @luke-sprig
• [FEATURE] Add kube_cronjob_status_last_successful_time metric #1732 @splitice
• [FEATURE] Add kube_persistentvolumeclaim_created metric #1741 @aidan-ogorman-dev
• [ENHANCEMENT] Build with Go 1.18 #1726, #1745 @mrueg
• [ENHANCEMENT] Bump kubernetes 1.24 and other go dependencies #1726, #1743 @mrueg
• [ENHANCEMENT] Update x/crypto to mitigate CVE-2022-27191 #1721 @pgvishnuram
• [BUGFIX] Assert that newlines in comma separated arguments are ignored #1706 @sthaha
• [BUGFIX] Fix potential panic in pod store #1723 @mfojtik
• [BUGFIX] Fix potential panic in internal store #1731 @jan--f
• [BUGFIX] Properly initialize KSM Server test #1699 @fpetkovski

v2.4.2 / 2022-02-10

• [BUGFIX] Publish images with with the correct tag

v2.4.1 / 2022-02-10

• [FEATURE] Add ingressclass label to kube_ingress_info metric #1652 @adammw
• [FEATURE] Extend KSM library to support custom resource metrics #1644 @Garrybest
• [ENHANCEMENT] Use apiVersion v1 for PodDisruptionBudget and CronJob resources #1491 @bison
• [ENHANCEMENT] Optimize slice allocations #1676 @sherifabdlnaby
• [BUGFIX] Use plural form of resource name in allowlist for PodDisruptionBudget #1653 @arajkumar

v2.3.0 / 2021-12-09

• [FEATURE] Add a --namespace-denylist command line flag to exclude metrics from certain namespaces #1596 #1595 @mallow111
• [FEATURE] Add kube_*_labels and kube_*_annotations metrics for Pod Disruption Budgets #1623 @arajkumar
• [FEATURE] Add a Kustomization file for deploying KSM in authosharding mode #1603 @karancode
• [FEATURE] Expose a metric for the number of ports in endpoint objects #1571 @bavarianbidi
• [FEATURE] Add a command line flag for opt-in metrics #1643 @Serializator
• [FEATURE] Add kube_horizontalpodautoscaler_info metric #1648 @Serializator
• [ENHANCEMENT] Update Go to 1.17.4 #1649 @fpetkovski
• [ENHANCEMENT] Update Kubernetes to 1.23 #1649 @fpetkovski
• [BUGFIX] Report the correct architecture for arm64 images #1629 @Serializator

v2.2.4 / 2021-11-08

• [BUGFIX] Fix BuilderInterface and BuildStoresFunc to allow using KSM as a library #1618 @ahmed-mez

v2.2.3 / 2021-10-13

• [BUGFIX] Fix the image build job. Reverts #1602

v2.2.2 / 2021-10-13

• [BUGFIX] Downgrade latest allowed go version to 1.16.9 #1601 @mrueg
• [BUGFIX] Fix CI variable names used for building KSM images @mrueg

v2.2.1 / 2021-09-24

• [FEATURE] Add the kube_persistentvolumeclaim_annotations metric which exposes annotations on PVCs #1566 @arajkumar
• [BUGFIX] Revert the accidentally removed kube_persistentvolumeclaim_labels metric #1566 @arajkumar
• [BUGFIX] Filter annotations in metrics based on --metric-annotations-allowlist instead of --metric-labels-allowlist for CronJob, Daemonset, HPA and Ingress resources #1580 @midnw
• [BUGFIX] Avoid panicking when VPA objects have no targetRef #1584 @nabokihms

v2.2.0 / 2021-08-24

• [FEATURE] Add --use-apiserver-cache flag to set resourceVersion=0 for ListWatch requests #1548
• [FEATURE] Introduce metrics for Kubernetes object annotations #1468
• [FEATURE] Introduce start time metric for containers in terminated state #1519
• [FEATURE] Introduce metrics for cronjob job history limits #1535
• [FEATURE] Add system_uuid dimension to kube_node_info metric #1535
• [FEATURE] Add available replica metric for statefulsets #1532
• [FEATURE] Add ready replica metric for deployments #1534
• [CHANGE] Update go clients for Kubernetes to support 1.22 #1545
• [CHANGE] Use new promlint package and update prometheus cli to 2.28.1 #1531

v2.1.1 / 2021-07-28

• [CHANGE] go.mod: Update and minimize dependencies #1529
• [CHANGE] Use BuilderInterface instead of internal/store.Builder in metricshandler #1537
• [CHANGE] Add WithAllowLabels to public BuilderInterface #1514
• [BUGFIX] Fixes a bug where KSM did not export any metrics when it had no permissions for resources in at least one namespace #1499

v2.1.0 / 2021-06-04

• [CHANGE] Update go version and dependencies #1493

v2.1.0-rc.0 / 2021-05-20

• [FEATURE] Add support for native TLS #1354
• [FEATURE] Add wildcard option to metric-labels-allowlist #1403
• [FEATURE] Add build info metric #1332
• [CHANGE] Add "uid" label to every pod metric #1304
• [CHANGE] Add resourceVersion to CronJob metrics #1447
• [CHANGE] Update go version and dependencies #1474
• [CHANGE] Bump client-go and friends to v0.21 (Kubernetes v1.21) #1463
• [CHANGE] Replace deprecated use of ioutil #1458
• [BUGFIX] Fix builder.Builder WithMetrics signature #1455
• [BUGFIX] Fix pod-metric missing reasons #1287
• [BUGFIX] Fix multiListWatch resourceVersion mismatch if watch reconnected #1377

v2.0.0 / 2021-04-13

• [CHANGE] Update go version and dependencies #1440

v2.0.0-rc.1 / 2021-03-26

• [CHANGE] Rename --labels-metric-allow-list to --metric-labels-allowlist #1424
• [CHANGE] Remove deprecated Kubernetes APIs #1423
• [CHANGE] go.mod: Update Dependencies #1419
• [CHANGE] Remove vendor folder #1419
• [CHANGE] k8s.gcr.io/kube-state-metrics/kube-state-metrics becomes the authoritative registry Location on quay.io will not be updated anymore. Previously pushed images will be kept around to avoid breaking existing deployments.

v2.0.0-rc.0 / 2021-03-04

• [CHANGE] internal/store/pod.go: Only create waiting_reason series if pods are in waiting state #1378
• [CHANGE] internal/store/pod.go: Only create terminated_reason series if pods are in terminated state #1381
• [CHANGE] internal/store/pod.go: Only create last_terminated containers series if containers are terminated state #1397
• [FEATURE] Bump client-go and friends to v0.20 (kubernetes v1.20) #1328
• [FEATURE] Bump go version to 1.16+ #1399
• [BUGFIX] Fix gzip writer #1372
• [BUGFIX] fix labels-metric-allow-list documentation #1404
• [BUGFIX] Propagate resource version when sharded #1402

v2.0.0-beta / 2020-12-04

Promotion to beta release after a period of no bugs.

v2.0.0-alpha.3 / 2020-11-19

• [BUGFIX] Fix container resource limits metrics, which got dropped #1293
• [BUGFIX] Adjust and refactor allowing labels to work for Kubernetes labels metrics #1301 Note this is a breaking change, if you were using --labels-allow-list, look at the PR details for more information.

v2.0.0-alpha.2 / 2020-10-27

• [CHANGE] Migrate ingress and certificates to new stable APIs #1260
• [CHANGE] Revert "Rework resource metrics" #1278 To better align with future Kubernetes resource metrics, the changes to resource metrics were reverted, new metrics are: kube_pod_container_resource_requests and kube_pod_container_resource_limits
• [FEATURE] Added the job failure reason in kube_job_status_failed metric #1214
• [FEATURE] feat(persistentvolume): claimRef info to labels (kube_persistentvolume_claim_ref) #1244
• [FEATURE] pod: add gauge for runtimeclass handler (kube_pod_runtimeclass_name_info) #1276

v2.0.0-alpha.1 / 2020-10-06

• [CHANGE] Update go module path to k8s.io/kube-state-metrics/v2 #1238
• [CHANGE] Bump klog to v2 and client-go to 1.19 #1250
• [FEATURE] Add iscsi initiator name to persistentvolume_info #1235
• [BUGFIX] Added Namespace to Rolebinding Jsonnet #1233
• [BUGFIX] Reference closure scoped family generator #1240

v2.0.0-alpha / 2020-09-16

NOTE: This is a major new alpha 2.0 release with breaking changes and removed metrics. See details below!

• [CHANGE] Apply boundaries to metrics and allow via flag (--labels-allow-list) what labels to include #1125
• [CHANGE] Update DaemonSet updated_number_scheduled metric name to be consistent #1181 Metric was changed from kube_daemonset_updated_number_scheduled to kube_daemonset_status_updated_number_scheduled
• [CHANGE] Rework resource metrics #1168 Metrics kube_pod_container_resource_requests, kube_pod_container_resource_limits, kube_pod_overhead, kube_pod_init_container_resource_limits, kube_pod_init_container_resource_requests changed
• [CHANGE] Convert k8s labels to snake case #1165
• [CHANGE] Mutatingwebhookconfiguration.go: Switch to v1 #1144
• [CHANGE] v2: Rename storage class labels reclaimPolicy to reclaim_policy and volumeBindingMode to volume_binding_mode #1107
• [CHANGE] v2: Renamed --namespace flag to --namespaces #1098
• [CHANGE] Rename kube_pod_deleted to kube_pod_deletion_timestamp #1079
• [CHANGE] v2: Rename collector flag to resource flag #1006 --resources is the new flag
• [CHANGE] Remove non-identifying labels from pod metrics #1009
• [CHANGE] v2: Remove deprecated stable metrics #1004 Note that some of these were replaced with EXPERIMENTAL resource metrics. See #1168 for more details. 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
  • 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
• [CHANGE] Rename black-/whitelist to allow/deny-list #1045 New flags are --metric-allowlist and --metric-denylist
• [CHANGE] Update telemetry port to 8081 #1049
• [CHANGE] v2: Rename hpa metrics to use full horizontalpodautoscaler #1003 All metrics with prefix of kube_hpa_ were renamed to kube_horizontalpodautoscaler_
• [CHANGE] v2: change metrics port to 8080, telemetry port to 8081 #1005
• [FEATURE] Add http request metric for kube-state-metrics main /metrics #1218
• [FEATURE] Add fc/iscsi/nfs identifier tags to persistentvolume_info metric #1208
• [FEATURE] Adds new pod metric kube_pod_container_state_started #1183
• [FEATURE] Add observedGeneration metric (kube_daemonset_status_observed_generation) for DaemonSets #1178
• [FEATURE] Add internal_ip to node_info #1172
• [FEATURE] Avoid conflicts when mapping Kubernetes labels to Prometheus labels #1156
• [FEATURE] Add aws/gce volume id to kube_persistentvolume_info #1146
• [FEATURE] Add UnexpectedAdmissionError to kube_pod_status_reason metric #1145
• [FEATURE] Add init container requests (kube_pod_init_container_resource_requests) #1123
• [FEATURE] Add host_network to kube_pod_info #1100
• [FEATURE] Add kube_replicationcontroller_owner #1058
• [FEATURE] Pod: add gauges for pod overhead (kube_pod_overhead) #1053
• [FEATURE] Add "Terminating" status in kube_pod_status_phase metrics #1013
• [FEATURE] Add lease collector metrics #1038
• [ENHANCEMENT] Add DeprecatedVersion to struct FamilyGenerator and func NewFamilyGenerator #1160
• [ENHANCEMENT] Add security context to deployment and statefulset #1034
• [BUGFIX] Fix VolumeAttachment API version mismatch: expected v1 but watching v1beta1 #1136
• [BUGFIX] Fix various CI issues (kube_volumeattachment_info nodeName -> node label rename) #1117
• [BUGFIX] Fix maxUnavailable to round down instead up #1076

v1.9.7 / 2020-05-24

• [BUGFIX] internal/store/mutatingwebhookconfiguration.go: Switch to v1 #1144

v1.9.6 / 2020-05-06

• [BUGFIX] Fix VolumeAttachment API version mismatch: expected v1 but watching v1beta1 #1136

v1.9.5 / 2020-02-20

• [BUGFIX] Switch to using only v1 client of validatingwebhookconfiguration #1052

v1.9.4 / 2020-02-03

• [BUGFIX] Fix VolumeAttachment api version to be used (was v1beta1, should have been v1). #1043
• [BUGFIX] Fix MutatingWebhookConfiguration api version to be used (was v1beta1, should have been v1). #1043
• [BUGFIX] Fix ValidatingWebhookConfiguration api version to be used (was v1beta1, should have been v1). #1043
• [BUGFIX] Use the correct for NetworkPolicy reflector. #1042

v1.9.3 / 2020-01-22

• [CHANGE] Remove experimental hpa metrics kube_hpa_status_current_metrics_average_utilization and kube_hpa_status_current_metrics_average_value #1030

v1.9.2 / 2020-01-13

• [BUGFIX] Fix segfault with External metrics #1023

v1.9.1 / 2020-01-10

• [BUGFIX] Fix segfault in hpa metrics #1019
• [BUGFIX] Fix nil panics when parsing hpa memory current metrics #1014

v1.9.0 / 2019-12-20

After a testing period of 7 days, there were no additional bugs found or features introduced.

v1.9.0-rc.1 / 2019-12-12

• [BUGFIX] Move resource version from metric label to metric number value #997

v1.9.0-rc.0 / 2019-12-04

• [CHANGE] Add tools as go modules #927
• [FEATURE] Add kube_hpa_spec_target_metric metric. #966
• [FEATURE] Add hpa stats for current utilization and average value. #961
• [FEATURE] Add kube_namespace_status_condition metric. #949
• [FEATURE] Add kube_persistentvolumeclaim_status_condition and kube_persistentvolumeclaim_status_phase metrics #952
• [FEATURE] Add kube_networkpolicy_* metrics #893
• [FEATURE] Add kube_volumeattachment_* metrics #946
• [FEATURE] add kube_mutatingwebhookconfiguration_*, kube_validatingwebhookconfiguration_* metrics #914
• [ENHANCEMENT] Add pod_cidr label to the kube_node_info metric. #963
• [ENHANCEMENT] Generate all manifests from jsonnet #908
• [ENHANCEMENT] Add kube-state-metrics alerting rules. #962
• [ENHANCEMENT] Add "Evicted" to the set of container terminated reasons. #968
• [BUGFIX] Add check for ReclaimPolicy, VolumeBindingMode storageclass metrics. #929
• [BUGFIX] Use single MultiListerWatcher for single store to fix missing metrics when watching multiple namespaces. #969
• [BUGFIX] Fix nil panics parsing HPA CPU current metrics. #993

v1.8.0 / 2019-10-01

After a testing period of 7 days, there were no additional bugs found or features introduced.

v1.8.0-rc.1 / 2019-09-24

• [CHANGE] Pin go version to go mod artifact file #882
• [BUGFIX] Correct mapping of hpa condition status labels #890

v1.8.0-rc.0 / 2019-09-10

• [FEATURE] Introduce sharding (and experimental auto-sharding) #613
• [FEATURE] Add kube_pod_status_unschedulable metric #835
• [CHANGE] Makefile: Remove tmpdir after container build #867
• [ENHANCEMENT] Add metrics about kube-state-metric's interaction with the Kubernetes API. #866
• [FEATURE] Add kube_node_role metric #877
• [ENHANCEMENT] Add support for Darwin OS in e2e test #879

v1.7.2 / 2019-08-05

• [CHANGE] Revert "add kube_*_annotations metrics for all objects" #859
• [CHANGE] Remove kube_namespace_annotations metric #859

v1.7.1 / 2019-07-18

• [BUGFIX] Fix crash due to missing ingress http block. #831
• [BUGFIX] Add nil guard checks when querying VPA objects. #832

v1.7.0 / 2019-07-17

After a testing period of 7 days, there were no additional bugs found or features introduced.

v1.7.0-rc.1 / 2019-07-10

• [BUGFIX] Use the appsv1 apigroup when building the reflector for replicasets. #816

v1.7.0-rc.0 / 2019-07-10

• [CHANGE] Use appsv1 apigroup for ReplicaSet. #804
• [CHANGE] Use distroless/static as base image to further reduce image size. #748
• [CHANGE] Return standardized text for health endpoint. #767
• [ENHANCEMENT] Add DeadlineExceeded pod termination reason. #740
• [ENHANCEMENT] Add CreateContainerError and InvalidImageName waiting reasons. #763
• [FEATURE] Add Pod init container metrics. #762
• [FEATURE] Add Metrics About StorageClass. #777
• [FEATURE] Allow black/white- listing of metrics by regex. #773
• [FEATURE] Add metrics for VerticalPodAutoscaler objects (experimental and disabled by default). #791
• [FEATURE] Add (experimental) kube_*_annotations metrics. #770

v1.6.0 / 2019-05-06

After a testing period of 10 days (release candidate 2), there were no additional bugs found, thus releasing the stable version v1.6.0.

• [FEATURE] Add kube_replicaset_labels to replicaset collector (#638).
• [FEATURE] Add ingresses collector (#640).
• [FEATURE] Add certificate signing request collector (#650).
• [FEATURE] Add kube_persistentvolumeclaim_access_mode metric (#673).
• [FEATURE] Add kube_persistentvolume_capacity metric (#674).
• [FEATURE] Add kube_job_owner metric (#681).
• [ENHANCEMENT] Add priority_class label to kube_pod_info metric (#713).
• [BUGFIX] Bump addon-resizer patch version reducing resource consumption (#724).
• [BUGFIX] Use k8s.io/api/apps/v1 for DaemonSet, Deployment and StatefulSet reflector (#720).

v1.5.0 / 2019-01-10

After a testing period of 30 days, there were no additional bugs found or features introduced. Due to no bugs being reported over an in total 41 days period, we feel no more pre-releases are necessary for a stable release.

This release's focus was a large architectural change in order to improve performance and resource usage of kube-state-metrics drastically. Special thanks to @mxinden for his hard work on this! See the changelog of the pre-releases for more detailed information and related pull requests.

An additional change has been requested to be listed in the release notes:

• [CHANGE] Due to removal of the surrounding mechanism the ksm_resources_per_scrape and ksm_scrape_error_total metrics no longer exists.

v1.5.0-beta.0 / 2018-12-11

After a testing period of 11 days, there were no additional bugs found or features introduced.

v1.5.0-alpha.0 / 2018-11-30

• [CHANGE] Disable gzip compression of kube-state-metrics responses by default. Can be re-enabled via --enable-gzip-encoding. See #563 for more details.
• [FEATURE] Add kube_replicaset_owner metric (#520).
• [FEATURE] Add kube_pod_container_status_last_terminated_reason metric (#535).
• [FEATURE] Add stateful_set_status.{current,update}_revision metric (#545).
• [FEATURE] Add pod disruption budget collector (#551).
• [FEATURE] Make kube-state-metrics usable as a library (#575).
• [FEATURE] Add kube_service_spec_external_ip metric and add external_name and load_balancer_ip label to kube_service_info metric (#571).
• [ENHANCEMENT] Add uid info in kube_pod_info metric (#508).
• [ENHANCEMENT] Update addon-resizer to 1.8.3 and increase resource limits (#552).
• [ENHANCEMENT] Improve metric caching and rendering performance (#498).
• [ENHANCEMENT] Adding CreateContainerConfigError as possible reason for container not starting (#578).

v1.4.0 / 2018-08-22

After a testing period of 16 days, there were no additional bugs found or features introduced.

v1.4.0-rc.0 / 2018-08-06

• [CHANGE] kube_job_status_start_time and kube_job_status_completion_time metric types changed from counter to gauge.
• [CHANGE] job label to job_name as this collides with the Prometheus job label.
• [FEATURE] Allow white- and black-listing metrics to be exposed.
• [FEATURE] Add kube_node_status_capacity and kube_node_status_allocatable metrics.
• [FEATURE] Add kube_pod_status_scheduled_time metric.
• [FEATURE] Add kube_pod_container_status_waiting_reason and kube_pod_container_status_terminated_reason metrics.
• [ENHANCEMENT] Add generic resource metrics for Pods, kube_pod_container_resource_requests and kube_pod_container_resource_limits. This deprecates the old resource metrics for Pods.
• [ENHANCEMENT] Prefer protobuf over json when communicating with the Kubernetes API.
• [ENHANCEMENT] Add dynamic volume support.
• [ENHANCEMENT] Properly set kube-state-metrics user agent when performing requests against the Kubernetes API.
• [BUGFIX] Fix incrorrect HPA metric labels.

v1.3.1 / 2018-04-12

• [BUGFIX] Use Go 1.10.1 fixing TLS and memory issues.
• [BUGFIX] Fix Pod unknown state.

v1.3.0 / 2018-04-04

After a testing period of 12 days, there were no additional bugs found or features introduced.

v1.3.0-rc.0 / 2018-03-23

• [CHANGE] Removed --in-cluster flag in #371. Users can no longer specify --apiserver with --in-cluster=true. To emulate this behaviour in future releases, set the KUBERNETES_SERVICE_HOST environment variable to the value of the --apiserver argument.
• [FEATURE] Allow to specify multiple namespace.
• [FEATURE] Add kube_pod_completion_time, kube_pod_spec_volumes_persistentvolumeclaims_info, and kube_pod_spec_volumes_persistentvolumeclaims_readonly metrics to the Pod collector.
• [FEATURE] Add kube_node_spec_taint metric.
• [FEATURE] Add kube_namespace_annotations metric.
• [FEATURE] Add kube_deployment_spec_strategy_rollingupdate_max_surge metric.
• [FEATURE] Add kube_persistentvolume_labels metric.
• [FEATURE] Add kube_persistentvolumeclaim_lables metric.
• [FEATURE] Add kube_daemonset_labels metric.
• [FEATURE] Add Secret metrics.
• [FEATURE] Add ConfigMap metrics.
• [ENHANCEMENT] Add additional reasons to kube_pod_container_status_waiting_reason metric.
• [BUGFIX] Fix namespacing of HPA.
• [BUGFIX] Fix namespacing of PersistentVolumes.
• [BUGFIX] Fix CronJob tab parsing.

v1.2.0 / 2018-01-15

After a testing period of 10 days, there were no additional bugs found or features introduced.

v1.2.0-rc.0 / 2018-01-05

• [CHANGE] The CronJob collector now expects the version to be v1beta1.
• [FEATURE] Add Endpoints metrics collector.
• [FEATURE] Add PersistentVolume metrics collector.
• [FEATURE] Add HorizontalPodAutoscaler metrics collector.
• [FEATURE] Add kube_pod_container_status_terminated_reason metric.
• [FEATURE] Add kube_job_labels metric.
• [FEATURE] Add kube_cronjob_labels metric.
• [FEATURE] Add kube_service_spec_type metric.
• [FEATURE] Add kube_statefulset_status_replicas_current metric.
• [FEATURE] Add kube_statefulset_status_replicas_ready metric.
• [FEATURE] Add kube_statefulset_status_replicas_updated metric.
• [ENHANCEMENT] Allow specifying the host/IP kube-state-metrics binds to.
• [ENHANCEMENT] Add volumename label to kube_persistentvolumeclaim_info metric.
• [ENHANCEMENT] Add cluster_ip label to kube_service_info metric.
• [ENHANCEMENT] Print version on startup and useful debug information at runtime.
• [ENHANCEMENT] Add metrics for kube-state-metrics itself. For separation purposes this listens on a separate host/IP and port, both configurable respectively.

v1.1.0 / 2017-10-19

After a testing period of one week, there were no additional bugs found or features introduced.

v1.1.0-rc.0 / 2017-10-12

• [FEATURE] Add kube_pod_container_status_waiting_reason metric.
• [FEATURE] Add kube_node_status_capacity_nvidia_gpu_cards and kube_node_status_allocatable_nvidia_gpu_cards metrics.
• [FEATURE] Add kube_persistentvolumeclaim_info, kube_persistentvolumeclaim_status_phase and kube_persistentvolumeclaim_resource_requests_storage_bytes metrics.
• [FEATURE] Add kube_cronjob_created metric.
• [FEATURE] Add kube_namespace_status_phase, kube_namespace_labels and kube_namespace_created metrics.
• [FEATURE] Add *_created metrics for all available collectors and resources.
• [FEATURE] Add ability to specify glog flags.
• [FEATURE] Add ability to limit kube-state-metrics objects to single namespace.
• [ENHANCEMENT] Bump client-go to 5.0 release branch.
• [ENHANCEMENT] Add pprof endpoints for profiling.
• [ENHANCEMENT] Log resources and API versions used when collecting metrics from objects.
• [ENHANCEMENT] Log number of resources used to generate metrics off of.
• [ENHANCEMENT] Improve a usage message for collectors flag.
• [BUGFIX] Fix Job start time nil panic.

v1.0.1 / 2017-08-24

• [BUGFIX] Fix nil pointer panic when pods have an owner without controllers.

v1.0.0 / 2017-08-09

After a testing period of one week, there were no additional bugs found or features introduced.

v1.0.0-rc.1 / 2017-08-02

• [CHANGE] Remove kube_node_status_ready, kube_node_status_out_of_disk, kube_node_status_memory_pressure, kube_node_status_disk_pressure, and kube_node_status_network_unavailable metrics in favor of one generic kube_node_status_condition metric.
• [CHANGE] Flatten created by label on kube_pod_info metric.
• [FEATURE] Add kube_pod_start_time metric.
• [FEATURE] Add PersistentVolumeClaim metrics.
• [FEATURE] Add StatefulSet metrics.
• [FEATURE] Add Job and CronJob metrics.
• [FEATURE] Add label metrics for deployments.
• [FEATURE] Add kube_pod_owner metrics.
• [ENHANCEMENT] Add provider_id label to kube_node_info metric.
• [BUGFIX] Fix various nil pointer panics.

v0.5.0 / 2017-05-03

• [FEATURE] Add label metrics for Pods, Nodes and Services.
• [FEATURE] Expose number of ready Pods for DaemonSets.
• [FEATURE] Add LimitRange metrics.
• [FEATURE] Add ReplicationController metrics.
• [ENHANCEMENT] Add NodeMemoryPressure, NodeDiskPressure, NodeNetworkUnavailable condition metrics.
• [ENHANCEMENT] Add created_by label to kube_pod_info metric.

v0.4.1 / 2017-02-10

• [BUGFIX] fix panic if max unavailable if rolling update is unset

v0.4.0 / 2017-02-07

• [FEATURE] Add replicaset metrics
• [FEATURE] Add resourcequota metrics
• [FEATURE] Add daemonset metrics
• [FEATURE] Add resource limit and request metrics for pod containers
• [FEATURE] Add node name label to kube_pod_info metric
• [FEATURE] Add rolling update metrics for deployments
• [ENHANCEMENT] Allow disabling collectors
• [ENHANCEMENT] Improve in cluster vs non in cluster configuration

v0.3.0 / 2016-10-18

• [FEATURE] Add pod metrics: kube_pod_status_scheduled, kube_pod_container_requested_cpu_cores and kube_pod_container_requested_memory_bytes
• [FEATURE] Add deployment metric kube_deployment_metadata_generation
• [FEATURE] Add node metric kube_node_spec_unschedulable
• [CHANGE] Rename kube_node_status_allocateable_* to kube_node_status_allocatable_*

v0.2.0 / 2016-09-14

• [CHANGE] Prefix all metrics with kube_
• [CHANGE] Make metric collection synchronous
• [FEATURE] Add a number of node/pod/deployment metrics