Skip to content

Commit ef7edb8

Browse files
committed
update doc
1 parent decf6e5 commit ef7edb8

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

plugin/input/k8s/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,12 @@ Example: ```component: '{{ index .pod.Labels "component" | default .k8s_containe
118118

119119
**`meta_file`** *`string`*
120120

121-
The filename to store current k8s pod metadata (`map[Namespace]map[PodName]map[ContainerID]*podMeta`, where `podMeta` is a wrapper for `corev1.Pod`).
121+
The filename to store current k8s pod metadata.
122+
123+
Metadata contains:
124+
* PodMeta `map[Namespace]map[PodName]map[ContainerID]*podMeta`, where `podMeta` is a wrapper for `corev1.Pod`
125+
* CriType `string`
126+
* NodeLabels `map[string]string`
122127

123128
Metadata is saved once per gatherer `MaintenanceInterval` and is loaded only on initialization.
124129

plugin/input/k8s/k8s.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,12 @@ type Config struct {
140140

141141
// > @3@4@5@6
142142
// >
143-
// > The filename to store current k8s pod metadata (`map[Namespace]map[PodName]map[ContainerID]*podMeta`, where `podMeta` is a wrapper for `corev1.Pod`).
143+
// > The filename to store current k8s pod metadata.
144+
// >
145+
// > Metadata contains:
146+
// > * PodMeta `map[Namespace]map[PodName]map[ContainerID]*podMeta`, where `podMeta` is a wrapper for `corev1.Pod`
147+
// > * CriType `string`
148+
// > * NodeLabels `map[string]string`
144149
// >
145150
// > Metadata is saved once per gatherer `MaintenanceInterval` and is loaded only on initialization.
146151
// >

0 commit comments

Comments
 (0)