feat: expose validators rank (#3)

Author: MattKetmo

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/avast/retry-go/v4 v4.5.0
 	github.com/fatih/color v1.15.0
 	github.com/prometheus/client_golang v1.16.0
-	github.com/rs/zerolog v1.31.0
+	github.com/shopspring/decimal v1.3.1
 	github.com/sirupsen/logrus v1.9.0
 	github.com/urfave/cli/v2 v2.25.7
 	golang.org/x/sync v0.3.0

go.sum

@@ -4,15 +4,13 @@ github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
 github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
 github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
-github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
 github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
-github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/golang/protobuf v1.3.5/go.mod h1:6O5/vntMXwX2lRkT1hjjk0nAC1IDOTvTlVgjlRvqsdk=
 github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
@@ -27,7 +25,6 @@ github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APP
 github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zkfA9PSy5pEvNWRP0ET0TIVo=
 github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=
-github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/prometheus/client_golang v1.16.0 h1:yk/hx9hDbrGHovbci4BY+pRMfSuuat626eFsHb7tmT8=
@@ -38,11 +35,10 @@ github.com/prometheus/common v0.42.0 h1:EKsfXEYo4JpWMHH5cg+KOUWeuJSov1Id8zGR8eeI
 github.com/prometheus/common v0.42.0/go.mod h1:xBwqVerjNdUDjgODMpudtOMwlOwf2SaTr1yjz4b7Zbc=
 github.com/prometheus/procfs v0.10.1 h1:kYK1Va/YMlutzCGazswoHKo//tZVlFpKYh+PymziUAg=
 github.com/prometheus/procfs v0.10.1/go.mod h1:nwNm2aOCAYw8uTR/9bWRREkZFxAUcWzPHWJq+XBB/FM=
-github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.31.0 h1:FcTR3NnLWW+NnTwwhFWiJSZr4ECLpqCm6QsEnyvbV4A=
-github.com/rs/zerolog v1.31.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/shopspring/decimal v1.3.1 h1:2Usl1nmF/WZucqkFZhnfFYxxxu8LG21F6nPQBE5gKV8=
+github.com/shopspring/decimal v1.3.1/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o=
 github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
 github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=

pkg/app/run.go

@@ -2,7 +2,6 @@ package app
 
 import (
 	"context"
-	"fmt"
 	"net/http"
 	"os"
 	"os/signal"
@@ -14,7 +13,6 @@ import (
 	"github.com/kilnfi/near-validator-watcher/pkg/near"
 	"github.com/kilnfi/near-validator-watcher/pkg/watcher"
 	"github.com/prometheus/client_golang/prometheus"
-	"github.com/rs/zerolog/log"
 	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v2"
 	"golang.org/x/sync/errgroup"
@@ -101,7 +99,7 @@ func RunFunc(cCtx *cli.Context) error {
 	defer cancel()
 
 	if err := httpServer.Shutdown(ctx); err != nil {
-		log.Error().Err(fmt.Errorf("failed to stop http server: %w", err)).Msg("")
+		logrus.WithError(err).Errorf("failed to stop http server")
 	}
 
 	// Wait for all goroutines to finish

pkg/metrics/metrics.go

@@ -22,6 +22,7 @@ type Metrics struct {
 	ValidatorProducedChunks *prometheus.GaugeVec
 	ValidatorSlashed        *prometheus.GaugeVec
 	ValidatorStake          *prometheus.GaugeVec
+	ValidatorRank           *prometheus.GaugeVec
 	VersionBuild            *prometheus.GaugeVec
 }
 
@@ -117,6 +118,12 @@ func New(namespace string) *Metrics {
 			Help:      "Current amount of validator stake"},
 			[]string{"account_id", "public_key", "epoch_start_height", "tracked"},
 		),
+		ValidatorRank: prometheus.NewGaugeVec(prometheus.GaugeOpts{
+			Namespace: namespace,
+			Name:      "validator_rank",
+			Help:      "Current rank of validator based on stake"},
+			[]string{"account_id", "public_key", "epoch_start_height", "tracked"},
+		),
 		VersionBuild: prometheus.NewGaugeVec(prometheus.GaugeOpts{
 			Namespace: namespace,
 			Name:      "version_build",
@@ -146,5 +153,6 @@ func (m *Metrics) Register(reg prometheus.Registerer) {
 	reg.MustRegister(m.ValidatorProducedChunks)
 	reg.MustRegister(m.ValidatorSlashed)
 	reg.MustRegister(m.ValidatorStake)
+	reg.MustRegister(m.ValidatorRank)
 	reg.MustRegister(m.VersionBuild)
 }

pkg/near/validators.go

@@ -1,6 +1,10 @@
 package near
 
-import "context"
+import (
+	"context"
+
+	"github.com/shopspring/decimal"
+)
 
 type ValidatorsResponse struct {
 	CurrentValidators []struct {
@@ -29,9 +33,9 @@ type ValidatorsResponse struct {
 }
 
 type Validator struct {
-	AccountId string `json:"account_id"`
-	PublicKey string `json:"public_key"`
-	Stake     string `json:"stake"`
+	AccountId string          `json:"account_id"`
+	PublicKey string          `json:"public_key"`
+	Stake     decimal.Decimal `json:"stake"`
 }
 
 func (c *Client) Validators(ctx context.Context, params interface{}) (ValidatorsResponse, error) {

pkg/watcher/watcher.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"sort"
 	"strconv"
 	"strings"
 	"sync/atomic"
@@ -138,23 +139,28 @@ func (w *Watcher) collectValidators(ctx context.Context) (near.ValidatorsRespons
 
 	var seatPrice float64
 
-	for _, v := range validators.CurrentValidators {
-		isSlashed := 0
-		if v.IsSlashed {
-			isSlashed = 1
-		}
+	// Sort validators by stake to be able to calculate their rank
+	rankedValidator := validators.CurrentValidators
+	sort.SliceStable(rankedValidator, func(i, j int) bool {
+		return rankedValidator[i].Stake.GreaterThan(rankedValidator[j].Stake)
+	})
 
+	for i, v := range rankedValidator {
 		labels := []string{v.AccountId, v.PublicKey, labelEpochStartHeight, w.isTracked(v.AccountId)}
 
+		w.metrics.ValidatorRank.
+			WithLabelValues(v.AccountId, v.PublicKey, labelEpochStartHeight, w.isTracked(v.AccountId)).
+			Set(float64(i + 1))
+
 		w.metrics.ValidatorExpectedBlocks.WithLabelValues(labels...).Set(float64(v.NumExpectedBlocks))
 		w.metrics.ValidatorExpectedChunks.WithLabelValues(labels...).Set(float64(v.NumExpectedChunks))
 		w.metrics.ValidatorProducedBlocks.WithLabelValues(labels...).Set(float64(v.NumProducedBlocks))
 		w.metrics.ValidatorProducedChunks.WithLabelValues(labels...).Set(float64(v.NumProducedChunks))
 
-		w.metrics.ValidatorSlashed.WithLabelValues(labels...).Set(float64(isSlashed))
-		w.metrics.ValidatorStake.WithLabelValues(labels...).Set(float64(GetStakeFromString(v.Stake)))
+		w.metrics.ValidatorSlashed.WithLabelValues(labels...).Set(metrics.BoolToFloat64(v.IsSlashed))
+		w.metrics.ValidatorStake.WithLabelValues(labels...).Set(v.Stake.InexactFloat64())
 
-		t := GetStakeFromString(v.Stake)
+		t := v.Stake.InexactFloat64()
 		if seatPrice == 0 {
 			seatPrice = t
 		}
@@ -168,13 +174,13 @@ func (w *Watcher) collectValidators(ctx context.Context) (near.ValidatorsRespons
 	for _, v := range validators.NextValidators {
 		w.metrics.NextValidatorStake.
 			WithLabelValues(v.AccountId, v.PublicKey, labelEpochStartHeight, w.isTracked(v.AccountId)).
-			Set(float64(GetStakeFromString(v.Stake)))
+			Set(v.Stake.InexactFloat64())
 	}
 
 	for _, v := range validators.CurrentProposals {
 		w.metrics.CurrentProposals.
 			WithLabelValues(v.AccountId, v.PublicKey, labelEpochStartHeight, w.isTracked(v.AccountId)).
-			Set(float64(GetStakeFromString(v.Stake)))
+			Set(v.Stake.InexactFloat64())
 	}
 
 	for _, v := range validators.PrevEpochKickOut {