Merge pull request #3586 from filecoin-project/feat/expected-height-m…

…etric metrics: add expected height metric
filecoin-project · Sep 7, 2020 · 758aae8 · 758aae8
2 parents ffbbd96 + f6f5405
commit 758aae8
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/chain/sync.go b/chain/sync.go
@@ -125,6 +125,8 @@ type Syncer struct {
 	verifier ffiwrapper.Verifier
 
 	windowSize int
+
+	tickerCtxCancel context.CancelFunc
 }
 
 // NewSyncer creates a new Syncer object.
@@ -166,11 +168,35 @@ func NewSyncer(sm *stmgr.StateManager, bsync *blocksync.BlockSync, connmgr connm
 }
 
 func (syncer *Syncer) Start() {
+	tickerCtx, tickerCtxCancel := context.WithCancel(context.Background())
 	syncer.syncmgr.Start()
+
+	syncer.tickerCtxCancel = tickerCtxCancel
+
+	go syncer.runMetricsTricker(tickerCtx)
+}
+
+func (syncer *Syncer) runMetricsTricker(tickerCtx context.Context) {
+	genesisTime := time.Unix(int64(syncer.Genesis.MinTimestamp()), 0)
+	ticker := build.Clock.Ticker(time.Duration(build.BlockDelaySecs) * time.Second)
+	defer ticker.Stop()
+
+	for {
+		select {
+		case <-ticker.C:
+			sinceGenesis := build.Clock.Now().Sub(genesisTime)
+			expectedHeight := int64(sinceGenesis.Seconds()) / int64(build.BlockDelaySecs)
+
+			stats.Record(tickerCtx, metrics.ChainNodeHeightExpected.M(expectedHeight))
+		case <-tickerCtx.Done():
+			return
+		}
+	}
 }
 
 func (syncer *Syncer) Stop() {
 	syncer.syncmgr.Stop()
+	syncer.tickerCtxCancel()
 }
 
 // InformNewHead informs the syncer about a new potential tipset

diff --git a/metrics/metrics.go b/metrics/metrics.go
@@ -30,6 +30,7 @@ var (
 var (
 	LotusInfo                           = stats.Int64("info", "Arbitrary counter to tag lotus info to", stats.UnitDimensionless)
 	ChainNodeHeight                     = stats.Int64("chain/node_height", "Current Height of the node", stats.UnitDimensionless)
+	ChainNodeHeightExpected             = stats.Int64("chain/node_height_expected", "Expected Height of the node", stats.UnitDimensionless)
 	ChainNodeWorkerHeight               = stats.Int64("chain/node_worker_height", "Current Height of workers on the node", stats.UnitDimensionless)
 	MessagePublished                    = stats.Int64("message/published", "Counter for total locally published messages", stats.UnitDimensionless)
 	MessageReceived                     = stats.Int64("message/received", "Counter for total received messages", stats.UnitDimensionless)
@@ -62,6 +63,10 @@ var (
 		Measure:     ChainNodeHeight,
 		Aggregation: view.LastValue(),
 	}
+	ChainNodeHeightExpectedView = &view.View{
+		Measure:     ChainNodeHeightExpected,
+		Aggregation: view.LastValue(),
+	}
 	ChainNodeWorkerHeightView = &view.View{
 		Measure:     ChainNodeWorkerHeight,
 		Aggregation: view.LastValue(),
@@ -138,6 +143,7 @@ var (
 var DefaultViews = append([]*view.View{
 	InfoView,
 	ChainNodeHeightView,
+	ChainNodeHeightExpectedView,
 	ChainNodeWorkerHeightView,
 	BlockReceivedView,
 	BlockValidationFailureView,