-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Sam Ghods
committed
May 9, 2016
1 parent
3ee2b63
commit 8f5b735
Showing
1 changed file
with
26 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,45 @@ | ||
# Overview | ||
|
||
kube-state-metrics generates metrics about the state of the object inside of a | ||
Kubernetes cluster. It is not focused on the health of the Kubernetes | ||
components individually, but rather on the health of the various objects | ||
inside, such as deployments, nodes and pods. | ||
kube-state-metrics is a simple service that listens to the Kubernetes API | ||
server and generates metrics about the state of the objects. (See examples in | ||
the Metrics section below.) 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. | ||
|
||
The metrics are exported through the [Prometheus golang | ||
client](https://github.com/prometheus/client_golang) on the HTTP endpoint `/metrics` on | ||
the listening port (default 80). They are served either as plaintext or | ||
protobuf depending on the `Accept` header. They are designed to be consumed | ||
either by Prometheus itself or by a scraper that is compatible with scraping | ||
a Prometheus client endpoint. You can also open `/metrics` in a browser to see | ||
the raw metrics. | ||
|
||
*Requires Kubernetes 1.2+* | ||
|
||
# Usage | ||
|
||
Simply build and run kube-state-metrics inside a Kubernetes pod which has a | ||
service account token that has read-only access to the Kubernetes cluster. | ||
|
||
## Metrics | ||
|
||
There are many more metrics we could report, but this first pass is focused on | ||
those that could result in actionable alerts. Please contribute PR's for | ||
those that could be used for actionable alerts. Please contribute PR's for | ||
additional metrics! | ||
|
||
### WARNING: THESE METRIC/TAG NAMES ARE UNSTABLE AND MAY CHANGE IN A FUTURE RELEASE. | ||
|
||
* nodes ready=<true|false> | ||
* deployment_replicas name=<deployment-name> namespace=<deployment-namespace> | ||
* deployment_replicas_available name=<deployment-name> namespace=<deployment-namespace> | ||
* container_restarts name=<container-name> namespace=<pod-namespace> pod_name=<pod-name> | ||
| Metric name | Labels/tags | | ||
| ------------- | ------------- | | ||
| nodes | ready=<true|false> | | ||
| deployment_replicas | name=<deployment-name> namespace=<deployment-namespace> | | ||
| deployment_replicas_available | name=<deployment-name> namespace=<deployment-namespace> | | ||
| container_restarts | name=<container-name> namespace=<pod-namespace> pod_name=<pod-name> | | ||
|
||
# Usage | ||
|
||
Simply build and run kube-state-metrics inside a Kubernetes pod which has a | ||
service account token that has read-only access to the Kubernetes cluster. | ||
|
||
# Development | ||
|
||
When developing, test a metric dump against your local Kubernetes cluster by running: | ||
|
||
``` | ||
go run main.go --apiserver=<APISERVER-HERE> --in-cluster=false --port=<APISERVER-PORT> --dry-run | ||
go run main.go --apiserver=<APISERVER-HERE> --in-cluster=false --port=<APISERVER-PORT> --dry-run | ||
``` |