Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 27 commits into from
Mar 21, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
8ecc73c
chore(metrics): use libevm metrics package and delete local metrics
qdm12 Jan 13, 2025
d2ca841
tests: only enable metrics and revert to disable if already disabled
qdm12 Jan 13, 2025
00865c2
Enable metrics by default with init block
qdm12 Jan 13, 2025
7b3611a
Change copyright notice from 2025 to 2021-2025
qdm12 Jan 13, 2025
51d7255
Enable libevm metrics in initializeMetrics
qdm12 Jan 15, 2025
3a95319
`testutils.WithMetrics` function in plugin/evm
qdm12 Jan 15, 2025
6e58856
metrics/prometheus: add test cases for full coverage
qdm12 Jan 15, 2025
4949b7d
metrics/prometheus: add metric name to error wrappings
qdm12 Jan 15, 2025
d03d034
Minor changes
qdm12 Jan 15, 2025
bd8a136
Enforce testutils package is only imported by test files outside plug…
qdm12 Jan 15, 2025
0183ff5
Rework regex matching for lint_allowed_geth_imports.sh
qdm12 Feb 17, 2025
29e39f0
Rework `TestMustNotImport` to check for imports in non test code
qdm12 Feb 17, 2025
3672a2e
Add comment on metrics.Enabled = true in `initializeMetrics`
qdm12 Feb 17, 2025
4e9cf9e
Clarify testutils package comment
qdm12 Feb 17, 2025
a7a8c24
Skip nil metric types
qdm12 Feb 24, 2025
c6b2e22
TestGatherer_Gather tests nil metrics
qdm12 Feb 24, 2025
8207254
Remove restrictions on plugin/evm/testutils package imports
qdm12 Mar 10, 2025
c89a5a5
Move plugin/evm/testutils to internal/testutils
qdm12 Mar 10, 2025
710f0ca
Add mutex for WithMetrics call
qdm12 Mar 17, 2025
abb2a70
Improve Registry comment
qdm12 Mar 17, 2025
81c7f8a
Improve readability of Gather() body for error handling
qdm12 Mar 18, 2025
4004860
Use testutils.WithMetrics in TestGatherer_Gather
qdm12 Mar 18, 2025
86e1086
Use sentinel error for metric type not supported
qdm12 Mar 18, 2025
0c9f6df
Add missing copyright notice to testutils/metrics.go
qdm12 Mar 18, 2025
2166bea
registerNilMetrics function
qdm12 Mar 18, 2025
bcc3919
Add context to require.NoError in test
qdm12 Mar 18, 2025
2ce6cfa
Replace Registry comment with interface assertion
ARR4N Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/blockchain.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import (
"github.com/ava-labs/libevm/ethdb"
"github.com/ava-labs/libevm/event"
"github.com/ava-labs/libevm/log"
"github.com/ava-labs/libevm/metrics"
"github.com/ava-labs/libevm/trie"
"github.com/ava-labs/libevm/triedb"
"github.com/ava-labs/subnet-evm/commontype"
Expand All @@ -55,7 +56,6 @@ import (
"github.com/ava-labs/subnet-evm/core/state/snapshot"
"github.com/ava-labs/subnet-evm/core/types"
"github.com/ava-labs/subnet-evm/internal/version"
"github.com/ava-labs/subnet-evm/metrics"
"github.com/ava-labs/subnet-evm/params"
"github.com/ava-labs/subnet-evm/triedb/hashdb"
"github.com/ava-labs/subnet-evm/triedb/pathdb"
Expand Down
2 changes: 1 addition & 1 deletion core/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ func TestMain(m *testing.M) {
opts := []goleak.Option{
// No good way to shut down these goroutines:
goleak.IgnoreTopFunction("github.com/ava-labs/subnet-evm/core/state/snapshot.(*diskLayer).generate"),
goleak.IgnoreTopFunction("github.com/ava-labs/subnet-evm/metrics.(*meterArbiter).tick"),
goleak.IgnoreTopFunction("github.com/ava-labs/libevm/metrics.(*meterArbiter).tick"),
goleak.IgnoreTopFunction("github.com/syndtr/goleveldb/leveldb.(*DB).mpoolDrain"),
}
goleak.VerifyTestMain(m, opts...)
Expand Down
2 changes: 1 addition & 1 deletion core/rawdb/schema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import (
"github.com/ava-labs/avalanchego/utils/wrappers"
"github.com/ava-labs/libevm/common"
"github.com/ava-labs/libevm/crypto"
"github.com/ava-labs/subnet-evm/metrics"
"github.com/ava-labs/libevm/metrics"
)

// The fields below define the low level database schema prefixing.
Expand Down
2 changes: 1 addition & 1 deletion core/state/snapshot/snapshot.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ import (
"github.com/ava-labs/libevm/ethdb"
"github.com/ava-labs/libevm/libevm/stateconf"
"github.com/ava-labs/libevm/log"
"github.com/ava-labs/libevm/metrics"
"github.com/ava-labs/libevm/triedb"
"github.com/ava-labs/subnet-evm/core/rawdb"
"github.com/ava-labs/subnet-evm/metrics"
)

const (
Expand Down
2 changes: 1 addition & 1 deletion core/state/trie_prefetcher_extra_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ import (
"github.com/ava-labs/avalanchego/database"
"github.com/ava-labs/libevm/common"
"github.com/ava-labs/libevm/ethdb"
"github.com/ava-labs/libevm/metrics"
"github.com/ava-labs/libevm/triedb"
"github.com/ava-labs/subnet-evm/core/rawdb"
"github.com/ava-labs/subnet-evm/core/state/snapshot"
"github.com/ava-labs/subnet-evm/core/types"
"github.com/ava-labs/subnet-evm/metrics"
"github.com/ava-labs/subnet-evm/triedb/hashdb"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion core/txpool/blobpool/blobpool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ import (
"github.com/ava-labs/libevm/common"
"github.com/ava-labs/libevm/event"
"github.com/ava-labs/libevm/log"
"github.com/ava-labs/libevm/metrics"
"github.com/ava-labs/libevm/rlp"
"github.com/ava-labs/subnet-evm/consensus/misc/eip4844"
"github.com/ava-labs/subnet-evm/core"
"github.com/ava-labs/subnet-evm/core/state"
"github.com/ava-labs/subnet-evm/core/txpool"
"github.com/ava-labs/subnet-evm/core/types"
"github.com/ava-labs/subnet-evm/metrics"
"github.com/ava-labs/subnet-evm/params"
"github.com/ava-labs/subnet-evm/plugin/evm/header"
"github.com/holiman/billy"
Expand Down
2 changes: 1 addition & 1 deletion core/txpool/blobpool/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

package blobpool

import "github.com/ava-labs/subnet-evm/metrics"
import "github.com/ava-labs/libevm/metrics"

var (
// datacapGauge tracks the user's configured capacity for the blob pool. It
Expand Down
2 changes: 1 addition & 1 deletion core/txpool/legacypool/legacypool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ import (
"github.com/ava-labs/libevm/common/prque"
"github.com/ava-labs/libevm/event"
"github.com/ava-labs/libevm/log"
"github.com/ava-labs/libevm/metrics"
"github.com/ava-labs/subnet-evm/commontype"
"github.com/ava-labs/subnet-evm/core"
"github.com/ava-labs/subnet-evm/core/state"
"github.com/ava-labs/subnet-evm/core/txpool"
"github.com/ava-labs/subnet-evm/core/types"
"github.com/ava-labs/subnet-evm/metrics"
"github.com/ava-labs/subnet-evm/params"
"github.com/ava-labs/subnet-evm/plugin/evm/header"
"github.com/ava-labs/subnet-evm/precompile/contracts/feemanager"
Expand Down
2 changes: 1 addition & 1 deletion core/txpool/txpool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ import (
"github.com/ava-labs/libevm/common"
"github.com/ava-labs/libevm/event"
"github.com/ava-labs/libevm/log"
"github.com/ava-labs/libevm/metrics"
"github.com/ava-labs/subnet-evm/core"
"github.com/ava-labs/subnet-evm/core/types"
"github.com/ava-labs/subnet-evm/metrics"
)

var (
Expand Down
4 changes: 2 additions & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ require (
github.com/onsi/ginkgo/v2 v2.13.1
github.com/prometheus/client_golang v1.16.0
github.com/prometheus/client_model v0.3.0
github.com/shirou/gopsutil v3.21.11+incompatible
github.com/spf13/cast v1.5.0
github.com/spf13/pflag v1.0.5
github.com/spf13/viper v1.12.0
Expand All @@ -38,7 +37,6 @@ require (
golang.org/x/exp v0.0.0-20241215155358-4a5509556b9e
golang.org/x/mod v0.22.0
golang.org/x/sync v0.10.0
golang.org/x/sys v0.29.0
golang.org/x/time v0.3.0
golang.org/x/tools v0.29.0
google.golang.org/protobuf v1.35.2
Expand Down Expand Up @@ -133,6 +131,7 @@ require (
github.com/rogpeppe/go-internal v1.12.0 // indirect
github.com/rs/cors v1.7.0 // indirect
github.com/russross/blackfriday/v2 v2.1.0 // indirect
github.com/shirou/gopsutil v3.21.11+incompatible // indirect
github.com/sirupsen/logrus v1.9.0 // indirect
github.com/spf13/afero v1.8.2 // indirect
github.com/spf13/jwalterweatherman v1.1.0 // indirect
Expand All @@ -156,6 +155,7 @@ require (
go.uber.org/multierr v1.11.0 // indirect
golang.org/x/net v0.34.0 // indirect
golang.org/x/oauth2 v0.21.0 // indirect
golang.org/x/sys v0.29.0 // indirect
golang.org/x/term v0.28.0 // indirect
golang.org/x/text v0.21.0 // indirect
gonum.org/v1/gonum v0.11.0 // indirect
Expand Down
30 changes: 30 additions & 0 deletions internal/testutils/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// (c) 2024-2025, Ava Labs, Inc. All rights reserved.
// See the file LICENSE for licensing terms.

package testutils

import (
"sync"
"testing"

"github.com/ethereum/go-ethereum/metrics"
)

var metricsLock sync.Mutex

// WithMetrics enables go-ethereum metrics globally for the test.
// If the [metrics.Enabled] is already true, nothing is done.
// Otherwise, it is set to true and is reverted to false when the test finishes.
func WithMetrics(t *testing.T) {
metricsLock.Lock()
t.Cleanup(func() {
metricsLock.Unlock()
})
if metrics.Enabled {
return
}
metrics.Enabled = true
t.Cleanup(func() {
metrics.Enabled = false
})
}
1 change: 0 additions & 1 deletion metrics/FORK.md
View file
Open in desktop

This file was deleted.

29 changes: 0 additions & 29 deletions metrics/LICENSE
View file
Open in desktop

This file was deleted.

102 changes: 0 additions & 102 deletions metrics/README.md
View file
Open in desktop

This file was deleted.

43 changes: 0 additions & 43 deletions metrics/config.go
View file
Open in desktop

This file was deleted.

Loading
Loading