Refactor Execution Client Status metric

ssvlabs · Nov 15, 2024 · 40b1abe · 40b1abe
1 parent b63b0b1
commit 40b1abe
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 17 deletions.
diff --git a/eth/executionclient/execution_client.go b/eth/executionclient/execution_client.go
@@ -231,10 +231,7 @@ func (ec *ExecutionClient) Healthy(ctx context.Context) error {
 	start := time.Now()
 	sp, err := ec.client.SyncProgress(ctx)
 	if err != nil {
-		clientStatusGauge.Record(ctx, 1,
-			metric.WithAttributes(executionClientAddrAttribute(ec.nodeAddr)),
-			metric.WithAttributes(executionClientStatusAttribute(statusFailure)),
-		)
+		recordExecutionClientStatus(ctx, statusFailure, ec.nodeAddr)
 
 		return err
 	}
@@ -244,10 +241,8 @@ func (ec *ExecutionClient) Healthy(ctx context.Context) error {
 	)
 
 	if sp != nil {
-		clientStatusGauge.Record(ctx, 1,
-			metric.WithAttributes(executionClientAddrAttribute(ec.nodeAddr)),
-			metric.WithAttributes(executionClientStatusAttribute(statusSyncing)),
-		)
+		recordExecutionClientStatus(ctx, statusSyncing, ec.nodeAddr)
+
 		syncingDistance := sp.HighestBlock - sp.CurrentBlock
 		if syncingDistance <= math.MaxInt64 {
 			syncingDistanceGauge.Record(ctx, int64(syncingDistance), metric.WithAttributes(executionClientAddrAttribute(ec.nodeAddr)))
@@ -256,10 +251,8 @@ func (ec *ExecutionClient) Healthy(ctx context.Context) error {
 		return fmt.Errorf("syncing")
 	}
 
-	clientStatusGauge.Record(ctx, 1,
-		metric.WithAttributes(executionClientAddrAttribute(ec.nodeAddr)),
-		metric.WithAttributes(executionClientStatusAttribute(statusReady)),
-	)
+	recordExecutionClientStatus(ctx, statusReady, ec.nodeAddr)
+
 	syncingDistanceGauge.Record(ctx, 0, metric.WithAttributes(executionClientAddrAttribute(ec.nodeAddr)))
 
 	return nil

diff --git a/eth/executionclient/observability.go b/eth/executionclient/observability.go
@@ -1,6 +1,7 @@
 package executionclient
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/ssvlabs/ssv/observability"
@@ -17,14 +18,13 @@ const (
 type executionClientStatus string
 
 const (
-	statusSyncing = "syncing"
-	statusFailure = "failure"
-	statusReady   = "ready"
+	statusSyncing executionClientStatus = "syncing"
+	statusFailure executionClientStatus = "failure"
+	statusReady   executionClientStatus = "ready"
 )
 
 var (
-	meter = otel.Meter(observabilityComponentName)
-
+	meter            = otel.Meter(observabilityComponentName)
 	latencyHistogram = observability.GetMetric(
 		fmt.Sprintf("%s.latency.duration", observabilityComponentNamespace),
 		func(metricName string) (metric.Float64Histogram, error) {
@@ -76,3 +76,23 @@ func executionClientStatusAttribute(value executionClientStatus) attribute.KeyVa
 	eventNameAttrName := fmt.Sprintf("%s.status", observabilityComponentNamespace)
 	return attribute.String(eventNameAttrName, string(value))
 }
+
+func recordExecutionClientStatus(ctx context.Context, status executionClientStatus, nodeAddr string) {
+	clientStatusGauge.Record(ctx, 0,
+		metric.WithAttributes(executionClientAddrAttribute(nodeAddr)),
+		metric.WithAttributes(executionClientStatusAttribute(statusReady)),
+	)
+	clientStatusGauge.Record(ctx, 0,
+		metric.WithAttributes(executionClientAddrAttribute(nodeAddr)),
+		metric.WithAttributes(executionClientStatusAttribute(statusSyncing)),
+	)
+	clientStatusGauge.Record(ctx, 0,
+		metric.WithAttributes(executionClientAddrAttribute(nodeAddr)),
+		metric.WithAttributes(executionClientStatusAttribute(statusFailure)),
+	)
+
+	clientStatusGauge.Record(ctx, 1,
+		metric.WithAttributes(executionClientAddrAttribute(nodeAddr)),
+		metric.WithAttributes(executionClientStatusAttribute(status)),
+	)
+}