docs: updated VPA CustomResourceStateMetrics docs #2193

sherifkayad · 2023-09-13T07:19:43Z

What this PR does / why we need it:
docs PR to address #2041

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
N.A. .. Just a docs PR

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 #2041

k8s-ci-robot · 2023-09-13T07:19:51Z

Welcome @sherifkayad!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

docs/customresourcestate-metrics.md

chihshenghuang · 2023-09-14T19:03:59Z

docs/customresourcestate-metrics.md

@@ -272,19 +267,51 @@ spec:
        target_kind: [spec, targetRef, kind]
        target_name: [spec, targetRef, name]
      metrics:
-        - name: "annotations"
-          help: "Kubernetes annotations converted to Prometheus labels."
+        - name: "vpa_containerrecommendations_target"


Suggest to follow the previous VPA metrics naming format "verticalpodautoscaler_status_recommendation_containerrecommendations_target_cpu". Append resource (cpu/memory) at the end of metrics name due to this is changed to be customized metrics name, we can't have duplicate metrics name at line 270 and line 282 which both are "vpa_containerrecommendations_target".

@chihshenghuang I slightly disagree due to two reasons:

The name of the metric will be super long as there is already a prefix appended automatically by the custom resource (check the doc further for the full name)

The previous implemention had already the same metric with different labels / selectors for CPU / Memory and I think that to make it close to the original implementation (prior to v2.9.0), it should be like that.

Remember this is just an example and people can freely choose what to do / how to name the metric. I can suggest adding a line or two in the docs that this is also possible of course.

using the same metric name both for cpu and memory will result in two HELP messages for the same type (ie # HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for memory and # HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for cpu). As a result, client (for example telegraf) fails to fetch metrics with Error in plugin: error reading metrics for http://kube-state-metrics.kube-system.svc.cluster.local:8080/metrics: reading text format failed: text format parsing error in line 11485: second HELP line for metric name "kube_customresource_vpa_containerrecommendations_target".

So +1 for appending resource at the end (ie - name: "vpa_containerrecommendations_target_cpu").
And if we do this, probably commonLabels can be removed

dashpole · 2023-09-21T16:56:59Z

/assign @dgrisonnet
/triage accepted

k8s-ci-robot · 2023-09-21T20:13:24Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sherifkayad
Once this PR has been reviewed and has the lgtm label, please ask for approval from dgrisonnet. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

sherifkayad · 2023-09-21T20:14:05Z

Fixed MD linting issues

/test all

k8s-ci-robot · 2023-09-21T20:14:20Z

@sherifkayad: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

Fixed MD linting issues

/test all

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.

sherifkayad · 2023-09-25T12:19:00Z

@dashpole @dgrisonnet can you please re-trigger the testing pipeline again?

CatherineF-dev · 2023-09-25T12:37:18Z

/ok-to-test

docs/customresourcestate-metrics.md

Signed-off-by: Sherif Ayad <sherif.k.ayad@gmail.com>

k0nstantinv

looks ok now

docs/customresourcestate-metrics.md

sherifkayad · 2023-11-01T10:10:42Z

looks ok now

Can you please re-trigger the tests?

k0nstantinv · 2023-11-01T10:21:17Z

looks ok now

Can you please re-trigger the tests?

I’m not sure I’m able to do that :)

k0nstantinv · 2023-11-07T07:59:41Z

@CatherineF-dev seems like we need re-trigger tests again, the doc was updated

CatherineF-dev · 2023-11-21T03:38:31Z

/ok-to-test

korjek · 2023-11-28T09:48:26Z

guys, let's move on to have this merged! This would save so much time for me (was lucky enough to bump into this PR after spending some time trying to figure out the correct config) and maybe for other folks when it's merged.

sherifkayad · 2023-11-28T09:57:56Z

Would be really good to get this one merged soon

mrueg · 2023-11-28T16:35:53Z

docs/customresourcestate-metrics.md

+The above configuration was tested on [this](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/examples/hamster.yaml) VPA configuration, outputting the following metrics:
+
+```
+# HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for memory.


As you can see here, this will generate two different help outputs for the same title. This should either be postfixed with _cpu / _memory (if you want two help outputs) or

Suggested change

# HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for memory.

# HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for CPU and memory.

mrueg · 2023-11-28T17:23:10Z

docs/customresourcestate-metrics.md

+- verbs:
+    - list
+    - watch
+  apiGroups:


Usually permissions are set per apigroup/resource Otherwise you would give permission to an (unlikely, but possible) customresourcedefinitions.autoscaling.k8s.io or verticalpodautoscalers.apiextensions.k8s.io which you did not intend to provide.

korjek · 2023-11-29T06:44:58Z

docs/customresourcestate-metrics.md

@@ -272,19 +267,51 @@ spec:
        target_kind: [spec, targetRef, kind]
        target_name: [spec, targetRef, name]
      metrics:
-        - name: "annotations"
-          help: "Kubernetes annotations converted to Prometheus labels."
+        - name: "vpa_containerrecommendations_target"


using the same metric name both for cpu and memory will result in two HELP messages for the same type (ie # HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for memory and # HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for cpu). As a result, client (for example telegraf) fails to fetch metrics with Error in plugin: error reading metrics for http://kube-state-metrics.kube-system.svc.cluster.local:8080/metrics: reading text format failed: text format parsing error in line 11485: second HELP line for metric name "kube_customresource_vpa_containerrecommendations_target".

So +1 for appending resource at the end (ie - name: "vpa_containerrecommendations_target_cpu").
And if we do this, probably commonLabels can be removed

korjek · 2023-11-29T06:45:40Z

docs/customresourcestate-metrics.md

+The above configuration was tested on [this](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/examples/hamster.yaml) VPA configuration, outputting the following metrics:
+
+```
+# HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for memory.


# TYPE kube_customresource_vpa_containerrecommendations_target gauge
line is missing in the output

k8s-triage-robot · 2024-02-27T06:58:27Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

sherifkayad · 2024-02-27T07:18:18Z

I am not really sure what needs to be done to merge this one. Has been open for a very long time and I would love to see it closed.

korjek · 2024-03-06T11:37:04Z

indeed would be great to have this merged, so it's much easier to find correct documentation

k8s-triage-robot · 2024-05-05T00:09:22Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2024-06-04T00:37:28Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2024-06-04T00:37:33Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

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-sigs/prow repository.

korjek · 2024-06-04T05:45:49Z

/reopen

k8s-ci-robot · 2024-06-04T05:45:53Z

@korjek: You can't reopen an issue/PR unless you authored it or you are a collaborator.

In response to this:

/reopen

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-sigs/prow repository.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 13, 2023

k8s-ci-robot requested review from CatherineF-dev and logicalhan September 13, 2023 07:19

k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Sep 13, 2023

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 13, 2023

drisbee reviewed Sep 14, 2023

View reviewed changes

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

sherifkayad force-pushed the docs-for-vpa-custom-resource branch 2 times, most recently from 6bdf818 to f34ba86 Compare September 14, 2023 07:34

chihshenghuang reviewed Sep 14, 2023

View reviewed changes

k8s-ci-robot assigned dgrisonnet Sep 21, 2023

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 21, 2023

sherifkayad force-pushed the docs-for-vpa-custom-resource branch from f34ba86 to 9fb3bae Compare September 21, 2023 20:13

k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Sep 25, 2023

k0nstantinv reviewed Oct 30, 2023

View reviewed changes

docs/customresourcestate-metrics.md Show resolved Hide resolved

docs: updated VPA CustomResourceStateMetrics docs

14a4ad7

Signed-off-by: Sherif Ayad <sherif.k.ayad@gmail.com>

sherifkayad force-pushed the docs-for-vpa-custom-resource branch from 9fb3bae to 14a4ad7 Compare November 1, 2023 09:04

k0nstantinv reviewed Nov 1, 2023

View reviewed changes

docs/customresourcestate-metrics.md Show resolved Hide resolved

korjek mentioned this pull request Nov 28, 2023

repeated adding and deleting CustomResourceDefinitions causes duplicate metric entries #2223

Open

mrueg reviewed Nov 28, 2023

View reviewed changes

korjek reviewed Nov 29, 2023

View reviewed changes

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 27, 2024

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 4, 2024

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 5, 2024

k8s-ci-robot closed this Jun 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: updated VPA CustomResourceStateMetrics docs #2193

docs: updated VPA CustomResourceStateMetrics docs #2193

sherifkayad commented Sep 13, 2023

k8s-ci-robot commented Sep 13, 2023

chihshenghuang Sep 14, 2023

sherifkayad Sep 14, 2023

korjek Nov 29, 2023

dashpole commented Sep 21, 2023

k8s-ci-robot commented Sep 21, 2023

sherifkayad commented Sep 21, 2023

k8s-ci-robot commented Sep 21, 2023

sherifkayad commented Sep 25, 2023

CatherineF-dev commented Sep 25, 2023

k0nstantinv left a comment

sherifkayad commented Nov 1, 2023

k0nstantinv commented Nov 1, 2023

k0nstantinv commented Nov 7, 2023

CatherineF-dev commented Nov 21, 2023

korjek commented Nov 28, 2023 •

edited

sherifkayad commented Nov 28, 2023

mrueg Nov 28, 2023

mrueg Nov 28, 2023

korjek Nov 29, 2023

korjek Nov 29, 2023 •

edited

k8s-triage-robot commented Feb 27, 2024

sherifkayad commented Feb 27, 2024

korjek commented Mar 6, 2024

k8s-triage-robot commented May 5, 2024

k8s-triage-robot commented Jun 4, 2024

k8s-ci-robot commented Jun 4, 2024

korjek commented Jun 4, 2024

k8s-ci-robot commented Jun 4, 2024

	# HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for memory.
	# HELP kube_customresource_vpa_containerrecommendations_target VPA container recommendations for CPU and memory.

docs: updated VPA CustomResourceStateMetrics docs #2193

docs: updated VPA CustomResourceStateMetrics docs #2193

Conversation

sherifkayad commented Sep 13, 2023

k8s-ci-robot commented Sep 13, 2023

chihshenghuang Sep 14, 2023

Choose a reason for hiding this comment

sherifkayad Sep 14, 2023

Choose a reason for hiding this comment

korjek Nov 29, 2023

Choose a reason for hiding this comment

dashpole commented Sep 21, 2023

k8s-ci-robot commented Sep 21, 2023

sherifkayad commented Sep 21, 2023

k8s-ci-robot commented Sep 21, 2023

sherifkayad commented Sep 25, 2023

CatherineF-dev commented Sep 25, 2023

k0nstantinv left a comment

Choose a reason for hiding this comment

sherifkayad commented Nov 1, 2023

k0nstantinv commented Nov 1, 2023

k0nstantinv commented Nov 7, 2023

CatherineF-dev commented Nov 21, 2023

korjek commented Nov 28, 2023 • edited

sherifkayad commented Nov 28, 2023

mrueg Nov 28, 2023

Choose a reason for hiding this comment

mrueg Nov 28, 2023

Choose a reason for hiding this comment

korjek Nov 29, 2023

Choose a reason for hiding this comment

korjek Nov 29, 2023 • edited

Choose a reason for hiding this comment

k8s-triage-robot commented Feb 27, 2024

sherifkayad commented Feb 27, 2024

korjek commented Mar 6, 2024

k8s-triage-robot commented May 5, 2024

k8s-triage-robot commented Jun 4, 2024

k8s-ci-robot commented Jun 4, 2024

korjek commented Jun 4, 2024

k8s-ci-robot commented Jun 4, 2024

korjek commented Nov 28, 2023 •

edited

korjek Nov 29, 2023 •

edited