dashboard

Documentation

Index

• Constants
• Variables
• type ParametersDefinition

Constants

const (
	// MsgTypePing defines a ping message type.
	MsgTypePing byte = 0
	// MsgTypeAddNode defines an addNode update message for autopeering visualizer.
	MsgTypeAddNode byte = iota + 2 // backwards compatibility due to FPC removal.
	// MsgTypeRemoveNode defines a removeNode update message for autopeering visualizer.
	MsgTypeRemoveNode
	// MsgTypeConnectNodes defines a connectNodes update message for autopeering visualizer.
	MsgTypeConnectNodes
	// MsgTypeDisconnectNodes defines a disconnectNodes update message for autopeering visualizer.
	MsgTypeDisconnectNodes
)

const PluginName = "AnalysisDashboard"

PluginName is the name of the dashboard plugin.

Variables

var ErrForbidden = errors.New("forbidden")

ErrForbidden defines the forbidden error.

var ErrInternalError = errors.New("internal error")

ErrInternalError defines the internal error.

var ErrInvalidParameter = errors.New("invalid parameter")

ErrInvalidParameter defines the invalid parameter error.

var ErrNotFound = errors.New("not found")

ErrNotFound defines the not found error.

var Parameters = &ParametersDefinition{}

Parameters contains the configuration parameters of the dashboard plugin.

var (
	// Plugin is the plugin instance of the dashboard plugin.
	Plugin = node.NewPlugin(PluginName, deps, node.Disabled, configure, run)
)

Types

type ParametersDefinition

type ParametersDefinition struct {
	// BindAddress defines the analysis dashboard binding address.
	BindAddress string `default:"0.0.0.0:8000" usage:"the bind address of the analysis dashboard"`
	// Dev defines the analysis dashboard dev mode.
	Dev bool `default:"false" usage:"whether the analysis dashboard runs in dev mode"`
	// BasicAuthEnabled defines  the analysis dashboard basic auth enabler.
	BasicAuthEnabled bool `default:"false" usage:"whether to enable HTTP basic auth"`
	// BasicAuthUsername defines the analysis dashboard basic auth username.
	BasicAuthUsername string `default:"goshimmer" usage:"HTTP basic auth username"`
	// BasicAuthPassword defines the analysis dashboard basic auth password.
	BasicAuthPassword string `default:"goshimmer" usage:"HTTP basic auth password"`
	// ManaDashboardAddress defines the mana dashboard address to stream mana info from.
	ManaDashboardAddress string `default:"http://127.0.0.1:8081" usage:"dashboard host address"`
}

ParametersDefinition contains the definition of the parameters used by the dasbhoard plugin.