Kube State Metrics

1 minute read

Kube State Metrics

kube-state-metrics (KSM) is a service that listens to the Kubernetes API server and generates metrics about the state of the objects. It’s an add-on agent to generate and expose cluster-level metrics.

Official Documentation

• Overview: README.md
• Resource-wise documentation: /docs
• Design documentation: /docs/design
• Developer documentation: /docs/developer

Informational Media

• PromCon 2017: Lightning Talk - kube-state-metrics - Frederic Branczyk
• Intro and Deep Dive: Kubernetes SIG Instrumentation - David Ashpole & Han Kang, Frederic Branczyk
• Episode 38: Custom Resources in kube-state-metrics
• kube-state-metrics on Google Cloud

Bug Trackers

• /issues
• issues.redhat.com

Get Involved

• #kube-state-metrics
• #sig-instrumentation
• SIG Instrumentation Biweekly Minutes

Internal Usages

• cluster-monitoring-operator/assets/kube-state-metrics/
• openshift-state-metrics/

Maintainers

• /OWNERS.md

Miscellaneous

• /releases