Merge pull request #608 from shutter-network/feat/EL/CL-metrics

feat: add EL & CL version metrics

Author: blockchainluffy

rolling-shutter/keyper/keypermetrics/metrics.go

@@ -1,9 +1,13 @@
 package keypermetrics
 
 import (
+	"context"
+
 	"github.com/prometheus/client_golang/prometheus"
+	"github.com/rs/zerolog/log"
 
 	"github.com/shutter-network/rolling-shutter/rolling-shutter/keyper/kprconfig"
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/chainsync"
 )
 
 var MetricsKeyperCurrentBlockL1 = prometheus.NewGauge(
@@ -91,6 +95,24 @@ func InitMetrics(config kprconfig.Config) {
 	prometheus.MustRegister(MetricsKeyperCurrentBatchConfigIndex)
 	prometheus.MustRegister(MetricsKeyperBatchConfigInfo)
 
+	version, err := chainsync.GetClientVersion(context.Background(), config.Ethereum.EthereumURL)
+	if err != nil {
+		log.Error().Err(err).Msg("execution_client_version metrics | Failed to get execution client version")
+		return
+	}
+
+	executionClientVersion := prometheus.NewGauge(
+		prometheus.GaugeOpts{
+			Namespace: "shutter",
+			Subsystem: "keyper",
+			Name:      "execution_client_version",
+			Help:      "Version of the execution client",
+			ConstLabels: prometheus.Labels{
+				"version": version,
+			},
+		},
+	)
+	prometheus.MustRegister(executionClientVersion)
 	metricsKeyperEthAddress := prometheus.NewGauge(
 		prometheus.GaugeOpts{
 			Namespace: "shutter",

rolling-shutter/keyperimpl/gnosis/keyper.go

@@ -71,6 +71,10 @@ func New(c *Config) *Keyper {
 func (kpr *Keyper) Start(ctx context.Context, runner service.Runner) error {
 	var err error
 
+	if kpr.config.Metrics.Enabled {
+		InitMetrics(kpr.beaconAPIClient)
+	}
+
 	kpr.newBlocks = make(chan *syncevent.LatestBlock)
 	kpr.newKeyperSets = make(chan *syncevent.KeyperSet)
 	kpr.newEonPublicKeys = make(chan keyper.EonPublicKey)

rolling-shutter/keyperimpl/gnosis/metrics.go

@@ -1,6 +1,13 @@
 package gnosis
 
-import "github.com/prometheus/client_golang/prometheus"
+import (
+	"context"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/rs/zerolog/log"
+
+	"github.com/shutter-network/rolling-shutter/rolling-shutter/medley/beaconapiclient"
+)
 
 var metricsTxPointer = prometheus.NewGaugeVec(
 	prometheus.GaugeOpts{
@@ -93,3 +100,23 @@ func init() {
 	prometheus.MustRegister(metricsKeysSentTimeDelta)
 	prometheus.MustRegister(metricsKeySharesSentTimeDelta)
 }
+
+func InitMetrics(beaconClient *beaconapiclient.Client) {
+	version, err := beaconClient.GetBeaconNodeVersion(context.Background())
+	if err != nil {
+		log.Error().Err(err).Msg("beacon_client_version metrics | Failed to get beacon node version")
+		return
+	}
+	beaconClientVersion := prometheus.NewGauge(
+		prometheus.GaugeOpts{
+			Namespace: "shutter",
+			Subsystem: "gnosis",
+			Name:      "beacon_client_version",
+			Help:      "Version of the beacon client",
+			ConstLabels: prometheus.Labels{
+				"version": version,
+			},
+		},
+	)
+	prometheus.MustRegister(beaconClientVersion)
+}

rolling-shutter/medley/beaconapiclient/beaconapiclient.go

@@ -1,6 +1,10 @@
 package beaconapiclient
 
 import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"io"
 	"net/http"
 	"net/url"
 )
@@ -20,3 +24,33 @@ func New(rawURL string) (*Client, error) {
 		url: parsedURL,
 	}, nil
 }
+
+func (c *Client) GetBeaconNodeVersion(ctx context.Context) (string, error) {
+	path := c.url.JoinPath("/eth/v1/node/version")
+	req, err := http.NewRequestWithContext(ctx, "GET", path.String(), http.NoBody)
+	if err != nil {
+		return "", err
+	}
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return "", fmt.Errorf("failed to get beacon node version from consensus node: %w", err)
+	}
+	defer resp.Body.Close()
+	if resp.StatusCode != http.StatusOK {
+		return "", fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	}
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return "", err
+	}
+	var result struct {
+		Data struct {
+			Version string `json:"version"`
+		} `json:"data"`
+	}
+	err = json.Unmarshal(body, &result)
+	if err != nil {
+		return "", err
+	}
+	return result.Data.Version, nil
+}

rolling-shutter/medley/chainsync/client.go

@@ -8,6 +8,7 @@ import (
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
+	"github.com/ethereum/go-ethereum/rpc"
 	"github.com/pkg/errors"
 	"github.com/shutter-network/shop-contracts/bindings"
 
@@ -148,3 +149,13 @@ func (s *Client) ChainID(ctx context.Context) (*big.Int, error) {
 func (s *Client) Start(_ context.Context, runner service.Runner) error {
 	return runner.StartService(s.getServices()...)
 }
+
+func GetClientVersion(ctx context.Context, ethereumURL string) (string, error) {
+	client, err := rpc.DialContext(ctx, ethereumURL)
+	if err != nil {
+		return "", err
+	}
+	var version string
+	err = client.CallContext(ctx, &version, "web3_clientVersion")
+	return version, err
+}