chore(metrics): Allow telemetry to be registered to the baseapp and o…

…n sdk.Context (#102)

* bet

* default to no-op metrics

baseapp/baseapp.go

@@ -7,6 +7,7 @@ import (
 	"github.com/berachain/offchain-sdk/job"
 	"github.com/berachain/offchain-sdk/log"
 	"github.com/berachain/offchain-sdk/server"
+	"github.com/berachain/offchain-sdk/telemetry"
 
 	ethdb "github.com/ethereum/go-ethereum/ethdb"
 )
@@ -34,6 +35,7 @@ func New(
 	jobs []job.Basic,
 	db ethdb.KeyValueStore,
 	svr *server.Server,
+	metrics telemetry.Metrics,
 ) *BaseApp {
 	return &BaseApp{
 		name:   name,
@@ -44,6 +46,7 @@ func New(
 				connPool: ethClient,
 				logger:   logger,
 				db:       db,
+				metrics:  metrics,
 			},
 		),
 		svr: svr,

baseapp/builder.go

@@ -7,6 +7,7 @@ import (
 	"github.com/berachain/offchain-sdk/job"
 	"github.com/berachain/offchain-sdk/log"
 	"github.com/berachain/offchain-sdk/server"
+	"github.com/berachain/offchain-sdk/telemetry"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 
 	ethdb "github.com/ethereum/go-ethereum/ethdb"
@@ -19,13 +20,15 @@ type AppBuilder struct {
 	db        ethdb.KeyValueStore
 	ethClient eth.Client
 	svr       *server.Server
+	metrics   telemetry.Metrics
 }
 
 // NewAppBuilder creates a new app builder.
 func NewAppBuilder(appName string) *AppBuilder {
 	return &AppBuilder{
 		appName: appName,
 		jobs:    []job.Basic{},
+		metrics: telemetry.NewNoopMetrics(),
 	}
 }
 
@@ -44,6 +47,13 @@ func (ab *AppBuilder) RegisterDB(db ethdb.KeyValueStore) {
 	ab.db = db
 }
 
+// RegisterMetrics registers the metrics.
+func (ab *AppBuilder) RegisterMetrics(cfg *telemetry.Config) error {
+	var err error
+	ab.metrics, err = telemetry.NewMetrics(cfg)
+	return err
+}
+
 // RegisterHTTPServer registers the http server.
 func (ab *AppBuilder) RegisterHTTPServer(svr *server.Server) {
 	ab.svr = svr
@@ -95,5 +105,6 @@ func (ab *AppBuilder) BuildApp(
 		ab.jobs,
 		ab.db,
 		ab.svr,
+		ab.metrics,
 	)
 }

baseapp/context.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/berachain/offchain-sdk/client/eth"
 	"github.com/berachain/offchain-sdk/log"
+	"github.com/berachain/offchain-sdk/telemetry"
 	sdk "github.com/berachain/offchain-sdk/types"
 
 	ethdb "github.com/ethereum/go-ethereum/ethdb"
@@ -15,6 +16,7 @@ type contextFactory struct {
 	connPool eth.Client
 	logger   log.Logger
 	db       ethdb.KeyValueStore
+	metrics  telemetry.Metrics
 }
 
 // NewContextFactory creates a new context from a given context.Context.
@@ -24,5 +26,6 @@ func (cf *contextFactory) NewSDKContext(ctx context.Context) *sdk.Context {
 		cf.connPool,
 		cf.logger,
 		cf.db,
+		cf.metrics,
 	)
 }

core/transactor/factory/batcher/batcher_test.go

@@ -36,6 +36,6 @@ func setUp(t *testing.T) *sdk.Context {
 	}
 	return sdk.NewContext(
 		ctx, eth.NewExtendedEthClient(chain, 5*time.Second),
-		log.NewLogger(os.Stdout, "test-runner"), nil,
+		log.NewLogger(os.Stdout, "test-runner"), nil, nil,
 	)
 }

telemetry/metrics.go

@@ -37,6 +37,11 @@ func NewMetrics(cfg *Config) (Metrics, error) {
 	return m, nil
 }
 
+// NewNoopMetrics returns a new Metrics instance with no-op implementations.
+func NewNoopMetrics() Metrics {
+	return &metrics{}
+}
+
 type metrics struct {
 	datadog    Metrics
 	prometheus Metrics

types/context.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/berachain/offchain-sdk/client/eth"
 	"github.com/berachain/offchain-sdk/log"
+	"github.com/berachain/offchain-sdk/telemetry"
 
 	"github.com/ethereum/go-ethereum/ethdb"
 )
@@ -15,9 +16,10 @@ type CancellableContext interface {
 
 type Context struct {
 	context.Context
-	chain  eth.Client
-	logger log.Logger
-	db     ethdb.KeyValueStore
+	chain   eth.Client
+	logger  log.Logger
+	db      ethdb.KeyValueStore
+	metrics telemetry.Metrics
 }
 
 // UnwrapContext unwraps the sdk context.
@@ -30,13 +32,18 @@ func UnwrapContext(ctx context.Context) *Context {
 }
 
 func NewContext(
-	ctx context.Context, ethClient eth.Client, logger log.Logger, db ethdb.KeyValueStore,
+	ctx context.Context,
+	ethClient eth.Client,
+	logger log.Logger,
+	db ethdb.KeyValueStore,
+	metrics telemetry.Metrics,
 ) *Context {
 	return &Context{
 		Context: ctx,
 		chain:   ethClient,
 		logger:  logger,
 		db:      db,
+		metrics: metrics,
 	}
 }
 
@@ -51,3 +58,7 @@ func (c *Context) Logger() log.Logger {
 func (c *Context) DB() ethdb.KeyValueStore {
 	return c.db
 }
+
+func (c *Context) Metrics() telemetry.Metrics {
+	return c.metrics
+}