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