Documentation
¶
Index ¶
- func SyncStatusChangedEventCaller(handler interface{}, params ...interface{})
- func TimeEventCaller(handler interface{}, params ...interface{})
- type BranchConfirmationMetrics
- type BranchCountUpdate
- type CollectionLogEvents
- type DRNGMetrics
- type MessageFinalizedMetrics
- type MessageScheduledMetrics
- type MissingMessageMetrics
- type SchedulerMetrics
- type SyncStatusChangedEvent
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SyncStatusChangedEventCaller ¶
func SyncStatusChangedEventCaller(handler interface{}, params ...interface{})
SyncStatusChangedEventCaller is called when a node changes its sync status.
func TimeEventCaller ¶
func TimeEventCaller(handler interface{}, params ...interface{})
TimeEventCaller is used everytime you want to send an event with a timestamp.
Types ¶
type BranchConfirmationMetrics ¶
type BranchConfirmationMetrics 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"`
MessageID string `json:"messageID" bson:"messageID"`
BranchID 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"`
}
BranchConfirmationMetrics defines the branch confirmation metrics record that is sent to remote logger.
type BranchCountUpdate ¶
type BranchCountUpdate struct {
Type string `json:"type" bson:"type"`
NodeID string `json:"nodeID" bson:"nodeID"`
MetricsLevel uint8 `json:"metricsLevel" bson:"metricsLevel"`
TotalBranchCount uint64 `json:"totalBranchCount" bson:"totalBranchCount"`
FinalizedBranchCount uint64 `json:"finalizedBranchCount" bson:"finalizedBranchCount"`
ConfirmedBranchCount uint64 `json:"confirmedBranchCount" bson:"confirmedBranchCount"`
InitialTotalBranchCount uint64 `json:"initialTotalBranchCount" bson:"initialTotalBranchCount"`
TotalBranchCountSinceStart uint64 `json:"totalBranchCountSinceStart" bson:"totalBranchCountSinceStart"`
InitialConfirmedBranchCount uint64 `json:"initialConfirmedBranchCount" bson:"initialConfirmedBranchCount"`
ConfirmedBranchCountSinceStart uint64 `json:"confirmedBranchCountSinceStart" bson:"confirmedBranchCountSinceStart"`
InitialFinalizedBranchCount uint64 `json:"initialFinalizedBranchCount" bson:"initialFinalizedBranchCount"`
FinalizedBranchCountSinceStart uint64 `json:"finalizedBranchCountSinceStart" bson:"finalizedBranchCountSinceStart"`
}
BranchCountUpdate defines the branch 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 *events.Event
SchedulerQuery *events.Event
}
CollectionLogEvents defines the events for the remotelogmetrics package.
type DRNGMetrics ¶
type DRNGMetrics struct {
Type string `json:"type" bson:"type"`
NodeID string `json:"nodeID" bson:"nodeID"`
MetricsLevel uint8 `json:"metricsLevel" bson:"metricsLevel"`
InstanceID uint32 `json:"instanceID" bson:"instanceID"`
Round uint64 `json:"round" bson:"round"`
IssuedTimestamp time.Time `json:"issuedTimestamp" bson:"issuedTimestamp"`
ReceivedTimestamp time.Time `json:"receivedTimestamp" bson:"receivedTimestamp"`
DeltaReceived int64 `json:"deltaReceived" bson:"deltaReceived"`
}
DRNGMetrics defines the DRNG metrics record that is sent to remote logger.
type MessageFinalizedMetrics ¶
type MessageFinalizedMetrics 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"`
MessageID string `json:"messageID" bson:"messageID"`
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"`
ShallowDislikeEdgeCount int `json:"shallowDislikeEdgeCount,omitempty" bson:"likeEdgeCount"`
}
MessageFinalizedMetrics defines the transaction metrics record that is sent to remote logger.
type MessageScheduledMetrics ¶
type MessageScheduledMetrics 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"`
MessageID string `json:"messageID" bson:"messageID"`
TransactionID string `json:"transactionID,omitempty" bson:"transactionID"`
// Time where the message was created by the issuing node
IssuedTimestamp time.Time `json:"issuedTimestamp" bson:"issuedTimestamp"`
// Time where the message 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"`
GradeOfFinalityTimestamp time.Time `json:"gradeOfFinalityTimestamp,omitempty" bson:"GradeOfFinalityTimestamp"`
GradeOfFinality uint8 `json:"gradeOfFinality" bson:"GradeOfFinality"`
DeltaGradeOfFinalityTime int64 `json:"deltaGradeOfFinalityTime" bson:"deltaGradeOfFinalityTime"`
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 float64 `json:"accessMana" bson:"accessMana"`
StrongEdgeCount int `json:"strongEdgeCount" bson:"strongEdgeCount"`
WeakEdgeCount int `json:"weakEdgeCount,omitempty" bson:"weakEdgeCount"`
LikeEdgeCount int `json:"likeEdgeCount,omitempty" bson:"likeEdgeCount"`
}
MessageScheduledMetrics defines the scheduling message confirmation metrics record that is sent to remote logger.
type MissingMessageMetrics ¶
type MissingMessageMetrics struct {
Type string `json:"type" bson:"type"`
NodeID string `json:"nodeID" bson:"nodeID"`
MetricsLevel uint8 `json:"metricsLevel" bson:"metricsLevel"`
MessageID string `json:"messageID" bson:"messageID"`
IssuerID string `json:"issuerID" bson:"issuerID"`
}
MissingMessageMetrics defines message 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"`
ReadyMessagesInBuffer uint32 `json:"readyMessagesInBuffer" bson:"readyMessagesInBuffer"`
Timestamp time.Time `json:"timestamp" bson:"timestamp"`
}
SchedulerMetrics defines the schedule metrics sent to the remote logger.
type SyncStatusChangedEvent ¶
type SyncStatusChangedEvent struct {
// Type defines the type of the message.
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"`
// LastConfirmedMessageTime contains time of the last confirmed message
LastConfirmedMessageTime time.Time `json:"lastConfirmedMessageTime" bson:"lastConfirmedMessageTime"`
}
SyncStatusChangedEvent is triggered by a node when its sync status changes. It is also structure that is sent to remote logger.
Source Files
Click to show internal directories.
Click to hide internal directories.