Merge pull request #18 from ethpandaops/feat/rm-client-name-override

feat(meta): Always use hashed node id in meta.client.name

cmd/sentry/main.go

@@ -31,7 +31,6 @@ var log = logrus.New()
 type contributoor struct {
 	log           logrus.FieldLogger
 	config        *config.Config
-	name          string
 	beaconNode    *ethereum.BeaconNode
 	clockDrift    clockdrift.ClockDrift
 	sinks         []sinks.ContributoorSink
@@ -147,7 +146,6 @@ func main() {
 
 			s.log.WithFields(logrus.Fields{
 				"config_path": s.config.ContributoorDirectory,
-				"name":        s.name,
 				"version":     s.config.Version,
 				"commit":      contr.GitCommit,
 				"release":     contr.Release,
@@ -237,7 +235,6 @@ func newContributoor(c *cli.Context) (*contributoor, error) {
 	return &contributoor{
 		log:    log.WithField("module", "contributoor"),
 		config: cfg,
-		name:   strings.ToLower(cfg.NetworkName.DisplayName()),
 	}, nil
 }
 
@@ -376,15 +373,15 @@ func (s *contributoor) initClockDrift(ctx context.Context) error {
 
 func (s *contributoor) initSinks(ctx context.Context, debug bool) error {
 	if debug {
-		stdoutSink, err := sinks.NewStdoutSink(log, s.config, s.name)
+		stdoutSink, err := sinks.NewStdoutSink(log, s.config, s.config.NetworkName.DisplayName())
 		if err != nil {
 			return err
 		}
 
 		s.sinks = append(s.sinks, stdoutSink)
 	}
 
-	xatuSink, err := sinks.NewXatuSink(log, s.config, s.name)
+	xatuSink, err := sinks.NewXatuSink(log, s.config, s.config.NetworkName.DisplayName())
 	if err != nil {
 		return err
 	}
@@ -423,9 +420,8 @@ func (s *contributoor) initBeaconNode() error {
 		s.log,
 		&ethereum.Config{
 			BeaconNodeAddress:   s.config.BeaconNodeAddress,
-			OverrideNetworkName: s.name,
+			OverrideNetworkName: strings.ToLower(s.config.NetworkName.DisplayName()),
 		},
-		s.name,
 		s.sinks,
 		s.clockDrift,
 		s.cache,

pkg/ethereum/beacon.go

@@ -26,7 +26,6 @@ import (
 type BeaconNode struct {
 	config      *Config
 	log         logrus.FieldLogger
-	name        string
 	beacon      beacon.Node
 	clockDrift  clockdrift.ClockDrift
 	metadataSvc *services.MetadataService
@@ -41,7 +40,6 @@ type BeaconNode struct {
 func NewBeaconNode(
 	log logrus.FieldLogger,
 	config *Config,
-	name string,
 	sinks []sinks.ContributoorSink,
 	clockDrift clockdrift.ClockDrift,
 	cache *events.DuplicateCache,
@@ -77,7 +75,6 @@ func NewBeaconNode(
 
 	// Create the beacon node.
 	node := beacon.NewNode(log, &beacon.Config{
-		Name:    name,
 		Addr:    config.BeaconNodeAddress,
 		Headers: config.BeaconNodeHeaders,
 	}, "contributoor", opts)
@@ -88,7 +85,6 @@ func NewBeaconNode(
 	return &BeaconNode{
 		log:         log.WithField("module", "contributoor/ethereum/beacon"),
 		config:      config,
-		name:        name,
 		beacon:      node,
 		clockDrift:  clockDrift,
 		metadataSvc: &metadata,
@@ -402,14 +398,9 @@ func (b *BeaconNode) createEventMeta(ctx context.Context) (*xatu.Meta, error) {
 		}
 	}
 
-	clientName := b.name
-	if clientName == "" {
-		hashed, err := b.metadataSvc.NodeIDHash()
-		if err != nil {
-			return nil, err
-		}
-
-		clientName = hashed
+	hashed, err := b.metadataSvc.NodeIDHash()
+	if err != nil {
+		return nil, err
 	}
 
 	// TODO(@matty):
@@ -418,7 +409,7 @@ func (b *BeaconNode) createEventMeta(ctx context.Context) (*xatu.Meta, error) {
 	//nolint:gosec // fine for clock drift.
 	return &xatu.Meta{
 		Client: &xatu.ClientMeta{
-			Name:           clientName,
+			Name:           hashed,
 			Version:        contributoor.Short(),
 			Id:             uuid.New().String(),
 			Implementation: contributoor.Implementation,