mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-02-26 07:37:20 +00:00
9045b79bc2
This PR modifies how the metrics library handles `Enabled`: previously, the package `init` decided whether to serve real metrics or just dummy-types. This has several drawbacks: - During pkg init, we need to determine whether metrics are enabled or not. So we first hacked in a check if certain geth-specific commandline-flags were enabled. Then we added a similar check for geth-env-vars. Then we almost added a very elaborate check for toml-config-file, plus toml parsing. - Using "real" types and dummy types interchangeably means that everything is hidden behind interfaces. This has a performance penalty, and also it just adds a lot of code. This PR removes the interface stuff, uses concrete types, and allows for the setting of Enabled to happen later. It is still assumed that `metrics.Enable()` is invoked early on. The somewhat 'heavy' operations, such as ticking meters and exp-decay, now checks the enable-flag to prevent resource leak. The change may be large, but it's mostly pretty trivial, and from the last time I gutted the metrics, I ensured that we have fairly good test coverage. --------- Co-authored-by: Felix Lange <fjl@twurst.com>
81 lines
2.8 KiB
Go
81 lines
2.8 KiB
Go
// Copyright 2023 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package eth
|
|
|
|
import "github.com/ethereum/go-ethereum/metrics"
|
|
|
|
// meters stores ingress and egress handshake meters.
|
|
var meters bidirectionalMeters
|
|
|
|
// bidirectionalMeters stores ingress and egress handshake meters.
|
|
type bidirectionalMeters struct {
|
|
ingress *hsMeters
|
|
egress *hsMeters
|
|
}
|
|
|
|
// get returns the corresponding meter depending if ingress or egress is
|
|
// desired.
|
|
func (h *bidirectionalMeters) get(ingress bool) *hsMeters {
|
|
if ingress {
|
|
return h.ingress
|
|
}
|
|
return h.egress
|
|
}
|
|
|
|
// hsMeters is a collection of meters which track metrics related to the
|
|
// eth subprotocol handshake.
|
|
type hsMeters struct {
|
|
// peerError measures the number of errors related to incorrect peer
|
|
// behaviour, such as invalid message code, size, encoding, etc.
|
|
peerError *metrics.Meter
|
|
|
|
// timeoutError measures the number of timeouts.
|
|
timeoutError *metrics.Meter
|
|
|
|
// networkIDMismatch measures the number of network id mismatch errors.
|
|
networkIDMismatch *metrics.Meter
|
|
|
|
// protocolVersionMismatch measures the number of differing protocol
|
|
// versions.
|
|
protocolVersionMismatch *metrics.Meter
|
|
|
|
// genesisMismatch measures the number of differing genesises.
|
|
genesisMismatch *metrics.Meter
|
|
|
|
// forkidRejected measures the number of differing forkids.
|
|
forkidRejected *metrics.Meter
|
|
}
|
|
|
|
// newHandshakeMeters registers and returns handshake meters for the given
|
|
// base.
|
|
func newHandshakeMeters(base string) *hsMeters {
|
|
return &hsMeters{
|
|
peerError: metrics.NewRegisteredMeter(base+"error/peer", nil),
|
|
timeoutError: metrics.NewRegisteredMeter(base+"error/timeout", nil),
|
|
networkIDMismatch: metrics.NewRegisteredMeter(base+"error/network", nil),
|
|
protocolVersionMismatch: metrics.NewRegisteredMeter(base+"error/version", nil),
|
|
genesisMismatch: metrics.NewRegisteredMeter(base+"error/genesis", nil),
|
|
forkidRejected: metrics.NewRegisteredMeter(base+"error/forkid", nil),
|
|
}
|
|
}
|
|
|
|
func init() {
|
|
meters = bidirectionalMeters{
|
|
ingress: newHandshakeMeters("eth/protocols/eth/ingress/handshake/"),
|
|
egress: newHandshakeMeters("eth/protocols/eth/egress/handshake/"),
|
|
}
|
|
}
|