chore(metrics): use geth metrics package and delete local metrics #1422

qdm12 · 2025-01-13T13:06:05Z

Why this should be merged

Contribution to the libevm effort.
Note there are the same changes for both coreth and subnet-evm, but they should not be part of libevm since these are extra features specific to subnet-evm/coreth, even if they're the same for both.

How this works

Comparing the following:

subnet-evm master vs coreth master: subnet-evm is missing the extra file https://github.com/ava-labs/coreth/blob/b6b4dfbc4bfc7f17e4cfe5f3c0fb44944176c884/metrics/init_test.go (which is present in geth as well)
subnet-evm master vs geth v1.13.14: subnet-evm has many deletions, very few minor unneeded changes and the new non-conflicting file metrics/prometheus/prometheus.go

Therefore:

file kept and refactored metrics/prometheus/prometheus.go with the Gatherer implementation we use
file kept and refactored metrics/prometheus/prometheus_test.go
new file metrics/prometheus/interfaces.go added for refactoring
geth global variable metrics.Enabled is set to true in plugin/evm.VM.initializeMetrics

Note for the two files refactored (with fixes as well), this was done in some intermediary step in ava-labs/libevm#103, so I decided to bring this over here so it doesn't get trashed.

How this was tested

CI passing

Need to be documented?

No

Need to update RELEASES.md?

Not really, since it should not change anything 🙏

plugin/evm/vm.go

warp/handlers/signature_request_test.go

qdm12 · 2025-01-13T16:05:54Z

metrics/prometheus/prometheus.go

+	default:
+		return nil, fmt.Errorf("metric type is not supported: %T", metric)


I took the liberty to change this to return an error (instead of silently ignoring it) on an unsupported type to prevent in the future to define new types and forget to add the implementation in the switch here.

metrics/prometheus/prometheus.go

metrics/prometheus/prometheus_test.go

metrics/prometheus/prometheus.go

go.mod

warp/handlers/signature_request_test.go

metrics/prometheus/prometheus.go

- Bring over refactoring and fixes done in ava-labs/libevm#103 - Bring over test refactoring done in ava-labs/libevm#103

Signed-off-by: Quentin McGaw <[email protected]>

- add exported comments - rename `g` to `gatherer` in test - Format copyright as it as ™️ - Remove TODO

…in/evm

maru-ava

Looks good! The subnet dashboard is now populated with metrics for the load test e2e job:

A random PR doesn't show any metrics on the subnets dashboard for the same job:

qdm12 · 2025-01-28T12:11:33Z

A random PR doesn't show any metrics on the subnets dashboard for the same job:

Ah, let me check if I can revert it to no-metric, and open another PR (based off this one I suppose) to enable metrics.
Since this PR is not meant to change anything and should be pure maintenance / code movement.

qdm12 · 2025-02-10T07:49:50Z

Working as expected, this is good to go (same as ava-labs/coreth#745), just need reviews 😉

darioush

some optional suggestions

scripts/geth-allowed-packages.txt

plugin/evm/testutils/testutils_test.go

plugin/evm/testutils/metrics.go

plugin/evm/testutils/testutils_test.go

plugin/evm/vm.go

scripts/geth-allowed-packages.txt

plugin/evm/testutils/testutils.go

Signed-off-by: Quentin McGaw <[email protected]>

ceyonur · 2025-02-20T10:05:04Z

plugin/evm/testutils/testutils_test.go

+// - a non-test file imports the testutils package
+func TestMustNotImport(t *testing.T) {
+	prodOnly := false
+	checkNotImporting(t, "../", prodOnly, "testutils should only be used outside plugin/evm")


why do we have such limitation? Does that mean we can't use this pkg in plugin/evm test files?

See this comment. TLDR:

this testutils package is only to limit diffs in geth code

(subjective) we should prefer to copy paste test helping utilities, to reduce package dependencies and possible cycle import issues

I don't think we should limit this pkg like that. if we nee such a pkg it should be in internal if possible and under a different pkg than plugin/evm. I think it should be sufficient to check this is not imported in any prod code, no?

I'm fine with copy pasting WithMetrics if we feel like it's best not to import metrics here.

thinking again, having a testutils package actually indicates this should be not called from prod code. So not sure if there is any point to strict that down too much.

ceyonur · 2025-02-26T07:20:27Z

metrics/prometheus/prometheus.go

+		metrics.NilGauge, metrics.NilGaugeFloat64, metrics.NilGaugeInfo,
+		metrics.NilHealthcheck, metrics.NilHistogram, metrics.NilMeter,
+		metrics.NilResettingTimer, metrics.NilSample, metrics.NilTimer:
+		return nil, fmt.Errorf("%w: %q metric is nil", errMetricSkip, name)


if we're going to skip this, can't we just return nil err?

ceyonur · 2025-02-26T07:22:46Z

metrics/prometheus/prometheus.go

+			}},
+		}, nil
+	default:
+		return nil, fmt.Errorf("metric %q: type is not supported: %T", name, metric)


this won't cause any unknown geth metric type to break this, right? (e.g a new upstream type in the future)

ceyonur · 2025-02-26T07:30:01Z

plugin/evm/testutils/testutils_test.go

+// - a non-test file imports the testutils package
+func TestMustNotImport(t *testing.T) {
+	prodOnly := false
+	checkNotImporting(t, "../", prodOnly, "testutils should only be used outside plugin/evm")


I don't think we should limit this pkg like that. if we nee such a pkg it should be in internal if possible and under a different pkg than plugin/evm. I think it should be sufficient to check this is not imported in any prod code, no?

I'm fine with copy pasting WithMetrics if we feel like it's best not to import metrics here.

ceyonur · 2025-02-26T07:33:12Z

plugin/evm/testutils/testutils_test.go

+// - a non-test file imports the testutils package
+func TestMustNotImport(t *testing.T) {
+	prodOnly := false
+	checkNotImporting(t, "../", prodOnly, "testutils should only be used outside plugin/evm")


thinking again, having a testutils package actually indicates this should be not called from prod code. So not sure if there is any point to strict that down too much.

qdm12 mentioned this pull request Jan 13, 2025

chore(metrics/prometheus): add files needed for coreth and subnet-evm ava-labs/libevm#103

Closed

qdm12 force-pushed the qdm12/libevm/metrics branch 2 times, most recently from 34e9afd to 8c8514c Compare January 13, 2025 14:57

qdm12 commented Jan 13, 2025

View reviewed changes

qdm12 marked this pull request as ready for review January 13, 2025 16:08

qdm12 requested review from ceyonur, darioush and a team as code owners January 13, 2025 16:08

qdm12 commented Jan 13, 2025

View reviewed changes

metrics/prometheus/prometheus.go Outdated Show resolved Hide resolved

metrics/prometheus/prometheus_test.go Outdated Show resolved Hide resolved

qdm12 commented Jan 13, 2025

View reviewed changes

metrics/prometheus/prometheus.go Outdated Show resolved Hide resolved

qdm12 mentioned this pull request Jan 13, 2025

chore(metrics): use geth metrics package and delete local metrics ava-labs/coreth#745

Merged

darioush reviewed Jan 13, 2025

View reviewed changes

go.mod Outdated Show resolved Hide resolved

warp/handlers/signature_request_test.go Outdated Show resolved Hide resolved

metrics/prometheus/prometheus.go Outdated Show resolved Hide resolved

qdm12 force-pushed the qdm12/libevm/metrics branch from 7c08815 to 15866c8 Compare January 15, 2025 11:15

qdm12 requested a review from darioush January 15, 2025 11:40

darioush previously approved these changes Jan 23, 2025

View reviewed changes

qdm12 changed the title ~~chore(metrics): use libevm metrics package and delete local metrics~~ chore(metrics): use geth metrics package and delete local metrics Jan 27, 2025

qdm12 force-pushed the qdm12/libevm/metrics branch from 15866c8 to 769d5fc Compare January 27, 2025 12:50

qdm12 added 13 commits January 27, 2025 14:33

chore(metrics): use libevm metrics package and delete local metrics

140cedc

Migrate subnet-evm specific files back to metrics/prometheus

039d3cc

- Bring over refactoring and fixes done in ava-labs/libevm#103 - Bring over test refactoring done in ava-labs/libevm#103

tests: only enable metrics and revert to disable if already disabled

dbf332b

Enable metrics by default with init block

7bbca63

Change copyright notice from 2025 to 2021-2025

4c5a5f2

Signed-off-by: Quentin McGaw <[email protected]>

Change copyright notice from 2025 to 2021-2025

ed54e49

Signed-off-by: Quentin McGaw <[email protected]>

Use go-ethereum instead of libevm

4b412da

Enable geth metrics in initializeMetrics

086ae0a

testutils.WithMetrics function in plugin/evm

e506a31

metrics/prometheus: add test cases for full coverage

daf98ef

metrics/prometheus: add metric name to error wrappings

fc03ffb

Minor changes

2ef34bf

- add exported comments - rename `g` to `gatherer` in test - Format copyright as it as ™️ - Remove TODO

Enforce testutils package is only imported by test files outside plug…

b008bf7

…in/evm

maru-ava previously approved these changes Jan 27, 2025

View reviewed changes

Merge branch 'master' into qdm12/libevm/metrics

a4eaf83

qdm12 dismissed stale reviews from maru-ava and darioush via a4eaf83 February 7, 2025 14:34

qdm12 enabled auto-merge (squash) February 10, 2025 07:50

qdm12 requested review from darioush and maru-ava February 10, 2025 07:50

maru-ava previously approved these changes Feb 10, 2025

View reviewed changes

darioush previously approved these changes Feb 11, 2025

View reviewed changes

scripts/geth-allowed-packages.txt Outdated Show resolved Hide resolved

plugin/evm/testutils/testutils_test.go Outdated Show resolved Hide resolved

ceyonur reviewed Feb 11, 2025

View reviewed changes

plugin/evm/testutils/metrics.go Outdated Show resolved Hide resolved

plugin/evm/testutils/testutils_test.go Show resolved Hide resolved

plugin/evm/vm.go Show resolved Hide resolved

plugin/evm/vm.go Show resolved Hide resolved

scripts/geth-allowed-packages.txt Outdated Show resolved Hide resolved

Rework regex matching for lint_allowed_geth_imports.sh

e389c7f

qdm12 dismissed stale reviews from darioush and maru-ava via e389c7f February 17, 2025 13:02

qdm12 added 2 commits February 17, 2025 15:40

Rework TestMustNotImport to check for imports in non test code

2f70d44

Add comment on metrics.Enabled = true in initializeMetrics

8867f6d

qdm12 commented Feb 17, 2025

View reviewed changes

plugin/evm/testutils/testutils.go Outdated Show resolved Hide resolved

Clarify testutils package comment

2a5bd11

Signed-off-by: Quentin McGaw <[email protected]>

qdm12 requested a review from ceyonur February 17, 2025 14:47

darioush previously approved these changes Feb 18, 2025

View reviewed changes

qdm12 added the DO NOT MERGE This PR is not meant to be merged in its current state label Feb 20, 2025

ceyonur reviewed Feb 20, 2025

View reviewed changes

qdm12 added 2 commits February 24, 2025 16:38

Skip nil metric types

fa69cd4

Merge branch 'master' into qdm12/libevm/metrics

5fe9395

qdm12 dismissed darioush’s stale review via 5fe9395 February 24, 2025 15:39

qdm12 removed the DO NOT MERGE This PR is not meant to be merged in its current state label Feb 24, 2025

qdm12 requested a review from ceyonur February 24, 2025 15:45

TestGatherer_Gather tests nil metrics

97ec3bd

ceyonur reviewed Feb 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(metrics): use geth metrics package and delete local metrics #1422

chore(metrics): use geth metrics package and delete local metrics #1422

qdm12 commented Jan 13, 2025 •

edited

Loading

qdm12 Jan 13, 2025

maru-ava left a comment

qdm12 commented Jan 28, 2025

qdm12 commented Feb 10, 2025

darioush left a comment

ceyonur Feb 20, 2025

qdm12 Feb 24, 2025

ceyonur Feb 26, 2025

ceyonur Feb 26, 2025

ceyonur Feb 26, 2025

ceyonur Feb 26, 2025

ceyonur Feb 26, 2025

ceyonur Feb 26, 2025

		default:
		return nil, fmt.Errorf("metric type is not supported: %T", metric)

chore(metrics): use geth metrics package and delete local metrics #1422

Are you sure you want to change the base?

chore(metrics): use geth metrics package and delete local metrics #1422

Conversation

qdm12 commented Jan 13, 2025 • edited Loading

Why this should be merged

How this works

How this was tested

Need to be documented?

Need to update RELEASES.md?

Choose a reason for hiding this comment

maru-ava left a comment

Choose a reason for hiding this comment

qdm12 commented Jan 28, 2025

qdm12 commented Feb 10, 2025

darioush left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qdm12 commented Jan 13, 2025 •

edited

Loading