wormhole-foundation_wormhole/node/pkg/p2p/netmetrics.go

package p2p

import (
	"math"
	"regexp"
	"strconv"

	gossipv1 "github.com/certusone/wormhole/node/pkg/proto/gossip/v1"
	"github.com/certusone/wormhole/node/pkg/version"
	"github.com/ethereum/go-ethereum/common"
	"github.com/libp2p/go-libp2p/core/peer"
	"github.com/prometheus/client_golang/prometheus"
	"github.com/prometheus/client_golang/prometheus/promauto"
	"github.com/wormhole-foundation/wormhole/sdk/vaa"
)

var (
	wormholeNetworkNodeHeight = promauto.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "wormhole_network_node_height",
			Help: "Network height of the given guardian node per network",
		}, []string{"guardian_addr", "node_id", "node_name", "network"})
	wormholeNetworkNodeErrors = promauto.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "wormhole_network_node_errors_count",
			Help: "Number of errors the given guardian node encountered per network",
		}, []string{"guardian_addr", "node_id", "node_name", "network"})
	wormholeNetworkVersion = promauto.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "wormhole_network_node_version",
			Help: "Network version of the given guardian node per network",
		}, []string{"guardian_addr", "node_id", "node_name", "network", "version"})
)

func collectNodeMetrics(addr common.Address, peerId peer.ID, hb *gossipv1.Heartbeat) {
	for _, n := range hb.Networks {
		if n == nil {
			continue
		}

		chain := vaa.ChainID(n.Id) // #nosec G115 -- This is safe as chain id is constrained in SetNetworkStats

		wormholeNetworkNodeHeight.WithLabelValues(
			addr.Hex(), peerId.String(), hb.NodeName, chain.String()).Set(float64(n.Height))

		wormholeNetworkNodeErrors.WithLabelValues(
			addr.Hex(), peerId.String(), hb.NodeName, chain.String()).Set(float64(n.ErrorCount))

		wormholeNetworkVersion.WithLabelValues(
			addr.Hex(), peerId.String(), hb.NodeName, chain.String(),
			sanitizeVersion(hb.Version, version.Version())).Set(1)
	}
}

var (
	// Parse version string using regular expression.
	// The version string should be in the format of "vX.Y.Z"
	// where X, Y and Z are integers. Suffixes are ignored.
	reVersion = regexp.MustCompile(`^v(\d+)\.(\d+)\.(\d+)`)
)

// sanitizeVersion cleans up the version string to prevent an attacker from executing a cardinality attack.
func sanitizeVersion(versionStr string, reference string) string {
	// Match groups of reVersion
	components := reVersion.FindStringSubmatch(versionStr)
	referenceComponents := reVersion.FindStringSubmatch(reference)

	// Compare components of the version string with the reference and ensure
	// that the distance is less than 5.
	for i, c := range components {
		if len(referenceComponents) <= i {
			return "other"
		}

		cInt, _ := strconv.Atoi(c)
		cRefInt, _ := strconv.Atoi(referenceComponents[i])

		if math.Abs(float64(cInt-cRefInt)) > 5 {
			return "other"
		}
	}

	v := reVersion.FindString(versionStr)
	if v == "" {
		return "other"
	}
	return v
}