Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add kube_node_status_images metric #2555

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: Add kube_node_status_images metric #2555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8824400
feat: Add kube_node_status_images metric
hausertt Nov 11, 2024
0d35c3f
Address Review Comment
hausertt Nov 11, 2024
7ea2c0d
fix fmt and remove [STABLE] in e2e Tests
hausertt Nov 12, 2024
025195b
fix: add missing label for e2e
hausertt Nov 12, 2024
1f66d9a
Merge branch 'kubernetes:main' into add_kube_node_status_images_metric
hausertt Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/metrics/cluster/node-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
| kube_node_status_addresses | Gauge | The addresses of a node | | `node`=&lt;node-address&gt; <br> `type`=&lt;address-type&gt; <br> `address`=&lt;address-value&gt; | EXPERIMENTAL |
| kube_node_status_allocatable | Gauge | The amount of resources allocatable for pods (after reserving some for system daemons) | `cpu`=&lt;core&gt; <br> `ephemeral_storage`=&lt;byte&gt; <br> `pods`=&lt;integer&gt; <br> `attachable_volumes_*`=&lt;byte&gt; <br> `hugepages_*`=&lt;byte&gt; <br> `memory`=&lt;byte&gt; | `node`=&lt;node-address&gt; <br> `resource`=&lt;resource-name&gt; <br> `unit`=&lt;resource-unit&gt; | STABLE |
| kube_node_status_condition | Gauge | The condition of a cluster node | | `node`=&lt;node-address&gt; <br> `condition`=&lt;node-condition&gt; <br> `status`=&lt;true\|false\|unknown&gt; | STABLE |
| kube_node_status_images | Gauge | The Container Images that are present on the Node, including the size in bytes. | bytes | `node`=&lt;node-address&gt; <br> `image_digest`=&lt;image_digest&gt; <br> `image_name`=&lt;image_name&gt; <br> `image_size_bytes`=&lt;image_size_bytes&gt; | EXPERIMENTAL |
| kube_node_created | Gauge | Unix creation timestamp | seconds | `node`=&lt;node-address&gt; | STABLE |
| kube_node_deletion_timestamp | Gauge | Unix deletion timestamp | seconds | `node`=&lt;node-address&gt; | EXPERIMENTAL |
35 changes: 35 additions & 0 deletions internal/store/node.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package store

import (
"context"
"strconv"
"strings"

basemetrics "k8s.io/component-base/metrics"
Expand Down Expand Up @@ -56,9 +57,43 @@ func nodeMetricFamilies(allowAnnotationsList, allowLabelsList []string) []genera
createNodeStatusCapacityFamilyGenerator(),
createNodeStatusConditionFamilyGenerator(),
createNodeStateAddressFamilyGenerator(),
createNodeStatusImagesFamilyGenerator(),
}
}

func createNodeStatusImagesFamilyGenerator() generator.FamilyGenerator {
return *generator.NewFamilyGeneratorWithStability(
"kube_node_status_images",
"Container Images on the Node",
metric.Gauge,
basemetrics.ALPHA,
"",
wrapNodeFunc(func(n *v1.Node) *metric.Family {
ms := []*metric.Metric{}
for _, images := range n.Status.Images {
imageDigest := ""
imageName := ""

if len(images.Names) == 2 {
imageDigest = images.Names[0]
imageName = images.Names[1]
} else if len(images.Names) == 1 {
imageName = images.Names[0]
}

ms = append(ms, &metric.Metric{
LabelKeys: []string{"image_digest", "image_name", "image_size_bytes"},
LabelValues: []string{imageDigest, imageName, strconv.FormatInt(images.SizeBytes, 10)},
Value: 1,
})
}
return &metric.Family{
Metrics: ms,
}
}),
)
}

func createNodeDeletionTimestampFamilyGenerator() generator.FamilyGenerator {
return *generator.NewFamilyGeneratorWithStability(
"kube_node_deletion_timestamp",
Expand Down
27 changes: 27 additions & 0 deletions internal/store/node_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,33 @@ func TestNodeStore(t *testing.T) {
"kube_node_created",
},
},
// verify image metrics
{
Obj: &v1.Node{
ObjectMeta: metav1.ObjectMeta{
Name: "127.0.0.1",
},
Status: v1.NodeStatus{
Images: []v1.ContainerImage{
{
Names: []string{"registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.13.0"},
SizeBytes: 253421,
},
{
Names: []string{"registry.k8s.io/busybox/busybox@sha256:5d462a2f5f5eae1e9a9a5dd0f8a0b7d5a5d12", "registry.k8s.io/busybox/busybox:v1.28.0"},
SizeBytes: 23342213,
},
},
},
},
Want: `
# HELP kube_node_status_images Container Images on the Node
# TYPE kube_node_status_images gauge
kube_node_status_images{image_digest="",image_name="registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.13.0",image_size_bytes="253421",node="127.0.0.1"} 1
kube_node_status_images{image_digest="registry.k8s.io/busybox/busybox@sha256:5d462a2f5f5eae1e9a9a5dd0f8a0b7d5a5d12",image_name="registry.k8s.io/busybox/busybox:v1.28.0",image_size_bytes="23342213",node="127.0.0.1"} 1
`,
MetricNames: []string{"kube_node_status_images"},
},
}
for i, c := range cases {
c.Func = generator.ComposeMetricGenFuncs(nodeMetricFamilies(nil, nil))
Expand Down