telemetry

Documentation

Index

• func GetDummyKeyString() string
• func GetDummyKeyStringWithPrefix(prefix string) string
• type IngressAgent
  • func NewIngressAgent(telemetryIngressClient synchronization.TelemetryService, network string, ...) *IngressAgent
  • func (t *IngressAgent) SendLog(telemetry []byte)
• type IngressAgentBatch
  • func NewIngressAgentBatch(telemetryIngressBatchClient synchronization.TelemetryService, network string, ...) *IngressAgentBatch
  • func (t *IngressAgentBatch) SendLog(telemetry []byte)
• type IngressAgentBatchWrapper
  • func NewIngressAgentBatchWrapper(telemetryIngressBatchClient synchronization.TelemetryService) *IngressAgentBatchWrapper
  • func (t *IngressAgentBatchWrapper) GenMonitoringEndpoint(network string, chainID string, contractID string, ...) ocrtypes.MonitoringEndpoint
• type IngressAgentWrapper
  • func NewIngressAgentWrapper(telemetryIngressClient synchronization.TelemetryService) *IngressAgentWrapper
  • func (t *IngressAgentWrapper) GenMonitoringEndpoint(network, chainID string, contractID string, ...) ocrtypes.MonitoringEndpoint
• type Manager
  • func NewManager(cfg config.TelemetryIngress, csaKeyStore keystore.CSA, lggr logger.Logger) *Manager
  • func (m *Manager) Close() error
  • func (m *Manager) GenMonitoringEndpoint(network string, chainID string, contractID string, ...) commontypes.MonitoringEndpoint
  • func (m *Manager) HealthReport() map[string]error
  • func (m *Manager) Name() string
  • func (m *Manager) Start(ctx context.Context) error
• type MonitoringEndpointGenerator
• type NoopAgent
  • func (t *NoopAgent) GenMonitoringEndpoint(network string, chainID string, contractID string, ...) ocrtypes.MonitoringEndpoint
  • func (t *NoopAgent) SendLog(log []byte)

Functions

func GetDummyKeyString

func GetDummyKeyString() string

getDummyKeyString returns a dummy key string satisfies the wsrpc key length constraints

func GetDummyKeyStringWithPrefix

func GetDummyKeyStringWithPrefix(prefix string) string

getDummyKeyString returns a dummy key string with the specified prefix satisfies the wsrpc key length constraints

Types

type IngressAgent

type IngressAgent struct {
	// contains filtered or unexported fields
}

func NewIngressAgent

func NewIngressAgent(telemetryIngressClient synchronization.TelemetryService, network string, chainID string, contractID string, telemType synchronization.TelemetryType) *IngressAgent

func (*IngressAgent) SendLog

func (t *IngressAgent) SendLog(telemetry []byte)

SendLog sends a telemetry log to the ingress server

type IngressAgentBatch

type IngressAgentBatch struct {
	// contains filtered or unexported fields
}

IngressAgentBatch allows for sending batch telemetry for a given contractID

func NewIngressAgentBatch

func NewIngressAgentBatch(telemetryIngressBatchClient synchronization.TelemetryService, network string, chainID string, contractID string, telemType synchronization.TelemetryType) *IngressAgentBatch

NewIngressAgentBatch creates a new IngressAgentBatch with the given batch client and contractID

func (*IngressAgentBatch) SendLog

func (t *IngressAgentBatch) SendLog(telemetry []byte)

SendLog sends a telemetry log to the ingress server

type IngressAgentBatchWrapper

type IngressAgentBatchWrapper struct {
	// contains filtered or unexported fields
}

IngressAgentBatchWrapper provides monitoring endpoint generation for the telemetry batch client

func NewIngressAgentBatchWrapper

func NewIngressAgentBatchWrapper(telemetryIngressBatchClient synchronization.TelemetryService) *IngressAgentBatchWrapper

NewIngressAgentBatchWrapper creates a new IngressAgentBatchWrapper with the provided telemetry batch client

func (*IngressAgentBatchWrapper) GenMonitoringEndpoint

func (t *IngressAgentBatchWrapper) GenMonitoringEndpoint(network string, chainID string, contractID string, telemType synchronization.TelemetryType) ocrtypes.MonitoringEndpoint

GenMonitoringEndpoint returns a new ingress batch agent instantiated with the batch client and a contractID

type IngressAgentWrapper

type IngressAgentWrapper struct {
	// contains filtered or unexported fields
}

func NewIngressAgentWrapper

func NewIngressAgentWrapper(telemetryIngressClient synchronization.TelemetryService) *IngressAgentWrapper

func (*IngressAgentWrapper) GenMonitoringEndpoint

func (t *IngressAgentWrapper) GenMonitoringEndpoint(network, chainID string, contractID string, telemType synchronization.TelemetryType) ocrtypes.MonitoringEndpoint

type Manager

type Manager struct {
	services.StateMachine

	MonitoringEndpointGenerator MonitoringEndpointGenerator
	// contains filtered or unexported fields
}

func NewManager

func NewManager(cfg config.TelemetryIngress, csaKeyStore keystore.CSA, lggr logger.Logger) *Manager

NewManager create a new telemetry manager that is responsible for configuring telemetry agents and generating the defined telemetry endpoints and monitoring endpoints

func (*Manager) Close

func (m *Manager) Close() error

func (*Manager) GenMonitoringEndpoint

func (m *Manager) GenMonitoringEndpoint(network string, chainID string, contractID string, telemType synchronization.TelemetryType) commontypes.MonitoringEndpoint

GenMonitoringEndpoint creates a new monitoring endpoints based on the existing available endpoints defined in the core config TOML, if no endpoint for the network and chainID exists, a NOOP agent will be used and the telemetry will not be sent

func (*Manager) HealthReport

func (m *Manager) HealthReport() map[string]error

func (*Manager) Name

func (m *Manager) Name() string

func (*Manager) Start

func (m *Manager) Start(ctx context.Context) error

type MonitoringEndpointGenerator

type MonitoringEndpointGenerator interface {
	GenMonitoringEndpoint(network string, chainID string, contractID string, telemType synchronization.TelemetryType) ocrtypes.MonitoringEndpoint
}

type NoopAgent

type NoopAgent struct {
}

func (*NoopAgent) GenMonitoringEndpoint

func (t *NoopAgent) GenMonitoringEndpoint(network string, chainID string, contractID string, telemType synchronization.TelemetryType) ocrtypes.MonitoringEndpoint

GenMonitoringEndpoint creates a monitoring endpoint for telemetry

func (*NoopAgent) SendLog

func (t *NoopAgent) SendLog(log []byte)

SendLog sends a telemetry log to the ingress service