github.com/netdata/go.d.plugin@v0.58.1/modules/k8s_state/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-k8s_state 5 plugin_name: go.d.plugin 6 module_name: k8s_state 7 monitored_instance: 8 name: Kubernetes Cluster State 9 link: https://kubernetes.io/ 10 icon_filename: kubernetes.svg 11 categories: 12 - data-collection.kubernetes 13 keywords: 14 - kubernetes 15 - k8s 16 related_resources: 17 integrations: 18 list: [] 19 info_provided_to_referring_integrations: 20 description: "" 21 most_popular: true 22 overview: 23 data_collection: 24 metrics_description: | 25 This collector monitors Kubernetes Nodes, Pods and Containers. 26 method_description: "" 27 supported_platforms: 28 include: [] 29 exclude: [] 30 multi_instance: false 31 additional_permissions: 32 description: "" 33 default_behavior: 34 auto_detection: 35 description: "" 36 limits: 37 description: "" 38 performance_impact: 39 description: "" 40 setup: 41 prerequisites: 42 list: [] 43 configuration: 44 file: 45 name: go.d/k8s_state.conf 46 options: 47 description: "" 48 folding: 49 title: Config options 50 enabled: true 51 list: [] 52 examples: 53 folding: 54 title: Config 55 enabled: true 56 list: [] 57 troubleshooting: 58 problems: 59 list: [] 60 alerts: [] 61 metrics: 62 folding: 63 title: Metrics 64 enabled: false 65 description: "" 66 availability: [] 67 scopes: 68 - name: node 69 description: These metrics refer to the Node. 70 labels: 71 - name: k8s_cluster_id 72 description: Cluster ID. This is equal to the kube-system namespace UID. 73 - name: k8s_cluster_name 74 description: Cluster name. Cluster name discovery only works in GKE. 75 - name: k8s_node_name 76 description: Node name. 77 metrics: 78 - name: k8s_state.node_allocatable_cpu_requests_utilization 79 description: CPU requests utilization 80 unit: '%' 81 chart_type: line 82 dimensions: 83 - name: requests 84 - name: k8s_state.node_allocatable_cpu_requests_used 85 description: CPU requests used 86 unit: millicpu 87 chart_type: line 88 dimensions: 89 - name: requests 90 - name: k8s_state.node_allocatable_cpu_limits_utilization 91 description: CPU limits utilization 92 unit: '%' 93 chart_type: line 94 dimensions: 95 - name: limits 96 - name: k8s_state.node_allocatable_cpu_limits_used 97 description: CPU limits used 98 unit: millicpu 99 chart_type: line 100 dimensions: 101 - name: limits 102 - name: k8s_state.node_allocatable_mem_requests_utilization 103 description: Memory requests utilization 104 unit: '%' 105 chart_type: line 106 dimensions: 107 - name: requests 108 - name: k8s_state.node_allocatable_mem_requests_used 109 description: Memory requests used 110 unit: bytes 111 chart_type: line 112 dimensions: 113 - name: requests 114 - name: k8s_state.node_allocatable_mem_limits_utilization 115 description: Memory limits utilization 116 unit: '%' 117 chart_type: line 118 dimensions: 119 - name: limits 120 - name: k8s_state.node_allocatable_mem_limits_used 121 description: Memory limits used 122 unit: bytes 123 chart_type: line 124 dimensions: 125 - name: limits 126 - name: k8s_state.node_allocatable_pods_utilization 127 description: Pods resource utilization 128 unit: '%' 129 chart_type: line 130 dimensions: 131 - name: allocated 132 - name: k8s_state.node_allocatable_pods_usage 133 description: Pods resource usage 134 unit: pods 135 chart_type: stacked 136 dimensions: 137 - name: available 138 - name: allocated 139 - name: k8s_state.node_condition 140 description: Condition status 141 unit: status 142 chart_type: line 143 dimensions: 144 - name: a dimension per condition 145 - name: k8s_state.node_schedulability 146 description: Schedulability 147 unit: state 148 chart_type: line 149 dimensions: 150 - name: schedulable 151 - name: unschedulable 152 - name: k8s_state.node_pods_readiness 153 description: Pods readiness 154 unit: '%' 155 chart_type: line 156 dimensions: 157 - name: ready 158 - name: k8s_state.node_pods_readiness_state 159 description: Pods readiness state 160 unit: pods 161 chart_type: line 162 dimensions: 163 - name: ready 164 - name: unready 165 - name: k8s_state.node_pods_condition 166 description: Pods condition 167 unit: pods 168 chart_type: line 169 dimensions: 170 - name: pod_ready 171 - name: pod_scheduled 172 - name: pod_initialized 173 - name: containers_ready 174 - name: k8s_state.node_pods_phase 175 description: Pods phase 176 unit: pods 177 chart_type: stacked 178 dimensions: 179 - name: running 180 - name: failed 181 - name: succeeded 182 - name: pending 183 - name: k8s_state.node_containers 184 description: Containers 185 unit: containers 186 chart_type: line 187 dimensions: 188 - name: containers 189 - name: init_containers 190 - name: k8s_state.node_containers_state 191 description: Containers state 192 unit: containers 193 chart_type: stacked 194 dimensions: 195 - name: running 196 - name: waiting 197 - name: terminated 198 - name: k8s_state.node_init_containers_state 199 description: Init containers state 200 unit: containers 201 chart_type: stacked 202 dimensions: 203 - name: running 204 - name: waiting 205 - name: terminated 206 - name: k8s_state.node_age 207 description: Age 208 unit: seconds 209 chart_type: line 210 dimensions: 211 - name: age 212 - name: pod 213 description: These metrics refer to the Pod. 214 labels: 215 - name: k8s_cluster_id 216 description: Cluster ID. This is equal to the kube-system namespace UID. 217 - name: k8s_cluster_name 218 description: Cluster name. Cluster name discovery only works in GKE. 219 - name: k8s_node_name 220 description: Node name. 221 - name: k8s_namespace 222 description: Namespace. 223 - name: k8s_controller_kind 224 description: Controller kind (ReplicaSet, DaemonSet, StatefulSet, Job, etc.). 225 - name: k8s_controller_name 226 description: Controller name. 227 - name: k8s_pod_name 228 description: Pod name. 229 - name: k8s_qos_class 230 description: Pod QOS class (burstable, guaranteed, besteffort). 231 metrics: 232 - name: k8s_state.pod_cpu_requests_used 233 description: CPU requests used 234 unit: millicpu 235 chart_type: line 236 dimensions: 237 - name: requests 238 - name: k8s_state.pod_cpu_limits_used 239 description: CPU limits used 240 unit: millicpu 241 chart_type: line 242 dimensions: 243 - name: limits 244 - name: k8s_state.pod_mem_requests_used 245 description: Memory requests used 246 unit: bytes 247 chart_type: line 248 dimensions: 249 - name: requests 250 - name: k8s_state.pod_mem_limits_used 251 description: Memory limits used 252 unit: bytes 253 chart_type: line 254 dimensions: 255 - name: limits 256 - name: k8s_state.pod_condition 257 description: Condition 258 unit: state 259 chart_type: line 260 dimensions: 261 - name: pod_ready 262 - name: pod_scheduled 263 - name: pod_initialized 264 - name: containers_ready 265 - name: k8s_state.pod_phase 266 description: Phase 267 unit: state 268 chart_type: line 269 dimensions: 270 - name: running 271 - name: failed 272 - name: succeeded 273 - name: pending 274 - name: k8s_state.pod_age 275 description: Age 276 unit: seconds 277 chart_type: line 278 dimensions: 279 - name: age 280 - name: k8s_state.pod_containers 281 description: Containers 282 unit: containers 283 chart_type: line 284 dimensions: 285 - name: containers 286 - name: init_containers 287 - name: k8s_state.pod_containers_state 288 description: Containers state 289 unit: containers 290 chart_type: stacked 291 dimensions: 292 - name: running 293 - name: waiting 294 - name: terminated 295 - name: k8s_state.pod_init_containers_state 296 description: Init containers state 297 unit: containers 298 chart_type: stacked 299 dimensions: 300 - name: running 301 - name: waiting 302 - name: terminated 303 - name: container 304 description: These metrics refer to the Pod container. 305 labels: 306 - name: k8s_cluster_id 307 description: Cluster ID. This is equal to the kube-system namespace UID. 308 - name: k8s_cluster_name 309 description: Cluster name. Cluster name discovery only works in GKE. 310 - name: k8s_node_name 311 description: Node name. 312 - name: k8s_namespace 313 description: Namespace. 314 - name: k8s_controller_kind 315 description: Controller kind (ReplicaSet, DaemonSet, StatefulSet, Job, etc.). 316 - name: k8s_controller_name 317 description: Controller name. 318 - name: k8s_pod_name 319 description: Pod name. 320 - name: k8s_qos_class 321 description: Pod QOS class (burstable, guaranteed, besteffort). 322 - name: k8s_container_name 323 description: Container name. 324 metrics: 325 - name: k8s_state.pod_container_readiness_state 326 description: Readiness state 327 unit: state 328 chart_type: line 329 dimensions: 330 - name: ready 331 - name: k8s_state.pod_container_restarts 332 description: Restarts 333 unit: restarts 334 chart_type: line 335 dimensions: 336 - name: restarts 337 - name: k8s_state.pod_container_state 338 description: Container state 339 unit: state 340 chart_type: line 341 dimensions: 342 - name: running 343 - name: waiting 344 - name: terminated 345 - name: k8s_state.pod_container_waiting_state_reason 346 description: Container waiting state reason 347 unit: state 348 chart_type: line 349 dimensions: 350 - name: a dimension per reason 351 - name: k8s_state.pod_container_terminated_state_reason 352 description: Container terminated state reason 353 unit: state 354 chart_type: line 355 dimensions: 356 - name: a dimension per reason