feat(store/v2): basic metrics

store/metrics/metrics.go

@@ -0,0 +1,42 @@
+package metrics
+
+import (
+	"time"
+
+	"github.com/hashicorp/go-metrics"
+)
+
+var _ StoreMetrics = Metrics{}
+
+// StoreMetrics defines the set of supported metric APIs for the store package.
+type StoreMetrics interface {
+	MeasureSince(start time.Time, keys ...string)
+}
+
+// Metrics defines a default StoreMetrics implementation.
+type Metrics struct {
+	Labels []metrics.Label
+}
+
+// NewMetrics returns a new instance of the Metrics with labels set by the node
+// operator.
+func NewMetrics(labels [][]string) Metrics {
+	m := Metrics{}
+
+	if numGlobalLabels := len(labels); numGlobalLabels > 0 {
+		parsedGlobalLabels := make([]metrics.Label, numGlobalLabels)
+		for i, label := range labels {
+			parsedGlobalLabels[i] = metrics.Label{Name: label[0], Value: label[1]}
+		}
+
+		m.Labels = parsedGlobalLabels
+	}
+
+	return m
+}
+
+// MeasureSince provides a wrapper functionality for emitting a time measure
+// metric with global labels (if any).
+func (m Metrics) MeasureSince(start time.Time, keys ...string) {
+	metrics.MeasureSinceWithLabels(keys, start.UTC(), m.Labels)
+}

store/root/store.go

@@ -5,13 +5,15 @@ import (
 	"fmt"
 	"io"
 	"slices"
+	"time"
 
 	"github.com/cockroachdb/errors"
 
 	"cosmossdk.io/log"
 	"cosmossdk.io/store/v2"
 	"cosmossdk.io/store/v2/kv/branch"
 	"cosmossdk.io/store/v2/kv/trace"
+	"cosmossdk.io/store/v2/metrics"
 	"cosmossdk.io/store/v2/pruning"
 )
 
@@ -57,13 +59,17 @@ type Store struct {
 
 	// pruningManager manages pruning of the SS and SC backends
 	pruningManager *pruning.Manager
+
+	// telemetry reflects a telemetry agent responsible for emitting metrics (if any)
+	telemetry metrics.StoreMetrics
 }
 
 func New(
 	logger log.Logger,
 	initVersion uint64,
 	ss store.VersionedDatabase,
 	sc store.Committer,
+	m metrics.StoreMetrics,
 ) (store.RootStore, error) {
 	rootKVStore, err := branch.New(defaultStoreKey, ss)
 	if err != nil {
@@ -79,6 +85,7 @@ func New(
 		stateCommitment: sc,
 		rootKVStore:     rootKVStore,
 		pruningManager:  pruningManager,
+		telemetry:       m,
 	}, nil
 }
 
@@ -158,6 +165,11 @@ func (s *Store) GetLatestVersion() (uint64, error) {
 }
 
 func (s *Store) Query(storeKey string, version uint64, key []byte, prove bool) (store.QueryResult, error) {
+	if s.telemetry != nil {
+		now := time.Now()
+		s.telemetry.MeasureSince(now, "root_store", "query")
+	}
+
 	val, err := s.stateStore.Get(storeKey, version, key)
 	if err != nil {
 		return store.QueryResult{}, err
@@ -202,6 +214,11 @@ func (s *Store) GetBranchedKVStore(_ string) store.BranchedKVStore {
 }
 
 func (s *Store) LoadLatestVersion() error {
+	if s.telemetry != nil {
+		now := time.Now()
+		s.telemetry.MeasureSince(now, "root_store", "load_latest_version")
+	}
+
 	lv, err := s.GetLatestVersion()
 	if err != nil {
 		return err
@@ -211,6 +228,11 @@ func (s *Store) LoadLatestVersion() error {
 }
 
 func (s *Store) LoadVersion(version uint64) error {
+	if s.telemetry != nil {
+		now := time.Now()
+		s.telemetry.MeasureSince(now, "root_store", "load_version")
+	}
+
 	return s.loadVersion(version)
 }
 
@@ -278,6 +300,11 @@ func (s *Store) Branch() store.BranchedRootStore {
 // by constructing a CommitInfo object, which in turn creates and writes a batch
 // of the current changeset to the SC tree.
 func (s *Store) WorkingHash() ([]byte, error) {
+	if s.telemetry != nil {
+		now := time.Now()
+		s.telemetry.MeasureSince(now, "root_store", "working_hash")
+	}
+
 	if s.workingHash == nil {
 		if err := s.writeSC(); err != nil {
 			return nil, err
@@ -302,6 +329,11 @@ func (s *Store) Write() {
 //
 // Note, Commit() commits SC and SC synchronously.
 func (s *Store) Commit() ([]byte, error) {
+	if s.telemetry != nil {
+		now := time.Now()
+		s.telemetry.MeasureSince(now, "root_store", "commit")
+	}
+
 	if s.workingHash == nil {
 		return nil, fmt.Errorf("working hash is nil; must call WorkingHash() before Commit()")
 	}

store/root/store_test.go

@@ -32,7 +32,7 @@ func (s *RootStoreTestSuite) SetupTest() {
 
 	sc := iavl.NewIavlTree(dbm.NewMemDB(), noopLog, iavl.DefaultConfig())
 
-	rs, err := New(noopLog, 1, ss, sc)
+	rs, err := New(noopLog, 1, ss, sc, nil)
 	s.Require().NoError(err)
 
 	rs.SetTracer(io.Discard)