k8s_state

README

Kubernetes cluster state collector

Kubernetes is an open-source container orchestration system for automating software deployment, scaling, and management.

This module collects health metrics for the following Kubernetes resources:

• Nodes.
• Pods.

Requirements

• Only works when Netdata is running inside a Kubernetes cluster.
• RBAC: needs list, watch verbs for pod and node resources.
• RBAC: needs get verb for namespace resource.

Metrics

All metrics have "k8s_state." prefix.

Labels per scope:

• node: k8s_kind, k8s_cluster_id, k8s_cluster_name, k8s_node_name.
• pod: all node scope labels + k8s_namespace, k8s_controller_kind, k8s_controller_name, k8s_pod_uid, k8s_pod_name, k8s_qos_class.
• container: all node/pod scope labels + k8s_container_id, k8s_container_name.

'k8s_cluster_id' value is 'kube-system' namespace UID. 'k8s_cluster_name' currently only appears when running on GKE.

Node

Metric	Scope	Dimensions	Units
node_allocatable_cpu_requests_utilization	node	requests	%
node_allocatable_cpu_requests_used	node	requests	millicpu
node_allocatable_cpu_limits_utilization	node	limits	%
node_allocatable_cpu_limits_used	node	limits	millicpu
node_allocatable_mem_requests_utilization	node	requests	%
node_allocatable_mem_requests_used	node	requests	bytes
node_allocatable_mem_limits_utilization	node	limits	%
node_allocatable_mem_limits_used	node	limits	bytes
node_allocatable_pods_utilization	node	allocated	%
node_allocatable_pods_usage	node	available, allocated	pods
node_condition	node	added dynamically	status
node_schedulability	node	schedulable, unschedulable	state
node_pods_readiness	node	ready	%
node_pods_readiness_state	node	ready, unready	pods
node_pods_condition	node	pod_ready, pod_scheduled, pod_initialized, containers_ready	pods
node_pods_phase	node	running, failed, succeeded, pending	pods
node_containers	node	containers, init_containers	containers
node_containers_state	node	running, waiting, terminated	containers
node_init_containers_state	node	running, waiting, terminated	containers
node_age	node	age	seconds
pod_cpu_requests_used	pod	requests	millicpu
pod_cpu_limits_used	pod	limits	millicpu
pod_mem_requests_used	pod	requests	bytes
pod_mem_limits_used	pod	limits	bytes
pod_condition	pod	pod_ready, pod_scheduled, pod_initialized, containers_ready	state
pod_phase	pod	running, failed, succeeded, pending	state
pod_age	pod	age	seconds
pod_containers	pod	containers, init_containers	containers
pod_containers_state	pod	running, waiting, terminated	containers
pod_init_containers_state	pod	running, waiting, terminated	containers
pod_container_readiness_state	container	ready	state
pod_container_restarts	container	restarts	restarts/s
pod_container_state	container	running, waiting, terminated	state
pod_container_waiting_state_reason	container	added dynamically	state
pod_container_terminated_state_reason	container	added dynamically	state

Configuration

No configuration is needed. This module is enabled when you install Netdata using netdata/helmchart.

Troubleshooting

To troubleshoot issues with the k8s_state collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m k8s_state
  

Documentation

Index

• type KubeState
  • func New() *KubeState
  • func (ks *KubeState) Charts() *module.Charts
  • func (ks *KubeState) Check() bool
  • func (ks *KubeState) Cleanup()
  • func (ks *KubeState) Collect() map[string]int64
  • func (ks *KubeState) Init() bool

Types

type KubeState

type KubeState struct {
	module.Base
	// contains filtered or unexported fields
}

func New

func New() *KubeState

func (*KubeState) Charts

func (ks *KubeState) Charts() *module.Charts

func (*KubeState) Check

func (ks *KubeState) Check() bool

func (*KubeState) Cleanup

func (ks *KubeState) Cleanup()

func (*KubeState) Collect

func (ks *KubeState) Collect() map[string]int64

func (*KubeState) Init

func (ks *KubeState) Init() bool