dashboardmetrics

Documentation

Index

• Constants
• Variables
• type DatabaseSizesMetric
• type GossipMetrics
• type NodeInfoExtended
• type ParametersNode

Constants

const (
	// RouteNodeInfoExtended is the route to get additional info about the node.
	// GET returns the extended info of the node.
	RouteNodeInfoExtended = "/info"

	// RouteDatabaseSizes is the route to get the size of the databases.
	// GET returns the sizes of the databases.
	RouteDatabaseSizes = "/database/sizes"

	// RouteGossipMetrics is the route to get metrics about gossip.
	// GET returns the gossip metrics.
	RouteGossipMetrics = "/gossip"
)

Variables

var (
	Component *app.Component
)

var ParamsNode = &ParametersNode{}

Types

type DatabaseSizesMetric

type DatabaseSizesMetric struct {
	Permanent  int64 `serix:""`
	Prunable   int64 `serix:""`
	TxRetainer int64 `serix:""`
	Total      int64 `serix:""`
	Time       int64 `serix:""`
}

DatabaseSizesMetric represents database size metrics.

type GossipMetrics

type GossipMetrics struct {
	Incoming uint32 `serix:""`
	New      uint32 `serix:""`
	Outgoing uint32 `serix:""`
}

GossipMetrics represents the metrics for blocks per second.

type NodeInfoExtended

type NodeInfoExtended struct {
	Version       string `serix:",lenPrefix=uint8"`
	LatestVersion string `serix:",lenPrefix=uint8"`
	Uptime        int64  `serix:""`
	NodeID        string `serix:",lenPrefix=uint8"`
	NodeAlias     string `serix:",lenPrefix=uint8"`
	MemoryUsage   int64  `serix:""`
}

NodeInfoExtended represents extended information about the node.

type ParametersNode

type ParametersNode struct {
	// Alias is used to set an alias to identify a node
	Alias string `default:"IOTA-Core node" usage:"set an alias to identify a node"`
}

ParametersNode contains the definition of the parameters used by the node.