mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-20 13:44:31 +00:00
6beee27886
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>
111 lines
5.4 KiB
Go
111 lines
5.4 KiB
Go
// Copyright 2016 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 les
|
|
|
|
import (
|
|
"github.com/XinFinOrg/XDPoSChain/metrics"
|
|
"github.com/XinFinOrg/XDPoSChain/p2p"
|
|
)
|
|
|
|
var (
|
|
/* propTxnInPacketsMeter = metrics.NewMeter("eth/prop/txns/in/packets")
|
|
propTxnInTrafficMeter = metrics.NewMeter("eth/prop/txns/in/traffic")
|
|
propTxnOutPacketsMeter = metrics.NewMeter("eth/prop/txns/out/packets")
|
|
propTxnOutTrafficMeter = metrics.NewMeter("eth/prop/txns/out/traffic")
|
|
propHashInPacketsMeter = metrics.NewMeter("eth/prop/hashes/in/packets")
|
|
propHashInTrafficMeter = metrics.NewMeter("eth/prop/hashes/in/traffic")
|
|
propHashOutPacketsMeter = metrics.NewMeter("eth/prop/hashes/out/packets")
|
|
propHashOutTrafficMeter = metrics.NewMeter("eth/prop/hashes/out/traffic")
|
|
propBlockInPacketsMeter = metrics.NewMeter("eth/prop/blocks/in/packets")
|
|
propBlockInTrafficMeter = metrics.NewMeter("eth/prop/blocks/in/traffic")
|
|
propBlockOutPacketsMeter = metrics.NewMeter("eth/prop/blocks/out/packets")
|
|
propBlockOutTrafficMeter = metrics.NewMeter("eth/prop/blocks/out/traffic")
|
|
reqHashInPacketsMeter = metrics.NewMeter("eth/req/hashes/in/packets")
|
|
reqHashInTrafficMeter = metrics.NewMeter("eth/req/hashes/in/traffic")
|
|
reqHashOutPacketsMeter = metrics.NewMeter("eth/req/hashes/out/packets")
|
|
reqHashOutTrafficMeter = metrics.NewMeter("eth/req/hashes/out/traffic")
|
|
reqBlockInPacketsMeter = metrics.NewMeter("eth/req/blocks/in/packets")
|
|
reqBlockInTrafficMeter = metrics.NewMeter("eth/req/blocks/in/traffic")
|
|
reqBlockOutPacketsMeter = metrics.NewMeter("eth/req/blocks/out/packets")
|
|
reqBlockOutTrafficMeter = metrics.NewMeter("eth/req/blocks/out/traffic")
|
|
reqHeaderInPacketsMeter = metrics.NewMeter("eth/req/headers/in/packets")
|
|
reqHeaderInTrafficMeter = metrics.NewMeter("eth/req/headers/in/traffic")
|
|
reqHeaderOutPacketsMeter = metrics.NewMeter("eth/req/headers/out/packets")
|
|
reqHeaderOutTrafficMeter = metrics.NewMeter("eth/req/headers/out/traffic")
|
|
reqBodyInPacketsMeter = metrics.NewMeter("eth/req/bodies/in/packets")
|
|
reqBodyInTrafficMeter = metrics.NewMeter("eth/req/bodies/in/traffic")
|
|
reqBodyOutPacketsMeter = metrics.NewMeter("eth/req/bodies/out/packets")
|
|
reqBodyOutTrafficMeter = metrics.NewMeter("eth/req/bodies/out/traffic")
|
|
reqStateInPacketsMeter = metrics.NewMeter("eth/req/states/in/packets")
|
|
reqStateInTrafficMeter = metrics.NewMeter("eth/req/states/in/traffic")
|
|
reqStateOutPacketsMeter = metrics.NewMeter("eth/req/states/out/packets")
|
|
reqStateOutTrafficMeter = metrics.NewMeter("eth/req/states/out/traffic")
|
|
reqReceiptInPacketsMeter = metrics.NewMeter("eth/req/receipts/in/packets")
|
|
reqReceiptInTrafficMeter = metrics.NewMeter("eth/req/receipts/in/traffic")
|
|
reqReceiptOutPacketsMeter = metrics.NewMeter("eth/req/receipts/out/packets")
|
|
reqReceiptOutTrafficMeter = metrics.NewMeter("eth/req/receipts/out/traffic")*/
|
|
miscInPacketsMeter = metrics.NewRegisteredMeter("les/misc/in/packets", nil)
|
|
miscInTrafficMeter = metrics.NewRegisteredMeter("les/misc/in/traffic", nil)
|
|
miscOutPacketsMeter = metrics.NewRegisteredMeter("les/misc/out/packets", nil)
|
|
miscOutTrafficMeter = metrics.NewRegisteredMeter("les/misc/out/traffic", nil)
|
|
)
|
|
|
|
// meteredMsgReadWriter is a wrapper around a p2p.MsgReadWriter, capable of
|
|
// accumulating the above defined metrics based on the data stream contents.
|
|
type meteredMsgReadWriter struct {
|
|
p2p.MsgReadWriter // Wrapped message stream to meter
|
|
version int // Protocol version to select correct meters
|
|
}
|
|
|
|
// newMeteredMsgWriter wraps a p2p MsgReadWriter with metering support. If the
|
|
// metrics system is disabled, this function returns the original object.
|
|
func newMeteredMsgWriter(rw p2p.MsgReadWriter) p2p.MsgReadWriter {
|
|
if !metrics.Enabled() {
|
|
return rw
|
|
}
|
|
return &meteredMsgReadWriter{MsgReadWriter: rw}
|
|
}
|
|
|
|
// Init sets the protocol version used by the stream to know which meters to
|
|
// increment in case of overlapping message ids between protocol versions.
|
|
func (rw *meteredMsgReadWriter) Init(version int) {
|
|
rw.version = version
|
|
}
|
|
|
|
func (rw *meteredMsgReadWriter) ReadMsg() (p2p.Msg, error) {
|
|
// Read the message and short circuit in case of an error
|
|
msg, err := rw.MsgReadWriter.ReadMsg()
|
|
if err != nil {
|
|
return msg, err
|
|
}
|
|
// Account for the data traffic
|
|
packets, traffic := miscInPacketsMeter, miscInTrafficMeter
|
|
packets.Mark(1)
|
|
traffic.Mark(int64(msg.Size))
|
|
|
|
return msg, err
|
|
}
|
|
|
|
func (rw *meteredMsgReadWriter) WriteMsg(msg p2p.Msg) error {
|
|
// Account for the data traffic
|
|
packets, traffic := miscOutPacketsMeter, miscOutTrafficMeter
|
|
packets.Mark(1)
|
|
traffic.Mark(int64(msg.Size))
|
|
|
|
// Send the packet to the p2p layer
|
|
return rw.MsgReadWriter.WriteMsg(msg)
|
|
}
|