feat: add restartPolicy to `kube_pod_init_container_info` metric #2240

changhyuni · 2023-11-18T16:09:42Z

What this PR does / why we need it:

This PR adds a label to kube_pod_init_container_info to track the restartPolicy set in the init_container
With sidecar support starting with kubernetes 1.28, init_container can be used restartPolicy
This metric tells you which pods are using the sidecar feature

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
adds a label that is never updated for a given init container

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

k8s-ci-robot · 2023-11-18T16:09:51Z

This issue is currently awaiting triage.

If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

mrueg · 2023-12-12T23:26:14Z

@changhyuni any plans to revive this one? This could be an interesting label

changhyuni · 2023-12-13T00:06:35Z

@mrueg I've reopened it. I'll fix the tests that are failing.

mrueg · 2023-12-14T15:04:10Z

internal/store/pod.go

@@ -677,16 +677,21 @@ func createPodInitContainerInfoFamilyGenerator() generator.FamilyGenerator {
 		"",
 		wrapPodFunc(func(p *v1.Pod) *metric.Family {
 			ms := []*metric.Metric{}
-			labelKeys := []string{"container", "image_spec", "image", "image_id", "container_id"}
+			labelKeys := []string{"container", "image_spec", "image", "image_id", "container_id", "type"}


Suggested change

labelKeys := []string{"container", "image_spec", "image", "image_id", "container_id", "type"}

labelKeys := []string{"container", "image_spec", "image", "image_id", "container_id", "restart_policy"}

let's use the kubernetes specific labels

@mrueg nice i fixed
but, container restart policy and pod restart policy label names are different
https://github.com/kubernetes/kube-state-metrics/blob/main/internal/store/pod.go#L1191C11-L1191C11

yes, that one is in a separate metric, I think if this is in an Info metric it's too generic to call it type.

@mrueg
I understand. From that perspective, restart_policy would be better.

modify label key

mrueg · 2023-12-18T10:58:28Z

docs/pod-metrics.md

@@ -36,7 +36,7 @@
 | kube_pod_created                                      | Gauge       | Unix creation timestamp                                                                                                                                                             | seconds                                        | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                                                          | STABLE       | -      |
 | kube_pod_deletion_timestamp                           | Gauge       | Unix deletion timestamp                                                                                                                                                             | seconds                                        | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                                                          | EXPERIMENTAL | -      |
 | kube_pod_restart_policy                               | Gauge       | Describes the restart policy in use by this pod                                                                                                                                     |                                                | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `type`=&lt;Always\|Never\|OnFailure&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                             | STABLE       | -      |
-| kube_pod_init_container_info                          | Gauge       | Information about an init container in a pod                                                                                                                                        |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `image`=&lt;image-name&gt; <br> `image_id`=&lt;image-id&gt; <br> `image_spec`=&lt;image-spec&gt; <br> `container_id`=&lt;containerid&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                    | STABLE       | -      |
+| kube_pod_init_container_info                          | Gauge       | Information about an init container in a pod                                                                                                                                        |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `image`=&lt;image-name&gt; <br> `image_id`=&lt;image-id&gt; <br> `image_spec`=&lt;image-spec&gt; <br> `container_id`=&lt;containerid&gt; <br> `uid`=&lt;pod-uid&gt; <br> `type`=&lt;Always&gt;                                                                                    | STABLE       | -      |


Suggested change

| kube_pod_init_container_info | Gauge | Information about an init container in a pod | | `container`=<container-name> `pod`=<pod-name> `namespace`=<pod-namespace> `image`=<image-name> `image_id`=<image-id> `image_spec`=<image-spec> `container_id`=<containerid> `uid`=<pod-uid> `type`=<Always> | STABLE | - |

| kube_pod_init_container_info | Gauge | Information about an init container in a pod | | `container`=<container-name> `pod`=<pod-name> `namespace`=<pod-namespace> `image`=<image-name> `image_id`=<image-id> `image_spec`=<image-spec> `container_id`=<containerid> `uid`=<pod-uid> `type`=<restart-policy> | STABLE | - |

One last change.

@mrueg
 `restart_policy`=<Always>
right? i fixed

The Always should be replaced by a placeholder

@mrueg
i fixed

docs/pod-metrics.md

mrueg · 2023-12-19T18:47:22Z

/lgtm

Thanks for your contribution!

k8s-ci-robot · 2023-12-19T18:47:30Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: changhyuni, mrueg

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mrueg]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

pods: update init_cotainer_info metric

fc1831d

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Nov 18, 2023

k8s-ci-robot requested review from logicalhan and rexagod November 18, 2023 16:09

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 18, 2023

changhyuni changed the title ~~Add label init cotainter metric~~ feat: add restartPolicy to kube_pod_init_container_info metric Nov 18, 2023

changhyuni force-pushed the add_label_init_cotainter_metric branch 2 times, most recently from 1c66a95 to 6ed3c50 Compare November 19, 2023 07:21

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 19, 2023

changhyuni force-pushed the add_label_init_cotainter_metric branch 2 times, most recently from bed3463 to 863e023 Compare November 19, 2023 07:23

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 19, 2023

changhyuni closed this Nov 19, 2023

changhyuni reopened this Dec 13, 2023

changhyuni force-pushed the add_label_init_cotainter_metric branch from 863e023 to 4769203 Compare December 14, 2023 13:49

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 14, 2023

pods: update init_cotainer_info metric

ed1a7f9

changhyuni force-pushed the add_label_init_cotainter_metric branch from 4769203 to ed1a7f9 Compare December 14, 2023 13:51

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 14, 2023

mrueg reviewed Dec 14, 2023

View reviewed changes

modify labels key

b948807

modify label key

changhyuni force-pushed the add_label_init_cotainter_metric branch from 16e83bb to b948807 Compare December 15, 2023 00:18

changhyuni requested a review from mrueg December 16, 2023 06:55

mrueg reviewed Dec 18, 2023

View reviewed changes

modify docs

091ddf9

changhyuni requested a review from mrueg December 18, 2023 12:35

modify docs, restart policy

f94716a

mrueg reviewed Dec 19, 2023

View reviewed changes

docs/pod-metrics.md Outdated Show resolved Hide resolved

fix: Update docs/pod-metrics.md

5834d64

k8s-ci-robot assigned mrueg Dec 19, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 19, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 19, 2023

k8s-ci-robot merged commit fde27ec into kubernetes:main Dec 19, 2023
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add restartPolicy to `kube_pod_init_container_info` metric #2240

feat: add restartPolicy to `kube_pod_init_container_info` metric #2240

changhyuni commented Nov 18, 2023 •

edited

k8s-ci-robot commented Nov 18, 2023

mrueg commented Dec 12, 2023

changhyuni commented Dec 13, 2023 •

edited

mrueg Dec 14, 2023

changhyuni Dec 15, 2023 •

edited

mrueg Dec 18, 2023

changhyuni Dec 18, 2023

mrueg Dec 18, 2023

changhyuni Dec 18, 2023 •

edited

mrueg Dec 18, 2023

changhyuni Dec 19, 2023

mrueg commented Dec 19, 2023

k8s-ci-robot commented Dec 19, 2023

	labelKeys := []string{"container", "image_spec", "image", "image_id", "container_id", "type"}
	labelKeys := []string{"container", "image_spec", "image", "image_id", "container_id", "restart_policy"}

	\| kube_pod_init_container_info \| Gauge \| Information about an init container in a pod \| \| `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `image`=<image-name> <br> `image_id`=<image-id> <br> `image_spec`=<image-spec> <br> `container_id`=<containerid> <br> `uid`=<pod-uid> <br> `type`=<Always> \| STABLE \| - \|
	\| kube_pod_init_container_info \| Gauge \| Information about an init container in a pod \| \| `container`=<container-name> <br> `pod`=<pod-name> <br> `namespace`=<pod-namespace> <br> `image`=<image-name> <br> `image_id`=<image-id> <br> `image_spec`=<image-spec> <br> `container_id`=<containerid> <br> `uid`=<pod-uid> <br> `type`=<restart-policy> \| STABLE \| - \|

feat: add restartPolicy to kube_pod_init_container_info metric #2240

feat: add restartPolicy to kube_pod_init_container_info metric #2240

Conversation

changhyuni commented Nov 18, 2023 • edited

k8s-ci-robot commented Nov 18, 2023

mrueg commented Dec 12, 2023

changhyuni commented Dec 13, 2023 • edited

mrueg Dec 14, 2023

Choose a reason for hiding this comment

changhyuni Dec 15, 2023 • edited

Choose a reason for hiding this comment

mrueg Dec 18, 2023

Choose a reason for hiding this comment

changhyuni Dec 18, 2023

Choose a reason for hiding this comment

mrueg Dec 18, 2023

Choose a reason for hiding this comment

changhyuni Dec 18, 2023 • edited

Choose a reason for hiding this comment

mrueg Dec 18, 2023

Choose a reason for hiding this comment

changhyuni Dec 19, 2023

Choose a reason for hiding this comment

mrueg commented Dec 19, 2023

k8s-ci-robot commented Dec 19, 2023

feat: add restartPolicy to `kube_pod_init_container_info` metric #2240

feat: add restartPolicy to `kube_pod_init_container_info` metric #2240

changhyuni commented Nov 18, 2023 •

edited

changhyuni commented Dec 13, 2023 •

edited

changhyuni Dec 15, 2023 •

edited

changhyuni Dec 18, 2023 •

edited