feat: enable customresource metrics by configuration #1710

iamnoah · 2022-03-23T03:24:46Z

What this PR does / why we need it:

Building off of the new customresource.RegistryFactory (thanks @Garrybest !), I found myself making a list of metrics I wanted on my custom resources and thought it made more sense to drive collection of those metrics from a config file than having to write pretty similar code for each one.

I've put together some examples in the .md file, and the tests cover most of the ins and outs.

This is a pretty early rough draft that suits my needs, but I thought I would put it out there for feedback and see if it's useful.

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)

Users may add unlimited custom metrics, but the default cardinality remains unchanged.

k8s-ci-robot · 2022-03-23T03:24:54Z

Welcome @iamnoah!

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

Garrybest · 2022-03-23T10:58:33Z

Thanks @iamnoah, it is a really good practice!

mrueg

Overall looks really interesting. Thanks for the contribution!

main.go

docs/customresourcestate-metrics.md

iamnoah · 2022-04-04T23:54:07Z

Is that linter error related to my changes in some way?

fpetkovski · 2022-04-05T07:25:16Z

I think it's an issue in golangci-lint: golangci/golangci-lint#2374. Seems to be happening with go 1.18. I can take a look today to see if we can get it quickly resolved.

fpetkovski · 2022-04-05T10:41:16Z

This PR should fix the CI issue: #1713

fpetkovski · 2022-04-05T12:22:14Z

The CI should be fixed with #1713. Can you rebase your branch against main?

docs/customresourcestate-metrics.md

go.mod

fpetkovski

I think this would be a great addition to KSM 👍

pkg/customresourcestate/registry_factory.go

fpetkovski

Other than one last nit, I'm okay with merging this as it is. I think we should just announce it as an experimental feature in the changelog and keep an eye on incoming feedback.

@mrueg or @dgrisonnet any thoughts?

pkg/customresourcestate/registry_factory.go

main.go

mrueg · 2022-05-30T07:45:35Z

@iamnoah we're planning for a next release in the upcoming days, are you interested in getting your contribution into that one? If you want to get it in please rebase on latest master and help with the linting/unit tests.

The main use case is just surfacing fields from custom resources without having to write a lot of code for each one.

docs/README.md

docs/customresourcestate-metrics.md

pkg/options/options.go

Co-authored-by: Manuel Rüger <[email protected]>

is there a tool for this?

Co-authored-by: Manuel Rüger <[email protected]>

fpetkovski · 2022-06-02T09:46:52Z

/lgtm
/hold

mrueg · 2022-06-02T09:56:53Z

/lgtm
/hold cancel

k8s-ci-robot · 2022-06-02T09:57:11Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fpetkovski, iamnoah, 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~~ [fpetkovski,mrueg]

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

mrueg · 2022-06-02T09:57:27Z

Thanks for your contribution @iamnoah !

… strings in arguments The newly introduced `--custom-resource-state-config` argument (kubernetes/kube-state-metrics#1710) accepts a multi-line string as value. The deployment.yaml template currently loops over each .Values.extraArgs, which causes indentation issues when passing a multi-line string. This PR fixes that by rendering .Values.extraArgs as YAML with proper indentation. Signed-off-by: Mitch Hulscher <[email protected]>

… strings in arguments (#2167) The newly introduced `--custom-resource-state-config` argument (kubernetes/kube-state-metrics#1710) accepts a multi-line string as value. The deployment.yaml template currently loops over each .Values.extraArgs, which causes indentation issues when passing a multi-line string. This PR fixes that by rendering .Values.extraArgs as YAML with proper indentation. Signed-off-by: Mitch Hulscher <[email protected]>

… strings in arguments (prometheus-community#2167) The newly introduced `--custom-resource-state-config` argument (kubernetes/kube-state-metrics#1710) accepts a multi-line string as value. The deployment.yaml template currently loops over each .Values.extraArgs, which causes indentation issues when passing a multi-line string. This PR fixes that by rendering .Values.extraArgs as YAML with proper indentation. Signed-off-by: Mitch Hulscher <[email protected]>

… strings in arguments (#2167) The newly introduced `--custom-resource-state-config` argument (kubernetes/kube-state-metrics#1710) accepts a multi-line string as value. The deployment.yaml template currently loops over each .Values.extraArgs, which causes indentation issues when passing a multi-line string. This PR fixes that by rendering .Values.extraArgs as YAML with proper indentation. Signed-off-by: Mitch Hulscher <[email protected]>

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 23, 2022

k8s-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 23, 2022

k8s-ci-robot requested review from brancz and dgrisonnet March 23, 2022 03:25

mrueg reviewed Mar 23, 2022

View reviewed changes

main.go Outdated Show resolved Hide resolved

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

iamnoah force-pushed the master branch 2 times, most recently from 576fa12 to dc6f869 Compare April 5, 2022 17:42

fpetkovski reviewed Apr 8, 2022

View reviewed changes

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

go.mod Outdated Show resolved Hide resolved

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

iamnoah force-pushed the master branch 2 times, most recently from dadea8e to be1ab05 Compare May 6, 2022 04:01

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 6, 2022

fpetkovski reviewed May 10, 2022

View reviewed changes

pkg/customresourcestate/registry_factory.go Show resolved Hide resolved

pkg/customresourcestate/registry_factory.go Show resolved Hide resolved

fpetkovski reviewed May 11, 2022

View reviewed changes

pkg/customresourcestate/registry_factory.go Outdated Show resolved Hide resolved

mrueg reviewed May 13, 2022

View reviewed changes

main.go Show resolved Hide resolved

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

feat: enable customresource metrics by configuration

e0e4f14

The main use case is just surfacing fields from custom resources without having to write a lot of code for each one.

iamnoah force-pushed the master branch from b091eeb to e0e4f14 Compare May 31, 2022 19:25

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 31, 2022

chore: goimports

ea79557

mrueg reviewed May 31, 2022

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

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

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

iamnoah added 2 commits May 31, 2022 16:11

fix: use a flag for the configuration file

4b704fd

doc: note CR support is experimental

8c5d979

mrueg approved these changes Jun 1, 2022

View reviewed changes

pkg/options/options.go Outdated Show resolved Hide resolved

pkg/options/options.go Outdated Show resolved Hide resolved

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 1, 2022

iamnoah and others added 5 commits June 1, 2022 10:11

note experimental status

6ec0332

Co-authored-by: Manuel Rüger <[email protected]>

chore: docs formatting

2b77ed6

is there a tool for this?

fix: inconsistent test result by sorting

fdd0931

another exp note

99d86bb

Co-authored-by: Manuel Rüger <[email protected]>

docs: update arg

e7725f9

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 2, 2022

k8s-ci-robot assigned fpetkovski Jun 2, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2022

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 2, 2022

k8s-ci-robot assigned mrueg Jun 2, 2022

k8s-ci-robot merged commit 1e78285 into kubernetes:master Jun 2, 2022

mrueg mentioned this pull request Jun 2, 2022

*: Cut 2.5.0 release #1746

Merged

This was referenced Jun 8, 2022

Adjust Custom Resource configuration to support open metric types StateSet and Info #1755

Closed

Custom resource metrics kubernetes-sigs/kubebuilder#2286

Closed

mhulscher mentioned this pull request Jun 17, 2022

[kube-state-metrics] render extraArgs as YAML to allow multi-line string arguments prometheus-community/helm-charts#2167

Merged

3 tasks

mhulscher mentioned this pull request Jun 20, 2022

[kube-prometheus-stack] update kube-state-metrics and grafana to latest patch version prometheus-community/helm-charts#2175

Merged

3 tasks

This was referenced Jun 27, 2022

Cannot read the timestamp field from Custom Resource metadata with the new customresource metrics capability #1765

Closed

Metrics exposure for volcano scheduling start time and end time for each job volcano-sh/volcano#2312

Closed

johannesfrey mentioned this pull request Oct 27, 2022

Project is archived mercedes-benz/cluster-api-state-metrics#34

Open

Garrybest mentioned this pull request Mar 1, 2023

Incompatible changes about custom resource metrics #2013

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enable customresource metrics by configuration #1710

feat: enable customresource metrics by configuration #1710

iamnoah commented Mar 23, 2022

k8s-ci-robot commented Mar 23, 2022

Garrybest commented Mar 23, 2022

mrueg left a comment

iamnoah commented Apr 4, 2022

fpetkovski commented Apr 5, 2022

fpetkovski commented Apr 5, 2022

fpetkovski commented Apr 5, 2022

fpetkovski left a comment

fpetkovski left a comment

mrueg commented May 30, 2022 •

edited

Loading

fpetkovski commented Jun 2, 2022

mrueg commented Jun 2, 2022

k8s-ci-robot commented Jun 2, 2022

mrueg commented Jun 2, 2022

feat: enable customresource metrics by configuration #1710

feat: enable customresource metrics by configuration #1710

Conversation

iamnoah commented Mar 23, 2022

k8s-ci-robot commented Mar 23, 2022

Garrybest commented Mar 23, 2022

mrueg left a comment

Choose a reason for hiding this comment

iamnoah commented Apr 4, 2022

fpetkovski commented Apr 5, 2022

fpetkovski commented Apr 5, 2022

fpetkovski commented Apr 5, 2022

fpetkovski left a comment

Choose a reason for hiding this comment

fpetkovski left a comment

Choose a reason for hiding this comment

mrueg commented May 30, 2022 • edited Loading

fpetkovski commented Jun 2, 2022

mrueg commented Jun 2, 2022

k8s-ci-robot commented Jun 2, 2022

mrueg commented Jun 2, 2022

mrueg commented May 30, 2022 •

edited

Loading