remotemetrics

Documentation

Index

• type BlockFinalizedMetrics
• type BlockScheduledMetrics
• type CollectionLogEvents
• type ConflictConfirmationMetrics
• type ConflictCountUpdate
• type MissingBlockMetrics
• type SchedulerMetrics
• type SchedulerQueryEvent
• type TangleTimeSyncChangedEvent

Types

type BlockFinalizedMetrics

type BlockFinalizedMetrics struct {
	Type                 string    `json:"type" bson:"type"`
	NodeID               string    `json:"nodeID" bson:"nodeID"`
	IssuerID             string    `json:"issuerID" bson:"issuerID"`
	MetricsLevel         uint8     `json:"metricsLevel" bson:"metricsLevel"`
	BlockID              string    `json:"blockID" bson:"blockID"`
	TransactionID        string    `json:"transactionID,omitempty" bson:"transactionID"`
	IssuedTimestamp      time.Time `json:"issuedTimestamp" bson:"issuedTimestamp"`
	SolidTimestamp       time.Time `json:"solidTimestamp,omitempty" bson:"solidTimestamp"`
	ScheduledTimestamp   time.Time `json:"scheduledTimestamp" bson:"scheduledTimestamp"`
	BookedTimestamp      time.Time `json:"bookedTimestamp" bson:"bookedTimestamp"`
	ConfirmedTimestamp   time.Time `json:"confirmedTimestamp" bson:"confirmedTimestamp"`
	DeltaSolid           int64     `json:"deltaSolid,omitempty" bson:"deltaSolid"`
	DeltaScheduled       int64     `json:"deltaArrival" bson:"deltaArrival"`
	DeltaBooked          int64     `json:"deltaBooked" bson:"deltaBooked"`
	DeltaConfirmed       int64     `json:"deltaConfirmed" bson:"deltaConfirmed"`
	StrongEdgeCount      int       `json:"strongEdgeCount" bson:"strongEdgeCount"`
	WeakEdgeCount        int       `json:"weakEdgeCount,omitempty" bson:"weakEdgeCount"`
	ShallowLikeEdgeCount int       `json:"shallowLikeEdgeCount,omitempty" bson:"likeEdgeCount"`
}

BlockFinalizedMetrics defines the transaction metrics record that is sent to remote logger.

type BlockScheduledMetrics

type BlockScheduledMetrics struct {
	Type          string `json:"type" bson:"type"`
	NodeID        string `json:"nodeID" bson:"nodeID"`
	IssuerID      string `json:"issuerID" bson:"issuerID"`
	MetricsLevel  uint8  `json:"metricsLevel" bson:"metricsLevel"`
	BlockID       string `json:"blockID" bson:"blockID"`
	TransactionID string `json:"transactionID,omitempty" bson:"transactionID"`
	// Time where the block was created by the issuing node
	IssuedTimestamp time.Time `json:"issuedTimestamp" bson:"issuedTimestamp"`
	// Time where the block was first seen by the node
	ReceivedTimestamp          time.Time `json:"receivedTimestamp" bson:"receivedTimestamp"`
	SolidTimestamp             time.Time `json:"solidTimestamp,omitempty" bson:"solidTimestamp"`
	ScheduledTimestamp         time.Time `json:"scheduledTimestamp,omitempty" bson:"scheduledTimestamp"`
	BookedTimestamp            time.Time `json:"bookedTimestamp" bson:"bookedTimestamp"`
	QueuedTimestamp            time.Time `json:"queuedTimestamp" bson:"queuedTimestamp"`
	DroppedTimestamp           time.Time `json:"droppedTimestamp,omitempty" bson:"DroppedTimestamp"`
	ConfirmationStateTimestamp time.Time `json:"confirmationStateTimestamp,omitempty" bson:"ConfirmationStateTimestamp"`
	ConfirmationState          uint8     `json:"confirmationState" bson:"ConfirmationState"`
	DeltaConfirmationStateTime int64     `json:"deltaConfirmationStateTime" bson:"deltaConfirmationStateTime"`
	DeltaSolid                 int64     `json:"deltaSolid,omitempty" bson:"deltaSolid"`
	// ScheduledTimestamp - IssuedTimestamp in nanoseconds
	DeltaScheduledIssued int64 `json:"deltaScheduledIssued" bson:"deltaScheduledIssued"`
	DeltaBooked          int64 `json:"deltaBooked" bson:"deltaBooked"`
	// ScheduledTimestamp - ReceivedTimestamp in nanoseconds
	DeltaScheduledReceived int64 `json:"deltaScheduledReceived" bson:"deltaScheduledReceived"`
	// ReceivedTimestamp - IssuedTimestamp in nanoseconds
	DeltaReceivedIssued int64 `json:"DeltaReceivedIssued" bson:"DeltaReceivedIssued"`
	// ScheduledTimestamp - QueuedTimestamp in nanoseconds
	SchedulingTime  int64 `json:"schedulingTime" bson:"schedulingTime"`
	AccessMana      int64 `json:"accessMana" bson:"accessMana"`
	StrongEdgeCount int   `json:"strongEdgeCount" bson:"strongEdgeCount"`
	WeakEdgeCount   int   `json:"weakEdgeCount,omitempty" bson:"weakEdgeCount"`
	LikeEdgeCount   int   `json:"likeEdgeCount,omitempty" bson:"likeEdgeCount"`
}

BlockScheduledMetrics defines the scheduling block confirmation metrics record that is sent to remote logger.

type CollectionLogEvents

type CollectionLogEvents struct {
	// TangleTimeSyncChanged defines the local sync status change event based on tangle time.
	TangleTimeSyncChanged *event.Event[*TangleTimeSyncChangedEvent]
	SchedulerQuery        *event.Event[*SchedulerQueryEvent]
}

CollectionLogEvents defines the events for the remotelogmetrics package.

var Events *CollectionLogEvents

type ConflictConfirmationMetrics

type ConflictConfirmationMetrics struct {
	Type               string    `json:"type" bson:"type"`
	NodeID             string    `json:"nodeID" bson:"nodeID"`
	IssuerID           string    `json:"issuerID" bson:"issuerID"`
	MetricsLevel       uint8     `json:"metricsLevel" bson:"metricsLevel"`
	BlockID            string    `json:"blockID" bson:"blockID"`
	ConflictID         string    `json:"transactionID" bson:"transactionID"`
	CreatedTimestamp   time.Time `json:"createdTimestamp" bson:"createdTimestamp"`
	ConfirmedTimestamp time.Time `json:"confirmedTimestamp" bson:"confirmedTimestamp"`
	DeltaConfirmed     int64     `json:"deltaConfirmed" bson:"deltaConfirmed"`
}

ConflictConfirmationMetrics defines the conflict confirmation metrics record that is sent to remote logger.

type ConflictCountUpdate

type ConflictCountUpdate struct {
	Type                             string `json:"type" bson:"type"`
	NodeID                           string `json:"nodeID" bson:"nodeID"`
	MetricsLevel                     uint8  `json:"metricsLevel" bson:"metricsLevel"`
	TotalConflictCount               uint64 `json:"totalConflictCount" bson:"totalConflictCount"`
	FinalizedConflictCount           uint64 `json:"finalizedConflictCount" bson:"finalizedConflictCount"`
	ConfirmedConflictCount           uint64 `json:"confirmedConflictCount" bson:"confirmedConflictCount"`
	InitialTotalConflictCount        uint64 `json:"initialTotalConflictCount" bson:"initialTotalConflictCount"`
	TotalConflictCountSinceStart     uint64 `json:"totalConflictCountSinceStart" bson:"totalConflictCountSinceStart"`
	InitialConfirmedConflictCount    uint64 `json:"initialConfirmedConflictCount" bson:"initialConfirmedConflictCount"`
	ConfirmedConflictCountSinceStart uint64 `json:"confirmedConflictCountSinceStart" bson:"confirmedConflictCountSinceStart"`
	InitialFinalizedConflictCount    uint64 `json:"initialFinalizedConflictCount" bson:"initialFinalizedConflictCount"`
	FinalizedConflictCountSinceStart uint64 `json:"finalizedConflictCountSinceStart" bson:"finalizedConflictCountSinceStart"`
}

ConflictCountUpdate defines the conflict confirmation metrics record that is sent to remote logger.

type MissingBlockMetrics

type MissingBlockMetrics struct {
	Type         string `json:"type" bson:"type"`
	NodeID       string `json:"nodeID" bson:"nodeID"`
	MetricsLevel uint8  `json:"metricsLevel" bson:"metricsLevel"`
	BlockID      string `json:"blockID" bson:"blockID"`
	IssuerID     string `json:"issuerID"  bson:"issuerID"`
}

MissingBlockMetrics defines block solidification record that is sent to the remote logger.

type SchedulerMetrics

type SchedulerMetrics struct {
	Type                         string             `json:"type" bson:"type"`
	NodeID                       string             `json:"nodeID" bson:"nodeID"`
	Synced                       bool               `json:"synced" bson:"synced"`
	MetricsLevel                 uint8              `json:"metricsLevel" bson:"metricsLevel"`
	QueueLengthPerNode           map[string]uint32  `json:"queueLengthPerNode" bson:"queueLengthPerNode"`
	AManaNormalizedLengthPerNode map[string]float64 `json:"aManaNormalizedQueueLengthPerNode" bson:"aManaNormalizedQueueLengthPerNode"`
	BufferSize                   uint32             `json:"bufferSize" bson:"bufferSize"`
	BufferLength                 uint32             `json:"bufferLength" bson:"bufferLength"`
	ReadyBlocksInBuffer          uint32             `json:"readyBlocksInBuffer" bson:"readyBlocksInBuffer"`
	Timestamp                    time.Time          `json:"timestamp" bson:"timestamp"`
}

SchedulerMetrics defines the schedule metrics sent to the remote logger.

type SchedulerQueryEvent

type SchedulerQueryEvent struct {
	Time time.Time
}

SchedulerQueryEvent is used to trigger scheduler metric collection for remote metric monitoring.

type TangleTimeSyncChangedEvent

type TangleTimeSyncChangedEvent struct {
	// Type defines the type of the block.
	Type string `json:"type" bson:"type"`
	// NodeID defines the ID of the node.
	NodeID string `json:"nodeid" bson:"nodeid"`
	// MetricsLevel defines the amount of metrics that are sent by the node.
	MetricsLevel uint8 `json:"metricsLevel" bson:"metricsLevel"`
	// Time defines the time when the sync status changed.
	Time time.Time `json:"datetime" bson:"datetime"`
	// CurrentStatus contains current sync status
	CurrentStatus bool `json:"currentStatus" bson:"currentStatus"`
	// PreviousStatus contains previous sync status
	PreviousStatus bool `json:"previousStatus" bson:"previousStatus"`
	// ATT contains time of the last accepted block
	ATT time.Time `json:"acceptanceTangleTime" bson:"acceptanceTangleTime"`
	// RATT contains relative time of the last accepted block
	RATT time.Time `json:"relativeAcceptanceTangleTime" bson:"relativeAcceptanceTangleTime"`
	// CTT contains time of the last confirmed block
	CTT time.Time `json:"confirmedTangleTime" bson:"confirmedTangleTime"`
	// RCTT contains relative time of the last confirmed block
	RCTT time.Time `json:"relativeConfirmedTangleTime" bson:"relativeConfirmedTangleTime"`
}

TangleTimeSyncChangedEvent is triggered by a node when its sync status changes. It is also structure that is sent to remote logger.