Add tests for Prometheus metrics endpoint and validation #4185

0xaravindh · 2025-05-22T09:18:21Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug

/kind cleanup

/kind documentation
/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it:

Added tests for Prometheus exporter registration and metrics endpoint exposure
Verified all expected metrics are served via /metrics endpoint
Included Stackdriver-only setup test to ensure no panics

Which issue(s) this PR fixes:

Closes #3925

Special notes for your reviewer:

… metrics setup - Added tests for Prometheus exporter registration and metrics endpoint exposure - Verified all expected metrics are served via /metrics endpoint - Included Stackdriver-only setup test to ensure no panics

agones-bot · 2025-05-22T10:11:54Z

Build Succeeded 🥳

Build Id: 9386d087-612a-404f-8994-fcf316d51dda

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.50.0-dev-67da16b
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.50.0-dev-67da16b
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.50.0-dev-67da16b-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.50.0-dev-67da16b
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.50.0-dev-67da16b
Linux C++ SDK (build): agonessdk-1.50.0-dev-67da16b-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.50.0-dev-67da16b.zip

A preview of the website (the last 30 builds are retained):

https://67da16b-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4185/head:pr_4185 && git checkout pr_4185
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.50.0-dev-67da16b

agones-bot · 2025-06-02T22:50:26Z

Build Succeeded 🥳

Build Id: 23068501-53f6-4639-b3c6-97f7f58947be

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.50.0-dev-d097ea8
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.50.0-dev-d097ea8
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.50.0-dev-d097ea8-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.50.0-dev-d097ea8
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.50.0-dev-d097ea8
Linux C++ SDK (build): agonessdk-1.50.0-dev-d097ea8-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.50.0-dev-d097ea8.zip

A preview of the website (the last 30 builds are retained):

https://d097ea8-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4185/head:pr_4185 && git checkout pr_4185
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.50.0-dev-d097ea8

igooch

Looks like this test isn't including the agones_gameserver_allocations_duration_seconds or agones_gameserver_allocations_retry_total. @vicentefb could you confirm which metrics are expected at the allocator endpoint?

Try adding some debug statements (or just use your debugger) to see what metrics the test is testing for:

	metricsSet := collectMetricNames(resp)
	fmt.Println("GOT", metricsSet)
	expectedMetrics := getMetricNames()
	fmt.Println("EXPECTED", expectedMetrics)
	// Force test to fail so that the above fmt.Println actually prints.
	assert.True(t, false)

igooch · 2025-06-02T22:07:40Z

pkg/metrics/exporter_test.go

+
+}
+
+func TestSetupMetrics_StackdriverOnly_NoPanic(t *testing.T) {


Stackdriver has been deprecated in favor of Google Cloud Monitoring.

As part of a separate issue we should investigate if these configs are still working as intended, or if they need to be updated.

vicentefb · 2025-06-04T16:19:33Z

Looks like this test isn't including the agones_gameserver_allocations_duration_seconds or agones_gameserver_allocations_retry_total. @vicentefb could you confirm which metrics are expected at the allocator endpoint?

Try adding some debug statements (or just use your debugger) to see what metrics the test is testing for:
	metricsSet := collectMetricNames(resp)
	fmt.Println("GOT", metricsSet)
	expectedMetrics := getMetricNames()
	fmt.Println("EXPECTED", expectedMetrics)
	// Force test to fail so that the above fmt.Println actually prints.
	assert.True(t, false)

Yeah, those two metrics are also expected at the allocator endpoint as well as metrics listed here: https://agones.dev/site/docs/guides/metrics/

0xaravindh · 2025-06-13T07:43:24Z

pkg/gameserverallocations/metrics_test.go

@@ -117,3 +135,131 @@ func TestSetResponse(t *testing.T) {
 		})
 	}
 }
+
+func TestAllocationMetrics(t *testing.T) {


@igooch @vicentefb I’ve added a separate test case for these metrics: agones_gameserver_allocations_duration_seconds, agones_gameserver_allocations_retry_total, and agones_gameserver_creation_duration. This should fix the issue with missing metrics in the tests. PR is now ready for review.

agones-bot · 2025-06-13T09:13:19Z

Build Succeeded 🥳

Build Id: 39b31441-5c49-41f8-9952-7da7117eefa8

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.50.0-dev-cbf1045
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.50.0-dev-cbf1045
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.50.0-dev-cbf1045-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.50.0-dev-cbf1045
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.50.0-dev-cbf1045
Linux C++ SDK (build): agonessdk-1.50.0-dev-cbf1045-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.50.0-dev-cbf1045.zip

A preview of the website (the last 30 builds are retained):

https://cbf1045-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4185/head:pr_4185 && git checkout pr_4185
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.50.0-dev-cbf1045

agones-bot · 2025-06-13T16:15:37Z

Build Failed 😭

Build Id: 1034ca0f-312c-4550-8da4-0c52d51d32c0

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

0xaravindh · 2025-06-13T17:27:27Z

/gcbrun

agones-bot · 2025-06-13T18:24:18Z

Build Succeeded 🥳

Build Id: bce52699-46ed-4e2f-825c-d93dc931153f

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.50.0-dev-2acecd1
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.50.0-dev-2acecd1
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.50.0-dev-2acecd1-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.50.0-dev-2acecd1
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.50.0-dev-2acecd1
Linux C++ SDK (build): agonessdk-1.50.0-dev-2acecd1-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.50.0-dev-2acecd1.zip

A preview of the website (the last 30 builds are retained):

https://2acecd1-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4185/head:pr_4185 && git checkout pr_4185
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.50.0-dev-2acecd1

agones-bot · 2025-06-20T07:50:44Z

Build Succeeded 🥳

Build Id: 135458f3-06d2-482b-b080-45996e261032

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.51.0-dev-837d684
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.51.0-dev-837d684
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.51.0-dev-837d684-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.51.0-dev-837d684
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.51.0-dev-837d684
Linux C++ SDK (build): agonessdk-1.51.0-dev-837d684-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.51.0-dev-837d684.zip

A preview of the website (the last 30 builds are retained):

https://837d684-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4185/head:pr_4185 && git checkout pr_4185
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.51.0-dev-837d684

vicentefb

lgtm

0xaravindh requested review from gongmax, igooch and vicentefb May 22, 2025 09:18

0xaravindh self-assigned this May 22, 2025

github-actions bot added the kind/cleanup Refactoring code, fixing up documentation, etc label May 22, 2025

Merge branch 'main' into test/metrics

d097ea8

github-actions bot added the size/M label Jun 2, 2025

igooch reviewed Jun 2, 2025

View reviewed changes

0xaravindh added 2 commits June 13, 2025 07:36

Merge branch 'googleforgames:main' into test/metrics

781bd7e

add allocation metrics endpoint test

cbf1045

github-actions bot added the size/L label Jun 13, 2025

0xaravindh commented Jun 13, 2025

View reviewed changes

Merge branch 'main' into test/metrics

2acecd1

Merge branch 'main' into test/metrics

837d684

vicentefb approved these changes Jun 20, 2025

View reviewed changes

0xaravindh merged commit 86e8fa8 into googleforgames:main Jun 23, 2025
4 checks passed

markmandel mentioned this pull request Jun 30, 2025

Test: TestSetupMetrics_StackdriverOnly_NoPanic fails when running locally #4212

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add tests for Prometheus metrics endpoint and validation #4185

Add tests for Prometheus metrics endpoint and validation #4185

Uh oh!

0xaravindh commented May 22, 2025

Uh oh!

agones-bot commented May 22, 2025

Uh oh!

agones-bot commented Jun 2, 2025

Uh oh!

igooch left a comment

Uh oh!

igooch Jun 2, 2025

Uh oh!

vicentefb commented Jun 4, 2025

Uh oh!

0xaravindh Jun 13, 2025

Uh oh!

agones-bot commented Jun 13, 2025

Uh oh!

agones-bot commented Jun 13, 2025

Uh oh!

0xaravindh commented Jun 13, 2025

Uh oh!

agones-bot commented Jun 13, 2025

Uh oh!

agones-bot commented Jun 20, 2025

Uh oh!

vicentefb left a comment

Uh oh!

Uh oh!

Uh oh!


		}

		func TestSetupMetrics_StackdriverOnly_NoPanic(t *testing.T) {

Add tests for Prometheus metrics endpoint and validation #4185

Add tests for Prometheus metrics endpoint and validation #4185

Uh oh!

Conversation

0xaravindh commented May 22, 2025

Uh oh!

agones-bot commented May 22, 2025

Uh oh!

agones-bot commented Jun 2, 2025

Uh oh!

igooch left a comment

Choose a reason for hiding this comment

Uh oh!

igooch Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

vicentefb commented Jun 4, 2025

Uh oh!

0xaravindh Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

agones-bot commented Jun 13, 2025

Uh oh!

agones-bot commented Jun 13, 2025

Uh oh!

0xaravindh commented Jun 13, 2025

Uh oh!

agones-bot commented Jun 13, 2025

Uh oh!

agones-bot commented Jun 20, 2025

Uh oh!

vicentefb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!