dashboard

Documentation

Overview

Package dashboard implements a text-based UI dashboard.

Index

• func Run(ctx context.Context, cli *client.Client, opts ...Option) error
• type APIDataListener
• type Dashboard
• type LogDataListener
• type MonitorGrid
  • func NewMonitorGrid(app *tview.Application) *MonitorGrid
  • func (widget *MonitorGrid) OnAPIDataChange(node string, data *apidata.Data)
• type NetworkConfigGrid
  • func NewNetworkConfigGrid(ctx context.Context, app *tview.Application, pages *tview.Pages, ...) *NetworkConfigGrid
  • func (widget *NetworkConfigGrid) OnNodeSelect(node string)
  • func (widget *NetworkConfigGrid) OnResourceDataChange(data resourcedata.Data)
• type NodeSelectListener
• type NodeSetListener
• type Option
  • func WithAllowExitKeys(allowExitKeys bool) Option
  • func WithInterval(interval time.Duration) Option
  • func WithScreens(screens ...Screen) Option
• type ResourceDataListener
• type Screen
• type SummaryGrid
  • func NewSummaryGrid(app *tview.Application) *SummaryGrid
  • func (widget *SummaryGrid) OnAPIDataChange(node string, data *apidata.Data)
  • func (widget *SummaryGrid) OnLogDataChange(node string, logLine string)
  • func (widget *SummaryGrid) OnNodeSelect(node string)
  • func (widget *SummaryGrid) OnResourceDataChange(nodeResource resourcedata.Data)

Functions

func Run

func Run(ctx context.Context, cli *client.Client, opts ...Option) error

Run starts the dashboard.

Types

type APIDataListener

type APIDataListener interface {
	OnAPIDataChange(node string, data *apidata.Data)
}

APIDataListener is a listener which is notified when API-sourced data is updated.

type Dashboard

type Dashboard struct {
	// contains filtered or unexported fields
}

Dashboard implements the summary dashboard.

type LogDataListener

type LogDataListener interface {
	OnLogDataChange(node string, logLine string)
}

LogDataListener is a listener which is notified when a log line is received.

type MonitorGrid

type MonitorGrid struct {
	tview.Grid
	// contains filtered or unexported fields
}

MonitorGrid represents the monitoring grid with a process table and various metrics.

func NewMonitorGrid

func NewMonitorGrid(app *tview.Application) *MonitorGrid

NewMonitorGrid initializes MonitorGrid.

func (*MonitorGrid) OnAPIDataChange

func (widget *MonitorGrid) OnAPIDataChange(node string, data *apidata.Data)

OnAPIDataChange implements the APIDataListener interface.

type NetworkConfigGrid

type NetworkConfigGrid struct {
	tview.Grid
	// contains filtered or unexported fields
}

NetworkConfigGrid represents the network configuration widget.

func NewNetworkConfigGrid

func NewNetworkConfigGrid(ctx context.Context, app *tview.Application, pages *tview.Pages, cli *client.Client) *NetworkConfigGrid

NewNetworkConfigGrid initializes NetworkConfigGrid.

func (*NetworkConfigGrid) OnNodeSelect

func (widget *NetworkConfigGrid) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*NetworkConfigGrid) OnResourceDataChange

func (widget *NetworkConfigGrid) OnResourceDataChange(data resourcedata.Data)

OnResourceDataChange implements the ResourceDataListener interface.

type NodeSelectListener

type NodeSelectListener interface {
	OnNodeSelect(node string)
}

NodeSelectListener is a listener which is notified when a node is selected.

type NodeSetListener

type NodeSetListener interface {
	OnNodeSetChange(nodes []string)
}

NodeSetListener is a listener which is notified when the set of nodes changes.

type Option

type Option func(*options)

Option is a functional option for Dashboard.

func WithAllowExitKeys

func WithAllowExitKeys(allowExitKeys bool) Option

WithAllowExitKeys sets whether the dashboard should allow exit keys (Ctrl + C).

func WithInterval

func WithInterval(interval time.Duration) Option

WithInterval sets the interval for the dashboard.

func WithScreens

func WithScreens(screens ...Screen) Option

WithScreens sets the screens to display. The order is preserved.

type ResourceDataListener

type ResourceDataListener interface {
	OnResourceDataChange(data resourcedata.Data)
}

ResourceDataListener is a listener which is notified when a resource is updated.

type Screen

type Screen string

Screen is a dashboard screen.

const (

	// ScreenSummary is the summary screen.
	ScreenSummary Screen = "Summary"

	// ScreenMonitor is the monitor (metrics) screen.
	ScreenMonitor Screen = "Monitor"

	// ScreenNetworkConfig is the network configuration screen.
	ScreenNetworkConfig Screen = "Network Config"
)

type SummaryGrid

type SummaryGrid struct {
	tview.Grid
	// contains filtered or unexported fields
}

SummaryGrid represents the summary grid with the basic node information and the logs.

func NewSummaryGrid

func NewSummaryGrid(app *tview.Application) *SummaryGrid

NewSummaryGrid initializes SummaryGrid.

func (*SummaryGrid) OnAPIDataChange

func (widget *SummaryGrid) OnAPIDataChange(node string, data *apidata.Data)

OnAPIDataChange implements the APIDataListener interface.

func (*SummaryGrid) OnLogDataChange

func (widget *SummaryGrid) OnLogDataChange(node string, logLine string)

OnLogDataChange implements the LogDataListener interface.

func (*SummaryGrid) OnNodeSelect

func (widget *SummaryGrid) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*SummaryGrid) OnResourceDataChange

func (widget *SummaryGrid) OnResourceDataChange(nodeResource resourcedata.Data)

OnResourceDataChange implements the ResourceDataListener interface.