telemetry

Documentation

Index

• type Client
  • func NewClient(logger *zap.Logger, serverURL string, keyUID string, nodeName string, ...) *Client
  • func (c *Client) ProcessErrorSendingEnvelope(errorSendingEnvelope wakuv2.ErrorSendingEnvelope) *json.RawMessage
  • func (c *Client) ProcessPeerConnFailure(peerConnFailure PeerConnFailure) *json.RawMessage
  • func (c *Client) ProcessPeerCount(peerCount PeerCount) *json.RawMessage
  • 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) PushErrorSendingEnvelope(ctx context.Context, errorSendingEnvelope wakuv2.ErrorSendingEnvelope)
  • func (c *Client) PushPeerConnFailures(ctx context.Context, peerConnFailures map[string]int)
  • func (c *Client) PushPeerCount(ctx context.Context, peerCount int)
  • func (c *Client) PushReceivedEnvelope(ctx context.Context, receivedEnvelope *v2protocol.Envelope)
  • func (c *Client) PushReceivedMessages(ctx context.Context, receivedMessages ReceivedMessages)
  • func (c *Client) PushSentEnvelope(ctx context.Context, sentEnvelope wakuv2.SentEnvelope)
  • func (c *Client) SetDeviceType(deviceType string)
  • func (c *Client) Start(ctx context.Context)
  • func (c *Client) UpdateEnvelopeProcessingError(shhMessage *types.Message, processingError error)
• type PeerConnFailure
• type PeerCount
• type ReceivedMessages
• type TelemetryClientOption
  • func WithPeerID(peerId string) TelemetryClientOption
  • func WithSendPeriod(sendPeriod time.Duration) TelemetryClientOption
• 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, opts ...TelemetryClientOption) *Client

func (*Client) ProcessErrorSendingEnvelope

func (c *Client) ProcessErrorSendingEnvelope(errorSendingEnvelope wakuv2.ErrorSendingEnvelope) *json.RawMessage

func (*Client) ProcessPeerConnFailure

func (c *Client) ProcessPeerConnFailure(peerConnFailure PeerConnFailure) *json.RawMessage

func (*Client) ProcessPeerCount

func (c *Client) ProcessPeerCount(peerCount PeerCount) *json.RawMessage

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) PushErrorSendingEnvelope

func (c *Client) PushErrorSendingEnvelope(ctx context.Context, errorSendingEnvelope wakuv2.ErrorSendingEnvelope)

func (*Client) PushPeerConnFailures

func (c *Client) PushPeerConnFailures(ctx context.Context, peerConnFailures map[string]int)

func (*Client) PushPeerCount

func (c *Client) PushPeerCount(ctx context.Context, peerCount int)

func (*Client) PushReceivedEnvelope

func (c *Client) PushReceivedEnvelope(ctx context.Context, receivedEnvelope *v2protocol.Envelope)

func (*Client) PushReceivedMessages

func (c *Client) PushReceivedMessages(ctx context.Context, receivedMessages ReceivedMessages)

func (*Client) PushSentEnvelope

func (c *Client) PushSentEnvelope(ctx context.Context, sentEnvelope wakuv2.SentEnvelope)

func (*Client) SetDeviceType

func (c *Client) SetDeviceType(deviceType string)

func (*Client) Start

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

func (*Client) UpdateEnvelopeProcessingError

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

type PeerConnFailure

type PeerConnFailure struct {
	FailedPeerId string
	FailureCount int
}

type PeerCount

type PeerCount struct {
	PeerCount int
}

type ReceivedMessages

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

type TelemetryClientOption

type TelemetryClientOption func(*Client)

func WithPeerID

func WithPeerID(peerId string) TelemetryClientOption

func WithSendPeriod

func WithSendPeriod(sendPeriod time.Duration) TelemetryClientOption

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"
	ErrorSendingEnvelopeMetric TelemetryType = "ErrorSendingEnvelope"
	PeerCountMetric            TelemetryType = "PeerCount"
	PeerConnFailuresMetric     TelemetryType = "PeerConnFailure"

	MaxRetryCache = 5000
)