path: root/eth/metrics.go

// Copyright 2015 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"
    "github.com/ethereum/go-ethereum/p2p"
)

var (
    propTxnInPacketsMeter     = metrics.NewRegisteredMeter("eth/prop/txns/in/packets", nil)
    propTxnInTrafficMeter     = metrics.NewRegisteredMeter("eth/prop/txns/in/traffic", nil)
    propTxnOutPacketsMeter    = metrics.NewRegisteredMeter("eth/prop/txns/out/packets", nil)
    propTxnOutTrafficMeter    = metrics.NewRegisteredMeter("eth/prop/txns/out/traffic", nil)
    propHashInPacketsMeter    = metrics.NewRegisteredMeter("eth/prop/hashes/in/packets", nil)
    propHashInTrafficMeter    = metrics.NewRegisteredMeter("eth/prop/hashes/in/traffic", nil)
    propHashOutPacketsMeter   = metrics.NewRegisteredMeter("eth/prop/hashes/out/packets", nil)
    propHashOutTrafficMeter   = metrics.NewRegisteredMeter("eth/prop/hashes/out/traffic", nil)
    propBlockInPacketsMeter   = metrics.NewRegisteredMeter("eth/prop/blocks/in/packets", nil)
    propBlockInTrafficMeter   = metrics.NewRegisteredMeter("eth/prop/blocks/in/traffic", nil)
    propBlockOutPacketsMeter  = metrics.NewRegisteredMeter("eth/prop/blocks/out/packets", nil)
    propBlockOutTrafficMeter  = metrics.NewRegisteredMeter("eth/prop/blocks/out/traffic", nil)
    reqHeaderInPacketsMeter   = metrics.NewRegisteredMeter("eth/req/headers/in/packets", nil)
    reqHeaderInTrafficMeter   = metrics.NewRegisteredMeter("eth/req/headers/in/traffic", nil)
    reqHeaderOutPacketsMeter  = metrics.NewRegisteredMeter("eth/req/headers/out/packets", nil)
    reqHeaderOutTrafficMeter  = metrics.NewRegisteredMeter("eth/req/headers/out/traffic", nil)
    reqBodyInPacketsMeter     = metrics.NewRegisteredMeter("eth/req/bodies/in/packets", nil)
    reqBodyInTrafficMeter     = metrics.NewRegisteredMeter("eth/req/bodies/in/traffic", nil)
    reqBodyOutPacketsMeter    = metrics.NewRegisteredMeter("eth/req/bodies/out/packets", nil)
    reqBodyOutTrafficMeter    = metrics.NewRegisteredMeter("eth/req/bodies/out/traffic", nil)
    reqStateInPacketsMeter    = metrics.NewRegisteredMeter("eth/req/states/in/packets", nil)
    reqStateInTrafficMeter    = metrics.NewRegisteredMeter("eth/req/states/in/traffic", nil)
    reqStateOutPacketsMeter   = metrics.NewRegisteredMeter("eth/req/states/out/packets", nil)
    reqStateOutTrafficMeter   = metrics.NewRegisteredMeter("eth/req/states/out/traffic", nil)
    reqReceiptInPacketsMeter  = metrics.NewRegisteredMeter("eth/req/receipts/in/packets", nil)
    reqReceiptInTrafficMeter  = metrics.NewRegisteredMeter("eth/req/receipts/in/traffic", nil)
    reqReceiptOutPacketsMeter = metrics.NewRegisteredMeter("eth/req/receipts/out/packets", nil)
    reqReceiptOutTrafficMeter = metrics.NewRegisteredMeter("eth/req/receipts/out/traffic", nil)
    miscInPacketsMeter        = metrics.NewRegisteredMeter("eth/misc/in/packets", nil)
    miscInTrafficMeter        = metrics.NewRegisteredMeter("eth/misc/in/traffic", nil)
    miscOutPacketsMeter       = metrics.NewRegisteredMeter("eth/misc/out/packets", nil)
    miscOutTrafficMeter       = metrics.NewRegisteredMeter("eth/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
    switch {
    case msg.Code == BlockHeadersMsg:
        packets, traffic = reqHeaderInPacketsMeter, reqHeaderInTrafficMeter
    case msg.Code == BlockBodiesMsg:
        packets, traffic = reqBodyInPacketsMeter, reqBodyInTrafficMeter

    case rw.version >= eth63 && msg.Code == NodeDataMsg:
        packets, traffic = reqStateInPacketsMeter, reqStateInTrafficMeter
    case rw.version >= eth63 && msg.Code == ReceiptsMsg:
        packets, traffic = reqReceiptInPacketsMeter, reqReceiptInTrafficMeter

    case msg.Code == NewBlockHashesMsg:
        packets, traffic = propHashInPacketsMeter, propHashInTrafficMeter
    case msg.Code == NewBlockMsg:
        packets, traffic = propBlockInPacketsMeter, propBlockInTrafficMeter
    case msg.Code == TxMsg:
        packets, traffic = propTxnInPacketsMeter, propTxnInTrafficMeter
    }
    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
    switch {
    case msg.Code == BlockHeadersMsg:
        packets, traffic = reqHeaderOutPacketsMeter, reqHeaderOutTrafficMeter
    case msg.Code == BlockBodiesMsg:
        packets, traffic = reqBodyOutPacketsMeter, reqBodyOutTrafficMeter

    case rw.version >= eth63 && msg.Code == NodeDataMsg:
        packets, traffic = reqStateOutPacketsMeter, reqStateOutTrafficMeter
    case rw.version >= eth63 && msg.Code == ReceiptsMsg:
        packets, traffic = reqReceiptOutPacketsMeter, reqReceiptOutTrafficMeter

    case msg.Code == NewBlockHashesMsg:
        packets, traffic = propHashOutPacketsMeter, propHashOutTrafficMeter
    case msg.Code == NewBlockMsg:
        packets, traffic = propBlockOutPacketsMeter, propBlockOutTrafficMeter
    case msg.Code == TxMsg:
        packets, traffic = propTxnOutPacketsMeter, propTxnOutTrafficMeter
    }
    packets.Mark(1)
    traffic.Mark(int64(msg.Size))

    // Send the packet to the p2p layer
    return rw.MsgReadWriter.WriteMsg(msg)
}