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.

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

feat: Add new hpa metrics to prevent prometheus timeseries duplication #2614

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

Conversation

CountryTk
Copy link

@CountryTk CountryTk commented Feb 19, 2025

What this PR does / why we need it:

Added 4 new hpa metrics to prevent duplicated timeseries events like described in this issue: #2403

Added new metrics are:

  • kube_horizontalpodautoscaler_spec_target_container_metric
  • kube_horizontalpodautoscaler_spec_target_object_metric
  • kube_horizontalpodautoscaler_status_target_container_metric
  • kube_horizontalpodautoscaler_status_target_object_metric

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
Cardinality is increased because of new metrics

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

FYI: I've also tested this change in our prelive cluster and for us it fixed the issue

Copy link

linux-foundation-easycla bot commented Feb 19, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: CountryTk
Once this PR has been reviewed and has the lgtm label, please assign rexagod for approval. For more information see the 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:

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Feb 19, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @CountryTk!

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. 😃

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 19, 2025
@richabanker
Copy link
Contributor

/triage accepted
@CatherineF-dev @rexagod could you take a look here if possible, thanks!

@k8s-ci-robot 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 Feb 20, 2025
@CountryTk
Copy link
Author

Hey, could this please be reviewed @CatherineF-dev @rexagod

@CatherineF-dev
Copy link
Contributor

Ok! In reviewing

targetMetricLabels = []string{"metric_name", "metric_target_type"}
targetMetricLabels = []string{"metric_name", "metric_target_type"}
containerMetricLabels = []string{"metric_name", "metric_target_type", "container"}
objectMetricLabels = []string{"metric_name", "metric_target_type", "full_target_name"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: full_target_name -> target_name, container -> container_name

)
}

func createHPASpecTargetMetric() generator.FamilyGenerator {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Unify createHPASpecTargetMetric and createHPASpecTargetObjectMetric. These two functions have some similar codes.

For example

  • createHPASpecTargetMetric(CollectContainerResourceMetricSourceType=false)
  • createHPASpecTargetMetric(CollectContainerResourceMetricSourceType=true)

@CatherineF-dev
Copy link
Contributor

Overall LGTM. Two small comments.

@CountryTk
Copy link
Author

CountryTk commented Mar 4, 2025

Overall LGTM. Two small comments.

Thanks for the review, I've implemented your suggestions @CatherineF-dev

@CountryTk CountryTk requested a review from CatherineF-dev March 4, 2025 13:23
createHPASpecTargetContainerMetric(),
createHPAStatusTargetContainerMetric(),
createHPAStatusTargetObjectMetric(),
createHPASpecTargetMetric(true),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit:
createHPASpecTargetObjectMetric()
createHPASpecTargetMetric()

func createHPASpecTargetObjectMetric() {
createHPASpecTarget([]{autoscaling.ObjectMetricSourceType})
}

func createHPASpecTargetMetric() {
createHPASpecTarget([]{autoscaling.PodsMetricSourceType, autoscaling.ResourceMetricSourceType, ...})
}

func createHPASpecTarget(autoscalingTypes) {
if m.Type not in autoscalingTypes {
return
}
}

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made some adjustments according to how I understood this comment, not 100% sure if I did it as you wish though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants