add publisher balance metric

Author: Richard Patel

balance.go

@@ -0,0 +1,50 @@
+package main
+
+import (
+	"context"
+	"time"
+
+	"github.com/gagliardetto/solana-go"
+	"github.com/gagliardetto/solana-go/rpc"
+	"github.com/prometheus/client_golang/prometheus"
+	"go.blockdaemon.com/pyth_exporter/metrics"
+	"go.uber.org/zap"
+)
+
+type balanceScraper struct {
+	*prometheus.GaugeVec
+
+	log        *zap.Logger
+	rpc        *rpc.Client
+	publishers []solana.PublicKey
+}
+
+func newBalanceScraper(publishers []solana.PublicKey, rpcURL string, log *zap.Logger) *balanceScraper {
+	return &balanceScraper{
+		GaugeVec:   metrics.PublisherBalances,
+		rpc:        rpc.New(rpcURL),
+		log:        log,
+		publishers: publishers,
+	}
+}
+
+func (b *balanceScraper) Collect(metrics chan<- prometheus.Metric) {
+	const collectTimeout = 5 * time.Second
+	ctx, cancel := context.WithTimeout(context.Background(), collectTimeout)
+	defer cancel()
+	b.update(ctx)
+	b.GaugeVec.Collect(metrics)
+}
+
+func (b *balanceScraper) update(ctx context.Context) {
+	res, err := b.rpc.GetMultipleAccounts(ctx, b.publishers...)
+	if err != nil {
+		b.log.Warn("Failed to check publisher SOL balances", zap.Error(err))
+		return
+	}
+	for i, acc := range res.Value {
+		b.GaugeVec.
+			WithLabelValues(b.publishers[i].String()).
+			Set(float64(acc.Lamports))
+	}
+}

main.go

@@ -130,6 +130,10 @@ func main() {
 		return nil
 	})
 
+	// Scrape publisher balances.
+	balances := newBalanceScraper(publishKeys.pubkeys, *rpcURL, log.Named("balances"))
+	metrics.Registry.MustRegister(balances)
+
 	if err := group.Wait(); err != nil {
 		log.Fatal("App crashed", zap.Error(err))
 	}

metrics/metrics.go

@@ -6,10 +6,11 @@ import (
 )
 
 const (
-	promNamespace = "pyth"
+	Namespace = "pyth"
 
-	promSubsystemExporter = "exporter"
-	promSubsystemOracle   = "oracle"
+	SubsystemExporter = "exporter"
+	SubsystemSolana   = "solana"
+	SubsystemOracle   = "oracle"
 )
 
 // Prometheus metric labels.
@@ -31,69 +32,70 @@ const (
 var (
 	// RPC request stats
 	rpcRequestsTotal = factory.NewCounterVec(prometheus.CounterOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemExporter,
+		Namespace: Namespace,
+		Subsystem: SubsystemExporter,
 		Name:      "rpc_requests_total",
 		Help:      "Number of outgoing RPC requests from pyth_exporter to RPC nodes",
 	}, []string{})
 	WsActiveConns = factory.NewGauge(prometheus.GaugeOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemExporter,
+		Namespace: Namespace,
+		Subsystem: SubsystemExporter,
 		Name:      "ws_active_conns",
 		Help:      "Number of active WebSockets between pyth_exporter and RPC nodes",
 	})
 	WsEventsTotal = factory.NewCounter(prometheus.CounterOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemExporter,
+		Namespace: Namespace,
+		Subsystem: SubsystemExporter,
 		Name:      "ws_events_total",
 		Help:      "Number of WebSocket events delivered from RPC nodes to pyth_exporter",
 	})
 
-	// Publisher Observables
-	publisherBalances = prometheus.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: promNamespace,
+	PublisherBalances = prometheus.NewGaugeVec(prometheus.GaugeOpts{
+		Namespace: Namespace,
+		Subsystem: SubsystemSolana,
 		Name:      "publish_account_balance",
 		Help:      "SOL balance of Pyth publish account in lamports",
 	}, []string{labelPublisher})
+
 	AggPrice = factory.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemOracle,
+		Namespace: Namespace,
+		Subsystem: SubsystemOracle,
 		Name:      "aggregated_price",
 		Help:      "Last aggregated price of Pyth product",
 	}, []string{labelProduct})
 	AggConf = factory.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemOracle,
+		Namespace: Namespace,
+		Subsystem: SubsystemOracle,
 		Name:      "aggregated_conf_amount",
 		Help:      "Last aggregated conf of Pyth product",
 	}, []string{labelProduct})
 	PublisherPrice = factory.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemOracle,
+		Namespace: Namespace,
+		Subsystem: SubsystemOracle,
 		Name:      "publisher_price",
 		Help:      "Last published product price by Pyth publisher",
 	}, []string{labelProduct, labelPublisher})
 	PublisherConf = factory.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemOracle,
+		Namespace: Namespace,
+		Subsystem: SubsystemOracle,
 		Name:      "publisher_conf_amount",
 		Help:      "Last published product confidence by Pyth publisher",
 	}, []string{labelProduct, labelPublisher})
 	PublisherSlot = factory.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: promNamespace,
-		Subsystem: promSubsystemOracle,
+		Namespace: Namespace,
+		Subsystem: SubsystemOracle,
 		Name:      "publisher_slot",
 		Help:      "Last observed slot for Pyth publisher",
 	}, []string{labelProduct, labelPublisher})
 
 	// Publisher Observers
 	metricTxFeesTotal = factory.NewCounterVec(prometheus.CounterOpts{
-		Namespace: promNamespace,
+		Namespace: Namespace,
 		Name:      "tx_fees_total",
 		Help:      "Approximate amount of SOL in lamports spent on Pyth publishing",
 	}, []string{labelPublisher})
 	metricTxCount = factory.NewCounterVec(prometheus.CounterOpts{
-		Namespace: promNamespace,
+		Namespace: Namespace,
 		Name:      "txs_total",
 		Help:      "Approximate number of Pyth transactions sent",
 	}, []string{labelPublisher, labelTxStatus})