move and split documentation into the `Documentation/` directory
This commit is contained in:
parent
20df7080c4
commit
4d3c866c2b
|
|
@ -0,0 +1,16 @@
|
|||
# Documentation
|
||||
|
||||
This documentation is intended to be a complete reflection of the current state of the exposed metrics of kube-state-metrics.
|
||||
|
||||
Pull requests completeing the metrics documentation as well as sample usages are very welcome.
|
||||
|
||||
Per group of metrics there is one file for all metrics. See each file for specific documentation about the exposed metrics:
|
||||
|
||||
* [DaemonSet Metrics](daemonset-metrics.md)
|
||||
* [Deployment Metrics](deployment-metrics.md)
|
||||
* [LimitRange Metrics](limitrange-metrics.md)
|
||||
* [Node Metrics](node-metrics.md)
|
||||
* [Pod Metrics](pod-metrics.md)
|
||||
* [ReplicaSet Metrics](replicaset-metrics.md)
|
||||
* [ReplicationController Metrics](replicationcontroller-metrics.md)
|
||||
* [ResourceQuota Metrics](resourcequota-metrics.md)
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
# DaemonSet Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_daemonset_status_current_number_scheduled | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_status_number_misscheduled | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_status_desired_number_scheduled | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_status_number_ready | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_metadata_generation | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Deployment Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_deployment_status_replicas | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_replicas_available | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_replicas_unavailable | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_replicas_updated | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_observed_generation | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_spec_replicas | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_spec_paused | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_spec_strategy_rollingupdate_max_unavailable | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_metadata_generation | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# LimitRange Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_limitrange | Gauge | `limitrange`=<limitrange-name> <br> `namespace`=<namespace> <br> `resource`=<ResourceName> <br> `type`=<Pod\|Container\|PersistentVolumeClaim> <br> `constraint`=<constraint>|
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Node Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_node_info | Gauge | `node`=<node-address> <br> `kernel_version`=<kernel-version> <br> `os_image`=<os-image-name> <br> `container_runtime_version`=<container-runtime-and-version-combination> <br> `kubelet_version`=<kubelet-version> <br> `kubeproxy_version`=<kubeproxy-version> |
|
||||
| kube_node_spec_unschedulable | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_ready| Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_out_of_disk | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_phase| Gauge | `node`=<node-address> <br> `phase`=<Pending\|Running\|Terminated> |
|
||||
| kube_node_status_capacity_cpu_cores | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_capacity_memory_bytes | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_capacity_pods | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_allocatable_cpu_cores | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_allocatable_memory_bytes | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_allocatable_pods | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_memory_pressure | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_disk_pressure | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_network_unavailable | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# Pod Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_pod_info | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `host_ip`=<host-ip> <br> `pod_ip`=<pod-ip> <br> `start_time`=<date-time since kubelet acknowledged pod> <br> `node`=<node-name><br> `created_by`=<created_by> |
|
||||
| kube_pod_status_phase | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `phase`=<Pending\|Running\|Succeeded\|Failed\|Unknown> |
|
||||
| kube_pod_status_ready | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_pod_status_scheduled | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_pod_container_info | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `image`=<image-name> <br> `image_id`=<image-id> <br> `container_id`=<containerid> |
|
||||
| kube_pod_container_status_waiting | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_running | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_terminated | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_ready | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_restarts | Counter | `container`=<container-name> <br> `namespace`=<pod-namespace> <br> `pod`=<pod-name> |
|
||||
| kube_pod_container_resource_requests_cpu_cores | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
| kube_pod_container_resource_requests_memory_bytes | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
| kube_pod_container_resource_limits_cpu_cores | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
| kube_pod_container_resource_limits_memory_bytes | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# ReplicaSet metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_replicaset_status_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_status_fully_labeled_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_status_ready_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_status_observed_generation | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_spec_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_metadata_generation | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# ReplicationController metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_replicationcontroller_status_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_fully_labeled_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_ready_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_available_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_observed_generation | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_spec_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_metadata_generation | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# ResourceQuota Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_resourcequota | Gauge | `resourcequota`=<quota-name> <br> `namespace`=<namespace> <br> `resource`=<ResourceName> <br> `type`=<quota-type> |
|
||||
99
README.md
99
README.md
|
|
@ -20,7 +20,7 @@ the raw metrics.
|
|||
|
||||
The latest container image can be found at `gcr.io/google_containers/kube-state-metrics:v0.5.0`.
|
||||
|
||||
## Metrics
|
||||
## Metrics Documentation
|
||||
|
||||
There are many more metrics we could report, but this first pass is focused on
|
||||
those that could be used for actionable alerts. Please contribute PR's for
|
||||
|
|
@ -28,102 +28,7 @@ additional metrics!
|
|||
|
||||
> WARNING: THESE METRIC/TAG NAMES ARE UNSTABLE AND MAY CHANGE IN A FUTURE RELEASE.
|
||||
|
||||
### Node Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_node_info | Gauge | `node`=<node-address> <br> `kernel_version`=<kernel-version> <br> `os_image`=<os-image-name> <br> `container_runtime_version`=<container-runtime-and-version-combination> <br> `kubelet_version`=<kubelet-version> <br> `kubeproxy_version`=<kubeproxy-version> |
|
||||
| kube_node_spec_unschedulable | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_ready| Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_out_of_disk | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_phase| Gauge | `node`=<node-address> <br> `phase`=<Pending\|Running\|Terminated> |
|
||||
| kube_node_status_capacity_cpu_cores | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_capacity_memory_bytes | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_capacity_pods | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_allocatable_cpu_cores | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_allocatable_memory_bytes | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_allocatable_pods | Gauge | `node`=<node-address>|
|
||||
| kube_node_status_memory_pressure | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_disk_pressure | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_node_status_network_unavailable | Gauge | `node`=<node-address> <br> `condition`=<true\|false\|unknown> |
|
||||
|
||||
### DaemonSet Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_daemonset_status_current_number_scheduled | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_status_number_misscheduled | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_status_desired_number_scheduled | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_status_number_ready | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
| kube_daemonset_metadata_generation | Gauge | `daemonset`=<daemonset-name> <br> `namespace`=<daemonset-namespace> |
|
||||
|
||||
### Deployment Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_deployment_status_replicas | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_replicas_available | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_replicas_unavailable | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_replicas_updated | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_status_observed_generation | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_spec_replicas | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_spec_paused | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_spec_strategy_rollingupdate_max_unavailable | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
| kube_deployment_metadata_generation | Gauge | `deployment`=<deployment-name> <br> `namespace`=<deployment-namespace> |
|
||||
|
||||
### Pod Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_pod_info | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `host_ip`=<host-ip> <br> `pod_ip`=<pod-ip> <br> `start_time`=<date-time since kubelet acknowledged pod> <br> `node`=<node-name><br> `created_by`=<created_by> |
|
||||
| kube_pod_status_phase | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `phase`=<Pending\|Running\|Succeeded\|Failed\|Unknown> |
|
||||
| kube_pod_status_ready | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_pod_status_scheduled | Gauge | `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `condition`=<true\|false\|unknown> |
|
||||
| kube_pod_container_info | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `image`=<image-name> <br> `image_id`=<image-id> <br> `container_id`=<containerid> |
|
||||
| kube_pod_container_status_waiting | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_running | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_terminated | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_ready | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> |
|
||||
| kube_pod_container_status_restarts | Counter | `container`=<container-name> <br> `namespace`=<pod-namespace> <br> `pod`=<pod-name> |
|
||||
| kube_pod_container_resource_requests_cpu_cores | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
| kube_pod_container_resource_requests_memory_bytes | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
| kube_pod_container_resource_limits_cpu_cores | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
| kube_pod_container_resource_limits_memory_bytes | Gauge | `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `node`=< node-name> |
|
||||
|
||||
### ResourceQuota Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_resourcequota | Gauge | `resourcequota`=<quota-name> <br> `namespace`=<namespace> <br> `resource`=<ResourceName> <br> `type`=<quota-type> |
|
||||
|
||||
### LimitRange Metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_limitrange | Gauge | `limitrange`=<limitrange-name> <br> `namespace`=<namespace> <br> `resource`=<ResourceName> <br> `type`=<Pod\|Container\|PersistentVolumeClaim> <br> `constraint`=<constraint>|
|
||||
|
||||
### ReplicaSet metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_replicaset_status_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_status_fully_labeled_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_status_ready_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_status_observed_generation | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_spec_replicas | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
| kube_replicaset_metadata_generation | Gauge | `replicaset`=<replicaset-name> <br> `namespace`=<replicaset-namespace> |
|
||||
|
||||
### ReplicationController metrics
|
||||
|
||||
| Metric name| Metric type | Labels/tags |
|
||||
| ---------- | ----------- | ----------- |
|
||||
| kube_replicationcontroller_status_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_fully_labeled_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_ready_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_available_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_status_observed_generation | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_spec_replicas | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
| kube_replicationcontroller_metadata_generation | Gauge | `replicationcontroller`=<replicationcontroller-name> <br> `namespace`=<replicationcontroller-namespace> |
|
||||
See the [`Documentation`](Documentation) directory for documentation of the exposed metrics.
|
||||
|
||||
## kube-state-metrics vs. Heapster
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue