metrics

Author: calbera

mod/node-core/pkg/components/block_store.go

@@ -26,6 +26,7 @@ import (
 	blockservice "github.com/berachain/beacon-kit/mod/beacon/block_store"
 	"github.com/berachain/beacon-kit/mod/config"
 	"github.com/berachain/beacon-kit/mod/log"
+	"github.com/berachain/beacon-kit/mod/node-core/pkg/components/metrics"
 	"github.com/berachain/beacon-kit/mod/node-core/pkg/components/storage"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
 	"github.com/berachain/beacon-kit/mod/storage/pkg/block"
@@ -42,9 +43,10 @@ type BlockStoreInput[
 ] struct {
 	depinject.In
 
-	AppOpts   servertypes.AppOptions
-	ChainSpec common.ChainSpec
-	Logger    LoggerT
+	AppOpts       servertypes.AppOptions
+	ChainSpec     common.ChainSpec
+	Logger        LoggerT
+	TelemetrySink *metrics.TelemetrySink
 }
 
 // ProvideBlockStore is a function that provides the module to the
@@ -64,6 +66,7 @@ func ProvideBlockStore[
 		storage.NewKVStoreProvider(kvp),
 		in.ChainSpec,
 		in.Logger.With("service", manager.BlockStoreName),
+		in.TelemetrySink,
 	), nil
 }
 

mod/storage/pkg/block/metrics.go

@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2024, Berachain Foundation. All rights reserved.
+// Use of this software is governed by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package block
+
+// storeMetrics is a struct that contains metrics for the block store.
+type storeMetrics struct {
+	// sink is the sink for the metrics.
+	sink TelemetrySink
+}
+
+// newStoreMetrics creates a new storeMetrics.
+func newStoreMetrics(sink TelemetrySink) *storeMetrics {
+	return &storeMetrics{
+		sink: sink,
+	}
+}
+
+// markPruneBlockFailure marks a block prune failure.
+func (sm *storeMetrics) markPruneBlockFailure(err error) {
+	var labels []string
+	if err != nil {
+		labels = append(labels, "reason", "error")
+	} else {
+		labels = append(labels, "reason", "panic")
+	}
+
+	sm.sink.IncrementCounter(
+		"beacon_kit.block-store.prune_block_failure", labels...,
+	)
+}

mod/storage/pkg/block/store.go

@@ -45,13 +45,15 @@ type KVStore[BeaconBlockT BeaconBlock[BeaconBlockT]] struct {
 	cs         common.ChainSpec
 	blockCodec *encoding.SSZInterfaceCodec[BeaconBlockT]
 	logger     log.Logger[any]
+	metrics    *storeMetrics
 }
 
 // NewStore creates a new block store.
 func NewStore[BeaconBlockT BeaconBlock[BeaconBlockT]](
 	kvsp store.KVStoreService,
 	cs common.ChainSpec,
 	logger log.Logger[any],
+	ts TelemetrySink,
 ) *KVStore[BeaconBlockT] {
 	schemaBuilder := sdkcollections.NewSchemaBuilder(kvsp)
 	blockCodec := &encoding.SSZInterfaceCodec[BeaconBlockT]{}
@@ -67,6 +69,7 @@ func NewStore[BeaconBlockT BeaconBlock[BeaconBlockT]](
 		blockCodec: blockCodec,
 		cs:         cs,
 		logger:     logger,
+		metrics:    newStoreMetrics(ts),
 	}
 }
 
@@ -112,7 +115,7 @@ func (kv *KVStore[BeaconBlockT]) Prune(start, end uint64) error {
 func (kv *KVStore[BeaconBlockT]) prune(ctx context.Context, slot math.Slot) {
 	defer func() {
 		if r := recover(); r != nil {
-			// TODO: add metrics here.
+			kv.metrics.markPruneBlockFailure(nil)
 			kv.logger.Warn(
 				"‼️ panic occurred while pruning block",
 				"slot", slot, "panic", r, "stack", debug.Stack(),
@@ -130,8 +133,7 @@ func (kv *KVStore[BeaconBlockT]) prune(ctx context.Context, slot math.Slot) {
 			//    case, we choose not to retry removal and instead
 			//    continue. This means this slot may never be pruned, but
 			//    ensures that we always get to pruning subsequent slots.
-			//
-			// TODO: add metrics here.
+			kv.metrics.markPruneBlockFailure(err)
 			kv.logger.Warn(
 				"‼️ failed to prune block", "slot", slot, "error", err,
 			)

mod/storage/pkg/block/types.go

@@ -21,6 +21,8 @@
 package block
 
 import (
+	"time"
+
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/constraints"
 	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
@@ -36,3 +38,14 @@ type BeaconBlock[T any] interface {
 	SetStateRoot(root common.Root)
 	GetStateRoot() common.Root
 }
+
+// TelemetrySink is an interface for sending metrics to a telemetry backend.
+type TelemetrySink interface {
+	// IncrementCounter increments the counter identified by
+	// the provided key.
+	IncrementCounter(key string, args ...string)
+
+	// MeasureSince measures the time since the provided start time,
+	// identified by the provided keys.
+	MeasureSince(key string, start time.Time, args ...string)
+}