Publish Prometheus metrics about build info #4576

pedro-stanaka · 2023-05-25T21:35:32Z

Summary

I am adding a new metric that I missed while doing my monitoring setup for Keda. This new metric will tell which version of Keda is running in a given Kubernetes cluster. This is really useful when managing multiple clusters to do spot check of which version of Keda is running.

Checklist

When introducing a new scaler, I agree with the scaling governance policy
I have verified that my change is according to the deprecations & breaking changes policy
Tests have been added
Changelog has been updated and is aligned with our changelog requirements
A PR is opened to update our Helm chart (repo) (if applicable, ie. when deployment manifests are modified)
A PR is opened to update the documentation on (repo) (if applicable)
Commits are signed with Developer Certificate of Origin (DCO - learn more)

Fixes #

Relates to #4647

tomkerkhove

LGTM, nice addition - Thanks! Would you mind adding a test for it please, or do we not have tests for metrics yet @JorTurFer?

pedro-stanaka · 2023-06-01T07:26:25Z

I am on the process of adding a test, that is why I left on draft. But running e2e tests on my computer is a PITA. Working on it.

zroubalik

The test can be added here: https://github.com/kedacore/keda/blob/main/tests/sequential/prometheus_metrics/prometheus_metrics_test.go

You can just run a specific test, if you have k8s cluster ready with the KEDA build deployed: https://github.com/kedacore/keda/tree/main/tests#specific-test

pkg/util/build_info.go

pkg/prommetrics/prommetrics.go

pedro-stanaka · 2023-06-01T12:59:23Z

The test can be added here: https://github.com/kedacore/keda/blob/main/tests/sequential/prometheus_metrics/prometheus_metrics_test.go

You can just run a specific test, if you have k8s cluster ready with the KEDA build deployed: https://github.com/kedacore/keda/tree/main/tests#specific-test

Can I change somehow the deploy to use the an image built from my version of the code? Otherwise the test will never pass, since it is running against ghcr.io/kedacore/keda:main

zroubalik · 2023-06-01T13:13:22Z

The test can be added here: https://github.com/kedacore/keda/blob/main/tests/sequential/prometheus_metrics/prometheus_metrics_test.go
You can just run a specific test, if you have k8s cluster ready with the KEDA build deployed: https://github.com/kedacore/keda/tree/main/tests#specific-test

Can I change somehow the deploy to use the an image built from my version of the code? Otherwise the test will never pass, since it is running against ghcr.io/kedacore/keda:main

you can run make publish && make deploy just change the image/registry in the Makefile. These commands will build and deploy KEDA on your cluster. Then just run this test.

https://github.com/kedacore/keda/blob/main/Makefile#L18-L19

zroubalik

I have some additional thoughts :)

cmd/adapter/main.go

pkg/prommetrics/prommetrics.go

pedro-stanaka · 2023-06-01T14:36:37Z

I think I am all set now.

zroubalik

Great job, could you please fix also this. I will, trigger e2e then! 🙏

cmd/adapter/main.go

pkg/prommetrics/prommetrics.go

zroubalik · 2023-06-01T16:01:06Z

/run-e2e sequential
Update: You can check the progress here

pedro-stanaka · 2023-06-01T18:38:10Z

Oh boy, I need to update the assertions.

Signed-off-by: Pedro Tanaka <pedro.tanaka@shopify.com>

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

pedro-stanaka · 2023-06-02T15:25:02Z

Can one of the maintainers enqueue another e2e run? cc @zroubalik @JorTurFer

Thanks!

JorTurFer · 2023-06-02T15:27:47Z

/run-e2e sequential
Update: You can check the progress here

JorTurFer · 2023-06-02T15:29:31Z

Please ignore this:

Sometimes I'm like a monkey...

tomkerkhove · 2023-06-05T09:00:08Z

/run-e2e sequential
Update: You can check the progress here

tomkerkhove · 2023-06-05T10:08:31Z

@JorTurFer Any thoughts why e2e tests is still pending?

zroubalik

We should also document the metric:
https://keda.sh/docs/2.11/operate/prometheus/

CHANGELOG.md

Signed-off-by: Pedro Tanaka <pedro.tanaka@shopify.com>

zroubalik

LGTM

Thanks for your patience with all the rounds of review :)

pedro-stanaka · 2023-06-05T11:54:59Z

We should also document the metric: https://keda.sh/docs/2.11/operate/prometheus/

Docs PR: kedacore/keda-docs#1142

tomkerkhove reviewed Jun 1, 2023

View reviewed changes

pedro-stanaka force-pushed the feat/build-info-metric branch from a99edb9 to d179e5f Compare June 1, 2023 06:42

zroubalik reviewed Jun 1, 2023

View reviewed changes

pkg/util/build_info.go Outdated Show resolved Hide resolved

pedro-stanaka force-pushed the feat/build-info-metric branch from 1d7bf5c to 49af364 Compare June 1, 2023 12:50

zroubalik reviewed Jun 1, 2023

View reviewed changes

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

pedro-stanaka marked this pull request as ready for review June 1, 2023 12:59

pedro-stanaka requested a review from a team as a code owner June 1, 2023 12:59

zroubalik reviewed Jun 1, 2023

View reviewed changes

cmd/adapter/main.go Outdated Show resolved Hide resolved

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

pkg/prommetrics/prommetrics.go Show resolved Hide resolved

zroubalik reviewed Jun 1, 2023

View reviewed changes

cmd/adapter/main.go Outdated Show resolved Hide resolved

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

zroubalik requested a review from JorTurFer June 1, 2023 16:01

pedro-stanaka and others added 11 commits June 2, 2023 17:24

Publish build info metric from all major components

7413399

Signed-off-by: Pedro Tanaka <pedro.tanaka@shopify.com>

Adding test for metric and removing uneeded file

018c21b

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Fixing message in test

e35f117

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Fixing IDE trying to be too Zmart

578cc2e

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Set parameters from inside function in prommetrics package

d7be9af

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Adding changelog

db00bc8

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Apeasing the linter

778b423

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Refactor function name and remove calls from main files

4e4f299

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Fixing test case

e06daba

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Fixing last details and reducing changes

3f3881e

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

Fixing matchers

50ce7c3

Signed-off-by: Pedro Tanaka <pedro.stanaka@gmail.com>

pedro-stanaka force-pushed the feat/build-info-metric branch from a42acbb to 50ce7c3 Compare June 2, 2023 15:24

JorTurFer approved these changes Jun 2, 2023

View reviewed changes

JorTurFer closed this Jun 2, 2023

JorTurFer reopened this Jun 2, 2023

zroubalik approved these changes Jun 2, 2023

View reviewed changes

zroubalik enabled auto-merge (squash) June 2, 2023 15:55

zroubalik reviewed Jun 5, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Fixing changelog to link issue and not PR

e540edf

Signed-off-by: Pedro Tanaka <pedro.tanaka@shopify.com>

auto-merge was automatically disabled June 5, 2023 11:39
Head branch was pushed to by a user without write access

Merge branch 'main' into feat/build-info-metric

52959eb

zroubalik approved these changes Jun 5, 2023

View reviewed changes

zroubalik changed the title ~~Publish build info metric from all major components~~ Publish Prometheus metrics about build info Jun 5, 2023

zroubalik merged commit 3cbba26 into kedacore:main Jun 5, 2023
20 of 21 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Publish Prometheus metrics about build info #4576

Publish Prometheus metrics about build info #4576

pedro-stanaka commented May 25, 2023 •

edited

tomkerkhove left a comment

pedro-stanaka commented Jun 1, 2023

zroubalik left a comment

pedro-stanaka commented Jun 1, 2023

zroubalik commented Jun 1, 2023 •

edited

zroubalik left a comment

pedro-stanaka commented Jun 1, 2023

zroubalik left a comment

zroubalik commented Jun 1, 2023 •

edited by github-actions bot

pedro-stanaka commented Jun 1, 2023

pedro-stanaka commented Jun 2, 2023

JorTurFer commented Jun 2, 2023 •

edited by github-actions bot

JorTurFer commented Jun 2, 2023

tomkerkhove commented Jun 5, 2023 •

edited by github-actions bot

tomkerkhove commented Jun 5, 2023

zroubalik left a comment

zroubalik left a comment

pedro-stanaka commented Jun 5, 2023

Publish Prometheus metrics about build info #4576

Publish Prometheus metrics about build info #4576

Conversation

pedro-stanaka commented May 25, 2023 • edited

Summary

Checklist

tomkerkhove left a comment

Choose a reason for hiding this comment

pedro-stanaka commented Jun 1, 2023

zroubalik left a comment

Choose a reason for hiding this comment

pedro-stanaka commented Jun 1, 2023

zroubalik commented Jun 1, 2023 • edited

zroubalik left a comment

Choose a reason for hiding this comment

pedro-stanaka commented Jun 1, 2023

zroubalik left a comment

Choose a reason for hiding this comment

zroubalik commented Jun 1, 2023 • edited by github-actions bot

pedro-stanaka commented Jun 1, 2023

pedro-stanaka commented Jun 2, 2023

JorTurFer commented Jun 2, 2023 • edited by github-actions bot

JorTurFer commented Jun 2, 2023

tomkerkhove commented Jun 5, 2023 • edited by github-actions bot

tomkerkhove commented Jun 5, 2023

zroubalik left a comment

Choose a reason for hiding this comment

zroubalik left a comment

Choose a reason for hiding this comment

pedro-stanaka commented Jun 5, 2023

pedro-stanaka commented May 25, 2023 •

edited

zroubalik commented Jun 1, 2023 •

edited

zroubalik commented Jun 1, 2023 •

edited by github-actions bot

JorTurFer commented Jun 2, 2023 •

edited by github-actions bot

tomkerkhove commented Jun 5, 2023 •

edited by github-actions bot