feat(dot/telemetry): implement substrate_number_leaves metrics (ChainSafe#1926)

Author: omar391

.gitignore

@@ -5,6 +5,7 @@
 *.idea
 *.vscode
 *.sublime
+*.devcontainer
 
 # Output of go coverage tool when used with LiteIDE
 *.out

dot/metrics/collector.go

@@ -65,7 +65,8 @@ func (c *Collector) AddGauge(g GaugeMetrics) {
 }
 
 func (c *Collector) startCollectGauges() {
-	t := time.NewTicker(Refresh)
+	//TODO: Should we better add individual RefreshInterval for each `GaugeMetrics`or `label inside the gauges map`?
+	t := time.NewTicker(RefreshInterval)
 	defer func() {
 		t.Stop()
 		c.wg.Done()
@@ -89,6 +90,7 @@ func (c *Collector) startCollectGauges() {
 }
 
 func (c *Collector) startCollectProccessMetrics() {
+	//TODO: Should we better add individual RefreshInterval for each `GaugeMetrics`or `label inside the gauges map`?
 	cpuStats := make([]*ethmetrics.CPUStats, 2)
 	memStats := make([]*runtime.MemStats, 2)
 	for i := 0; i < len(memStats); i++ {
@@ -110,7 +112,7 @@ func (c *Collector) startCollectProccessMetrics() {
 		memUsed   = ethmetrics.GetOrRegisterGauge("system/memory/used", ethmetrics.DefaultRegistry)
 	)
 
-	t := time.NewTicker(Refresh)
+	t := time.NewTicker(RefreshInterval)
 	defer func() {
 		t.Stop()
 		c.wg.Done()

dot/metrics/metrics.go

@@ -29,9 +29,9 @@ import (
 var logger = log.New("pkg", "metrics")
 
 const (
-	// Refresh is the refresh time for publishing metrics.
-	Refresh     = time.Second * 10
-	refreshFreq = int64(Refresh / time.Second)
+	// RefreshInterval is the refresh time for publishing metrics.
+	RefreshInterval = time.Second * 10
+	refreshFreq     = int64(RefreshInterval / time.Second)
 )
 
 // PublishMetrics function will export the /metrics endpoint to prometheus process

dot/network/service.go

@@ -301,7 +301,7 @@ func (s *Service) collectNetworkMetrics() {
 			syncedBlocks.Update(num.Int64())
 		}
 
-		time.Sleep(gssmrmetrics.Refresh)
+		time.Sleep(gssmrmetrics.RefreshInterval)
 	}
 }
 
@@ -713,13 +713,11 @@ func (s *Service) NodeRoles() byte {
 	return s.cfg.Roles
 }
 
-// CollectGauge will be used to collect coutable metrics from network service
+// CollectGauge will be used to collect countable metrics from network service
 func (s *Service) CollectGauge() map[string]int64 {
 	var isSynced int64
 	if !s.syncer.IsSynced() {
 		isSynced = 1
-	} else {
-		isSynced = 0
 	}
 
 	return map[string]int64{

dot/node.go

@@ -212,7 +212,7 @@ func LoadGlobalNodeName(basepath string) (nodename string, err error) {
 // NewNode creates a new dot node from a dot node configuration
 func NewNode(cfg *Config, ks *keystore.GlobalKeystore, stopFunc func()) (*Node, error) {
 	// set garbage collection percent to 10%
-	// can be overwritten by setting the GOGC env veriable, which defaults to 100
+	// can be overwritten by setting the GOGC env variable, which defaults to 100
 	prev := debug.SetGCPercent(10)
 	if prev != 100 {
 		debug.SetGCPercent(prev)

dot/state/service.go

@@ -32,8 +32,11 @@ import (
 	log "github.com/ChainSafe/log15"
 )
 
-const readyPoolTransactionsMetrics = "gossamer/ready/pool/transaction/metrics"
-const readyPriorityQueueTransactions = "gossamer/ready/queue/transaction/metrics"
+const (
+	readyPoolTransactionsMetrics   = "gossamer/ready/pool/transaction/metrics"
+	readyPriorityQueueTransactions = "gossamer/ready/queue/transaction/metrics"
+	substrateNumberLeaves          = "gossamer/substrate_number_leaves/metrics"
+)
 
 var logger = log.New("pkg", "state")
 
@@ -358,5 +361,6 @@ func (s *Service) CollectGauge() map[string]int64 {
 	return map[string]int64{
 		readyPoolTransactionsMetrics:   int64(s.Transaction.pool.Len()),
 		readyPriorityQueueTransactions: int64(s.Transaction.queue.Len()),
+		substrateNumberLeaves:          int64(len(s.Block.Leaves())),
 	}
 }

dot/state/service_test.go

@@ -416,6 +416,7 @@ func TestStateServiceMetrics(t *testing.T) {
 	ethmetrics.Enabled = true
 	serv := NewService(config)
 	serv.Transaction = NewTransactionState()
+	serv.Block = newTestBlockState(t, testGenesisHeader)
 
 	m := metrics.NewCollector(context.Background())
 	m.AddGauge(serv)
@@ -440,7 +441,7 @@ func TestStateServiceMetrics(t *testing.T) {
 		hashes[i] = h
 	}
 
-	time.Sleep(time.Second + metrics.Refresh)
+	time.Sleep(time.Second + metrics.RefreshInterval)
 	gpool := ethmetrics.GetOrRegisterGauge(readyPoolTransactionsMetrics, nil)
 	gqueue := ethmetrics.GetOrRegisterGauge(readyPriorityQueueTransactions, nil)
 
@@ -450,7 +451,7 @@ func TestStateServiceMetrics(t *testing.T) {
 	serv.Transaction.pool.Remove(hashes[0])
 	serv.Transaction.queue.Pop()
 
-	time.Sleep(time.Second + metrics.Refresh)
+	time.Sleep(time.Second + metrics.RefreshInterval)
 	require.Equal(t, int64(1), gpool.Value())
 	require.Equal(t, int64(1), gqueue.Value())
 }

lib/grandpa/grandpa_test.go

@@ -1274,7 +1274,7 @@ func TestFinalRoundGaugeMetric(t *testing.T) {
 
 	go coll.Start()
 
-	time.Sleep(metrics.Refresh + time.Second)
+	time.Sleep(metrics.RefreshInterval + time.Second)
 	gauge := ethmetrics.GetOrRegisterGauge(finalityGrandpaRoundMetrics, nil)
 	require.Equal(t, gauge.Value(), int64(180))
 }

scripts/ci.go

@@ -14,6 +14,7 @@
 // You should have received a copy of the GNU Lesser General Public License
 // along with the gossamer library. If not, see <http://www.gnu.org/licenses/>.
 
+//go:build none
 // +build none
 
 package main