Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAggregateEventRecorder ¶
func NewAggregateEventRecorder(ctx context.Context, eventRecorderConfig EventRecorderConfig) *aggregateEventRecorder
Types ¶
type AggregateEvent ¶
type AggregateEvent struct {
InstanceID string `json:"instanceId"` // The ID of the Sheltie instance generating the event
RetrievalID string `json:"retrievalId"` // The unique ID of the retrieval
RootCid string `json:"rootCid"` // The root cid being fetched
URLPath string `json:"urlPath"` // The path url after the root cid, including scope
StorageProviderID string `json:"storageProviderId,omitempty"` // The ID of the storage provider that served the retrieval content
TimeToFirstByte string `json:"timeToFirstByte,omitempty"` // The time it took to receive the first byte in milliseconds
Bandwidth uint64 `json:"bandwidth,omitempty"` // The bandwidth of the retrieval in bytes per second
BytesTransferred uint64 `json:"bytesTransferred,omitempty"` // The total transmitted deal size
Success bool `json:"success"` // Whether or not the retrieval ended with a success event
StartTime time.Time `json:"startTime"` // The time the retrieval started
EndTime time.Time `json:"endTime"` // The time the retrieval ended
TimeToFirstIndexerResult string `json:"timeToFirstIndexerResult,omitempty"` // time it took to receive our first "CandidateFound" event
IndexerCandidatesReceived int `json:"indexerCandidatesReceived"` // The number of candidates received from the indexer
IndexerCandidatesFiltered int `json:"indexerCandidatesFiltered"` // The number of candidates that made it through the filtering stage
ProtocolsAllowed []string `json:"protocolsAllowed,omitempty"` // The available protocols that could be used for this retrieval
ProtocolsAttempted []string `json:"protocolsAttempted,omitempty"` // The protocols that were used to attempt this retrieval
ProtocolSucceeded string `json:"protocolSucceeded,omitempty"` // The protocol used for a successful event
RetrievalAttempts map[string]*RetrievalAttempt `json:"retrievalAttempts,omitempty"` // All of the retrieval attempts, indexed by their SP ID
}
type EventRecorderConfig ¶
Click to show internal directories.
Click to hide internal directories.