telemetry

Documentation

Index

• type Client
  • func NewClient(logger *zap.Logger, serverURL string, keyUID string, nodeName string, ...) *Client
  • func (c *Client) CollectAndProcessTelemetry(ctx context.Context)
  • func (c *Client) ProcessReceivedEnvelope(envelope *v2protocol.Envelope) *json.RawMessage
  • func (c *Client) ProcessReceivedMessages(receivedMessages ReceivedMessages) *json.RawMessage
  • func (c *Client) ProcessSentEnvelope(sentEnvelope wakuv2.SentEnvelope) *json.RawMessage
  • func (c *Client) PushReceivedEnvelope(receivedEnvelope *v2protocol.Envelope)
  • func (c *Client) PushReceivedMessages(receivedMessages ReceivedMessages)
  • func (c *Client) PushSentEnvelope(sentEnvelope wakuv2.SentEnvelope)
  • func (c *Client) Start(ctx context.Context)
  • func (c *Client) UpdateEnvelopeProcessingError(shhMessage *types.Message, processingError error)
• type ReceivedMessages
• type TelemetryRequest
• type TelemetryType

Types

type Client

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

func NewClient

func NewClient(logger *zap.Logger, serverURL string, keyUID string, nodeName string, version string) *Client

func (*Client) CollectAndProcessTelemetry

func (c *Client) CollectAndProcessTelemetry(ctx context.Context)

func (*Client) ProcessReceivedEnvelope

func (c *Client) ProcessReceivedEnvelope(envelope *v2protocol.Envelope) *json.RawMessage

func (*Client) ProcessReceivedMessages

func (c *Client) ProcessReceivedMessages(receivedMessages ReceivedMessages) *json.RawMessage

func (*Client) ProcessSentEnvelope

func (c *Client) ProcessSentEnvelope(sentEnvelope wakuv2.SentEnvelope) *json.RawMessage

func (*Client) PushReceivedEnvelope

func (c *Client) PushReceivedEnvelope(receivedEnvelope *v2protocol.Envelope)

func (*Client) PushReceivedMessages

func (c *Client) PushReceivedMessages(receivedMessages ReceivedMessages)

func (*Client) PushSentEnvelope

func (c *Client) PushSentEnvelope(sentEnvelope wakuv2.SentEnvelope)

func (*Client) Start

func (c *Client) Start(ctx context.Context)

func (*Client) UpdateEnvelopeProcessingError

func (c *Client) UpdateEnvelopeProcessingError(shhMessage *types.Message, processingError error)

type ReceivedMessages

type ReceivedMessages struct {
	Filter     transport.Filter
	SSHMessage *types.Message
	Messages   []*v1protocol.StatusMessage
}

type TelemetryRequest

type TelemetryRequest struct {
	Id            int              `json:"id"`
	TelemetryType TelemetryType    `json:"telemetry_type"`
	TelemetryData *json.RawMessage `json:"telemetry_data"`
}

type TelemetryType

type TelemetryType string

const (
	ProtocolStatsMetric    TelemetryType = "ProtocolStats"
	ReceivedEnvelopeMetric TelemetryType = "ReceivedEnvelope"
	SentEnvelopeMetric     TelemetryType = "SentEnvelope"
	UpdateEnvelopeMetric   TelemetryType = "UpdateEnvelope"
	ReceivedMessagesMetric TelemetryType = "ReceivedMessages"
)