kube-state-metrics
Add-on agent to generate and expose cluster-level metrics.
What is kube-state-metrics?
Add-on agent to generate and expose cluster-level metrics.
Overview of kube-state-metrics
What it is
kube-state-metrics (KSM) is a simple service that listens to the Kubernetes API server and generates metrics about the state of the objects. It is not focused on the health of the individual Kubernetes components, but rather on the health of the various objects inside, such as deployments, nodes and pods. It generates metrics from Kubernetes API objects without modification, ensuring that features provided have the same grade of stability as the Kubernetes API objects themselves. The metrics are exported on the HTTP endpoint /metrics on the listening port (default 8080) as plaintext, designed to be consumed by Prometheus or a compatible scraper.
Key features
- Generates metrics about the state of Kubernetes objects (deployments, nodes, pods, etc.)
- Exposes metrics on the
/metricsendpoint (default port 8080) in plaintext - Supports custom resource state metrics (feature-frozen in favor of resource-state-metrics)
- Automatically resolves label name conflicts by adding
_conflictNsuffixes - Supports ECMAScript regular expressions for allow and deny lists
- Exposes its own process metrics, list/watch success/error metrics, HTTP request metrics, and build/configuration metrics
Use cases
- Monitoring the health and state of Kubernetes objects such as deployments, nodes, and pods
- Integrating with Prometheus or other metrics scraping systems to collect cluster-level metrics
- Observing custom resource states via the custom resource state metrics feature
Getting started
See the repository README for installation and quick-start instructions.
License and pricing
License: Apache-2.0. Pricing: open source (free).
Based on the project's public README and repository metadata.