metrics

Documentation

Index

• type AnalysisFPCFinalizedEvent
• type CollectionEvents
  • func Events() *CollectionEvents
• type QueryReceivedEvent
• type QueryReplyErrorEvent

Types

type AnalysisFPCFinalizedEvent

type AnalysisFPCFinalizedEvent struct {
	// ConflictID defines the ID of the finalized conflict.
	ConflictID string
	// NodeID defines the ID of the node.
	NodeID string
	// Rounds defines the number of rounds performed to finalize.
	Rounds int
	// Opinions contains the opinion of each round.
	Opinions []opinion.Opinion
	// Outcome defines the outcome of the FPC voting.
	Outcome opinion.Opinion
}

AnalysisFPCFinalizedEvent is triggered by the analysis server to notify a finalized FPC vote from one node.

type CollectionEvents

type CollectionEvents struct {
	// AnalysisOutboundBytes defines the local analysis outbound network traffic in bytes.
	AnalysisOutboundBytes *events.Event
	// FPCInboundBytes defines the local FPC inbound network traffic in bytes.
	FPCInboundBytes *events.Event
	// FPCOutboundBytes defines the local FPC outbound network traffic in bytes.
	FPCOutboundBytes *events.Event
	// CPUUsage defines the local CPU usage.
	CPUUsage *events.Event
	// MemUsage defines the local GoShimmer memory usage.
	MemUsage *events.Event
	// TangleTimeSynced defines the local sync status event based on tangle time.
	TangleTimeSynced *events.Event
	// ValueTips defines the local value tips count event.
	ValueTips *events.Event
	// MessageTips defines the local message tips count event.
	MessageTips *events.Event
	// QueryReceived defines the local FPC query received event.
	QueryReceived *events.Event
	// QueryReplyError defines the local FPC query finalization event.
	QueryReplyError *events.Event
	// AnalysisFPCFinalized defines the global FPC finalization event.
	AnalysisFPCFinalized *events.Event
}

CollectionEvents defines the events fot the metrics package.

func Events

func Events() *CollectionEvents

Events returns the events defined in the package.

type QueryReceivedEvent

type QueryReceivedEvent struct {
	// OpinionCount defines the local FPC number of opinions requested within a received query.
	OpinionCount int
}

QueryReceivedEvent is used to pass information through a QueryReceived event.

type QueryReplyErrorEvent

type QueryReplyErrorEvent struct {
	// ID defines the ID on the queried node.
	ID string
	// OpinionCount defines the local FPC number of opinions requested within a failed query.
	OpinionCount int
}

QueryReplyErrorEvent is used to pass information through a QueryReplyError event.