Tracked validators metric

CHANGELOG.md

@@ -16,6 +16,7 @@ The format is based on Keep a Changelog, and this project adheres to Semantic Ve
 - Added SubmitPoolAttesterSlashingV2 endpoint.
 - Added SubmitAggregateAndProofsRequestV2 endpoint.
 - Updated the `beacon-chain/monitor` package to Electra. [PR](https://github.com/prysmaticlabs/prysm/pull/14562)
+- Metric for the size of tracked validators cache
 
 ### Changed
 

api/BUILD.bazel

@@ -6,13 +6,16 @@ go_library(
         "constants.go",
         "headers.go",
         "jwt.go",
+        "metrics.go",
     ],
     importpath = "github.com/prysmaticlabs/prysm/v5/api",
     visibility = ["//visibility:public"],
     deps = [
         "//crypto/rand:go_default_library",
         "@com_github_ethereum_go_ethereum//common/hexutil:go_default_library",
         "@com_github_pkg_errors//:go_default_library",
+        "@com_github_prometheus_client_golang//prometheus:go_default_library",
+        "@com_github_prometheus_client_golang//prometheus/promauto:go_default_library",
     ],
 )
 

api/metrics.go

@@ -0,0 +1,13 @@
+package api
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promauto"
+)
+
+var (
+	TrackedValidatorsCount = promauto.NewGauge(prometheus.GaugeOpts{
+		Name: "tracked_validator_count",
+		Help: "The total number of validators tracked by trackedValidatorsCache in the beacon node. This is updated at intervals via the push proposer settings API endpoint.",
+	})
+)

beacon-chain/cache/tracked_validators.go

@@ -47,3 +47,9 @@ func (t *TrackedValidatorsCache) Validating() bool {
 	defer t.Unlock()
 	return len(t.trackedValidators) > 0
 }
+
+func (t *TrackedValidatorsCache) Size() int {
+	t.Lock()
+	defer t.Unlock()
+	return len(t.trackedValidators)
+}

beacon-chain/rpc/eth/validator/handlers.go

@@ -677,6 +677,7 @@ func (s *Server) PrepareBeaconProposer(w http.ResponseWriter, r *http.Request) {
 	if len(validatorIndices) == 0 {
 		return
 	}
+	api.TrackedValidatorsCount.Set(float64(s.TrackedValidatorsCache.Size()))
 	log.WithFields(logrus.Fields{
 		"validatorIndices": validatorIndices,
 	}).Info("Updated fee recipient addresses")

beacon-chain/rpc/prysm/v1alpha1/validator/BUILD.bazel

@@ -33,6 +33,7 @@ go_library(
     importpath = "github.com/prysmaticlabs/prysm/v5/beacon-chain/rpc/prysm/v1alpha1/validator",
     visibility = ["//beacon-chain:__subpackages__"],
     deps = [
+        "//api:go_default_library",
         "//api/client/builder:go_default_library",
         "//async/event:go_default_library",
         "//beacon-chain/blockchain:go_default_library",

beacon-chain/rpc/prysm/v1alpha1/validator/proposer.go

@@ -11,6 +11,7 @@ import (
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	emptypb "github.com/golang/protobuf/ptypes/empty"
 	"github.com/pkg/errors"
+	"github.com/prysmaticlabs/prysm/v5/api"
 	builderapi "github.com/prysmaticlabs/prysm/v5/api/client/builder"
 	"github.com/prysmaticlabs/prysm/v5/beacon-chain/blockchain"
 	"github.com/prysmaticlabs/prysm/v5/beacon-chain/builder"
@@ -427,6 +428,7 @@ func (vs *Server) PrepareBeaconProposer(
 		validatorIndices = append(validatorIndices, r.ValidatorIndex)
 	}
 	if len(validatorIndices) != 0 {
+		api.TrackedValidatorsCount.Set(float64(vs.TrackedValidatorsCache.Size()))
 		log.WithFields(logrus.Fields{
 			"validatorCount": len(validatorIndices),
 		}).Debug("Updated fee recipient addresses for validator indices")