Automation Telemetry: Send BlockNumber and Node Version

core/config/docs/core.toml

@@ -312,7 +312,7 @@ KeyBundleID = '7a5f66bbe6594259325bf2b4f5b1a9c900000000000000000000000000000000'
 # CaptureEATelemetry toggles collecting extra information from External Adaptares
 CaptureEATelemetry = false # Default
 # CaptureAutomationCustomTelemetry toggles collecting automation specific telemetry
-CaptureAutomationCustomTelemetry = false # Default
+CaptureAutomationCustomTelemetry = true # Default
 # DefaultTransactionQueueDepth controls the queue size for `DropOldestStrategy` in OCR2. Set to 0 to use `SendEvery` strategy instead.
 DefaultTransactionQueueDepth = 1 # Default
 # SimulateTransactions enables transaction simulation for OCR2.

core/services/chainlink/config_ocr2_test.go

@@ -38,7 +38,7 @@ func TestOCR2Config(t *testing.T) {
 	require.Equal(t, false, ocr2Cfg.TraceLogging())
 	require.Equal(t, uint32(1), ocr2Cfg.DefaultTransactionQueueDepth())
 	require.Equal(t, false, ocr2Cfg.CaptureEATelemetry())
-	require.Equal(t, false, ocr2Cfg.CaptureAutomationCustomTelemetry())
+	require.Equal(t, true, ocr2Cfg.CaptureAutomationCustomTelemetry())
 
 	keyBundleID, err := ocr2Cfg.KeyBundleID()
 	require.NoError(t, err)

core/services/chainlink/config_test.go

@@ -356,7 +356,7 @@ func TestConfig_Marshal(t *testing.T) {
 		DatabaseTimeout:                    models.MustNewDuration(8 * time.Second),
 		KeyBundleID:                        ptr(models.MustSha256HashFromHex("7a5f66bbe6594259325bf2b4f5b1a9c9")),
 		CaptureEATelemetry:                 ptr(false),
-		CaptureAutomationCustomTelemetry:   ptr(false),
+		CaptureAutomationCustomTelemetry:   ptr(true),
 		DefaultTransactionQueueDepth:       ptr[uint32](1),
 		SimulateTransactions:               ptr(false),
 		TraceLogging:                       ptr(false),
@@ -789,7 +789,7 @@ ContractTransmitterTransmitTimeout = '1m0s'
 DatabaseTimeout = '8s'
 KeyBundleID = '7a5f66bbe6594259325bf2b4f5b1a9c900000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

core/services/chainlink/testdata/config-empty-effective.toml

@@ -117,7 +117,7 @@ ContractTransmitterTransmitTimeout = '10s'
 DatabaseTimeout = '10s'
 KeyBundleID = '0000000000000000000000000000000000000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

core/services/chainlink/testdata/config-full.toml

@@ -123,7 +123,7 @@ ContractTransmitterTransmitTimeout = '1m0s'
 DatabaseTimeout = '8s'
 KeyBundleID = '7a5f66bbe6594259325bf2b4f5b1a9c900000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

core/services/chainlink/testdata/config-multi-chain-effective.toml

@@ -117,7 +117,7 @@ ContractTransmitterTransmitTimeout = '10s'
 DatabaseTimeout = '20s'
 KeyBundleID = '0000000000000000000000000000000000000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

core/services/ocr2/delegate.go

@@ -151,6 +151,7 @@ type ocr2Config interface {
 	DatabaseTimeout() time.Duration
 	KeyBundleID() (string, error)
 	TraceLogging() bool
+	CaptureAutomationCustomTelemetry() bool
 }
 
 type insecureConfig interface {
@@ -1000,7 +1001,7 @@ func (d *Delegate) newServicesOCR2Keepers21(
 		d.cfg.JobPipeline().MaxSuccessfulRuns(),
 	)
 
-	return []job.ServiceCtx{
+	automationServices := []job.ServiceCtx{
 		runResultSaver,
 		keeperProvider,
 		services.Registry(),
@@ -1010,7 +1011,24 @@ func (d *Delegate) newServicesOCR2Keepers21(
 		services.UpkeepStateStore(),
 		services.TransmitEventProvider(),
 		pluginService,
-	}, nil
+	}
+
+	if cfg.CaptureAutomationCustomTelemetry != nil && *cfg.CaptureAutomationCustomTelemetry ||
+		cfg.CaptureAutomationCustomTelemetry == nil && d.cfg.OCR2().CaptureAutomationCustomTelemetry() {
+		endpoint := d.monitoringEndpointGen.GenMonitoringEndpoint(spec.ContractID, synchronization.AutomationCustom, rid.Network, rid.ChainID)
+		customTelemService, custErr := ocr2keeper.NewAutomationCustomTelemetryService(
+			endpoint,
+			lggr,
+			services.BlockSubscriber(),
+			keeperProvider.ContractConfigTracker(),
+		)
+		if custErr != nil {
+			return nil, errors.Wrap(custErr, "Error when creating AutomationCustomTelemetryService")
+		}
+		automationServices = append(automationServices, customTelemService)
+	}
+
+	return automationServices, nil
 }
 
 func (d *Delegate) newServicesOCR2Keepers20(
@@ -1137,14 +1155,16 @@ func (d *Delegate) newServicesOCR2Keepers20(
 		d.cfg.JobPipeline().MaxSuccessfulRuns(),
 	)
 
-	return []job.ServiceCtx{
+	automationServices := []job.ServiceCtx{
 		job.NewServiceAdapter(runr),
 		runResultSaver,
 		keeperProvider,
 		rgstry,
 		logProvider,
 		pluginService,
-	}, nil
+	}
+
+	return automationServices, nil
 }
 
 func (d *Delegate) newServicesOCR2Functions(

core/services/ocr2/plugins/ocr2keeper/config.go

@@ -58,6 +58,8 @@ type PluginConfig struct {
 	ServiceQueueLength int `json:"serviceQueueLength"`
 	// ContractVersion is the contract version
 	ContractVersion string `json:"contractVersion"`
+	// CaptureAutomationCustomTelemetry is a bool flag to toggle Custom Telemetry Service
+	CaptureAutomationCustomTelemetry *bool `json:"captureAutomationCustomTelemetry,omitempty"`
 }
 
 func ValidatePluginConfig(cfg PluginConfig) error {

core/services/ocr2/plugins/ocr2keeper/custom_telemetry.go

@@ -0,0 +1,152 @@
+package ocr2keeper
+
+import (
+	"context"
+	"encoding/hex"
+	"time"
+
+	"github.com/smartcontractkit/libocr/commontypes"
+	"github.com/smartcontractkit/libocr/offchainreporting2plus/types"
+	"google.golang.org/protobuf/proto"
+
+	"github.com/smartcontractkit/chainlink/v2/core/logger"
+	evm21 "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2keeper/evm21"
+	"github.com/smartcontractkit/chainlink/v2/core/services/synchronization/telem"
+	"github.com/smartcontractkit/chainlink/v2/core/static"
+	"github.com/smartcontractkit/chainlink/v2/core/utils"
+	ocr2keepers "github.com/smartcontractkit/ocr2keepers/pkg/v3/types"
+)
+
+type AutomationCustomTelemetryService struct {
+	utils.StartStopOnce
+	monitoringEndpoint    commontypes.MonitoringEndpoint
+	blockSubscriber       *evm21.BlockSubscriber
+	blockSubChanID        int
+	threadCtrl            utils.ThreadControl
+	lggr                  logger.Logger
+	configDigest          [32]byte
+	contractConfigTracker types.ContractConfigTracker
+}
+
+// NewAutomationCustomTelemetryService creates a telemetry service for new blocks and node version
+func NewAutomationCustomTelemetryService(me commontypes.MonitoringEndpoint,
+	lggr logger.Logger, blocksub *evm21.BlockSubscriber, configTracker types.ContractConfigTracker) (*AutomationCustomTelemetryService, error) {
+	return &AutomationCustomTelemetryService{
+		monitoringEndpoint:    me,
+		threadCtrl:            utils.NewThreadControl(),
+		lggr:                  lggr.Named("AutomationCustomTelem"),
+		contractConfigTracker: configTracker,
+		blockSubscriber:       blocksub,
+	}, nil
+}
+
+// Start starts Custom Telemetry Service, sends 1 NodeVersion message to endpoint at start and sends new BlockNumber messages
+func (e *AutomationCustomTelemetryService) Start(ctx context.Context) error {
+	return e.StartOnce("AutomationCustomTelemetryService", func() error {
+		e.lggr.Infof("Starting: Custom Telemetry Service")
+		_, configDetails, err := e.contractConfigTracker.LatestConfigDetails(ctx)
+		if err != nil {
+			e.lggr.Errorf("Error occurred while getting newestConfigDetails for initialization %s", err)
+		} else {
+			e.configDigest = configDetails
+			e.sendNodeVersionMsg()
+		}
+		e.threadCtrl.Go(func(ctx context.Context) {
+			ticker := time.NewTicker(1 * time.Minute)
+			defer ticker.Stop()
+			for {
+				select {
+				case <-ticker.C:
+					_, newConfigDigest, err := e.contractConfigTracker.LatestConfigDetails(ctx)
+					if err != nil {
+						e.lggr.Errorf("Error occurred while getting newestConfigDetails in configDigest loop %s", err)
+					}
+					if newConfigDigest != e.configDigest {
+						e.configDigest = newConfigDigest
+						e.sendNodeVersionMsg()
+					}
+				case <-ctx.Done():
+					return
+				}
+			}
+		})
+
+		chanID, blockSubscriberChan, blockSubErr := e.blockSubscriber.Subscribe()
+		if blockSubErr != nil {
+			e.lggr.Errorf("Block Subscriber Error: Subscribe(): %s", blockSubErr)
+
+		} else {
+			e.blockSubChanID = chanID
+			e.threadCtrl.Go(func(ctx context.Context) {
+				e.lggr.Infof("Started: Sending BlockNumber Messages")
+				for {
+					select {
+					case blockHistory := <-blockSubscriberChan:
+						latestBlockKey, err := blockHistory.Latest()
+						if err != nil {
+							e.lggr.Errorf("BlockSubscriber BlockHistory.Latest() failed: %s", err)
+							continue
+						}
+						e.sendBlockNumberMsg(latestBlockKey)
+					case <-ctx.Done():
+						return
+					}
+				}
+			})
+		}
+		return nil
+	})
+}
+
+// Close stops go routines and closes channels
+func (e *AutomationCustomTelemetryService) Close() error {
+	// use utils
+	return e.StopOnce("AutomationCustomTelemetryService", func() error {
+		e.lggr.Infof("Stopping: custom telemetry service")
+		e.threadCtrl.Close()
+		e.blockSubscriber.Unsubscribe(e.blockSubChanID)
+		e.lggr.Infof("Stopped: Custom telemetry service")
+		return nil
+	})
+}
+
+func (e *AutomationCustomTelemetryService) sendNodeVersionMsg() {
+	vMsg := &telem.NodeVersion{
+		Timestamp:    uint64(time.Now().UTC().UnixMilli()),
+		NodeVersion:  static.Version,
+		ConfigDigest: e.configDigest[:],
+	}
+	wrappedVMsg := &telem.AutomationTelemWrapper{
+		Msg: &telem.AutomationTelemWrapper_NodeVersion{
+			NodeVersion: vMsg,
+		},
+	}
+	bytes, err := proto.Marshal(wrappedVMsg)
+	if err != nil {
+		e.lggr.Errorf("Error occurred while marshalling the Node Version Message %s: %v", wrappedVMsg.String(), err)
+	} else {
+		e.monitoringEndpoint.SendLog(bytes)
+		e.lggr.Infof("NodeVersion Message Sent to Endpoint: %d", vMsg.Timestamp)
+	}
+}
+
+func (e *AutomationCustomTelemetryService) sendBlockNumberMsg(blockKey ocr2keepers.BlockKey) {
+	blockNumMsg := &telem.BlockNumber{
+		Timestamp:    uint64(time.Now().UTC().UnixMilli()),
+		BlockNumber:  uint64(blockKey.Number),
+		BlockHash:    hex.EncodeToString(blockKey.Hash[:]),
+		ConfigDigest: e.configDigest[:],
+	}
+	wrappedBlockNumMsg := &telem.AutomationTelemWrapper{
+		Msg: &telem.AutomationTelemWrapper_BlockNumber{
+			BlockNumber: blockNumMsg,
+		},
+	}
+	b, err := proto.Marshal(wrappedBlockNumMsg)
+	if err != nil {
+		e.lggr.Errorf("Error occurred while marshalling the Block Num Message %s: %v", wrappedBlockNumMsg.String(), err)
+	} else {
+		e.monitoringEndpoint.SendLog(b)
+		e.lggr.Infof("BlockNumber Message Sent to Endpoint: %d", blockNumMsg.Timestamp)
+	}
+}

core/services/ocr2/plugins/ocr2keeper/custom_telemetry_test.go

@@ -0,0 +1,17 @@
+package ocr2keeper
+
+import (
+	"testing"
+)
+
+func TestNewAutomationCustomTelemetryService(t *testing.T) {
+	// me := &MockMonitoringEndpoint{}
+	// lggr := &MockLogger{}
+	// blocksub := &MockBlockSubscriber{}
+	// configTracker := &MockContractConfigTracker{}
+
+	// service, err := NewAutomationCustomTelemetryService(me, lggr, blocksub, configTracker)
+	// if err != nil {
+	// 	t.Errorf("Expected no error, but got: %v", err)
+	// }
+}

core/web/presenters/job.go

@@ -196,6 +196,8 @@ type OffChainReporting2Spec struct {
 	CreatedAt                         time.Time              `json:"createdAt"`
 	UpdatedAt                         time.Time              `json:"updatedAt"`
 	CollectTelemetry                  bool                   `json:"collectTelemetry"`
+	//HERE REMOVE THIS
+	CaptureAutomationCustomTelemetry bool `json:"captureAutomationCustomTelemetry"`
 }
 
 // NewOffChainReporting2Spec initializes a new OffChainReportingSpec from a
@@ -214,6 +216,8 @@ func NewOffChainReporting2Spec(spec *job.OCR2OracleSpec) *OffChainReporting2Spec
 		CreatedAt:                         spec.CreatedAt,
 		UpdatedAt:                         spec.UpdatedAt,
 		CollectTelemetry:                  spec.CaptureEATelemetry,
+		//HERE REMOVE THIS
+		CaptureAutomationCustomTelemetry: spec.CaptureAutomationCustomTelemetry,
 	}
 }
 

core/web/resolver/testdata/config-empty-effective.toml

@@ -117,7 +117,7 @@ ContractTransmitterTransmitTimeout = '10s'
 DatabaseTimeout = '10s'
 KeyBundleID = '0000000000000000000000000000000000000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

core/web/resolver/testdata/config-full.toml

@@ -123,7 +123,7 @@ ContractTransmitterTransmitTimeout = '1m0s'
 DatabaseTimeout = '8s'
 KeyBundleID = '7a5f66bbe6594259325bf2b4f5b1a9c900000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

core/web/resolver/testdata/config-multi-chain-effective.toml

@@ -117,7 +117,7 @@ ContractTransmitterTransmitTimeout = '10s'
 DatabaseTimeout = '20s'
 KeyBundleID = '0000000000000000000000000000000000000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

docs/CONFIG.md

@@ -757,7 +757,7 @@ ContractTransmitterTransmitTimeout = '10s' # Default
 DatabaseTimeout = '10s' # Default
 KeyBundleID = '7a5f66bbe6594259325bf2b4f5b1a9c900000000000000000000000000000000' # Example
 CaptureEATelemetry = false # Default
-CaptureAutomationCustomTelemetry = false # Default
+CaptureAutomationCustomTelemetry = true # Default
 DefaultTransactionQueueDepth = 1 # Default
 SimulateTransactions = false # Default
 TraceLogging = false # Default
@@ -854,7 +854,7 @@ CaptureEATelemetry toggles collecting extra information from External Adaptares
 
 ### CaptureAutomationCustomTelemetry
 ```toml
-CaptureAutomationCustomTelemetry = false # Default
+CaptureAutomationCustomTelemetry = true # Default
 ```
 CaptureAutomationCustomTelemetry toggles collecting automation specific telemetry
 

testdata/scripts/node/validate/default.txtar

@@ -129,7 +129,7 @@ ContractTransmitterTransmitTimeout = '10s'
 DatabaseTimeout = '10s'
 KeyBundleID = '0000000000000000000000000000000000000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

testdata/scripts/node/validate/disk-based-logging-disabled.txtar

@@ -173,7 +173,7 @@ ContractTransmitterTransmitTimeout = '10s'
 DatabaseTimeout = '10s'
 KeyBundleID = '0000000000000000000000000000000000000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false

testdata/scripts/node/validate/disk-based-logging-no-dir.txtar

@@ -173,7 +173,7 @@ ContractTransmitterTransmitTimeout = '10s'
 DatabaseTimeout = '10s'
 KeyBundleID = '0000000000000000000000000000000000000000000000000000000000000000'
 CaptureEATelemetry = false
-CaptureAutomationCustomTelemetry = false
+CaptureAutomationCustomTelemetry = true
 DefaultTransactionQueueDepth = 1
 SimulateTransactions = false
 TraceLogging = false