eventrecorder

Documentation

Index

• Variables
• type EventDetailsError
• type EventDetailsIndexer
• type EventDetailsSuccess
• type EventRecorder
  • func NewEventRecorder(ctx context.Context, cfg EventRecorderConfig) *EventRecorder
  • func (er *EventRecorder) RecordEvent(event types.RetrievalEvent)
• type EventRecorderConfig
• type MultiEventReport

Variables

var HttpTimeout = 5 * time.Second

var ParallelPosters = 5

Types

type EventDetailsError

type EventDetailsError struct {
	Error string `json:"error"`
}

eventDetailsError is for the EventDetails in the case of a query or retrieval failure

type EventDetailsIndexer

type EventDetailsIndexer struct {
	CandidateCount uint64   `json:"candidateCount"`
	Protocols      []string `json:"protocols"`
}

type EventDetailsSuccess

type EventDetailsSuccess struct {
	ReceivedSize uint64 `json:"receivedSize"`
	ReceivedCids uint64 `json:"receivedCids"`
	Duration     uint64 `json:"durationMs"`
}

eventDetailsSuccess is for the EventDetails in the case of a retrieval success

type EventRecorder

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

EventRecorder receives events from the retrieval manager and posts event data to a given endpoint as POSTs with JSON bodies

func NewEventRecorder

func NewEventRecorder(ctx context.Context, cfg EventRecorderConfig) *EventRecorder

NewEventRecorder creates a new event recorder with the ID of this instance and the URL to POST to

func (*EventRecorder) RecordEvent

func (er *EventRecorder) RecordEvent(event types.RetrievalEvent)

type EventRecorderConfig

type EventRecorderConfig struct {
	DisableIndexerEvents  bool
	InstanceID            string
	EndpointURL           string
	EndpointAuthorization string
}

type MultiEventReport

type MultiEventReport struct {
	Events []eventReport `json:"events"`
}