components

package
v1.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2026 License: MPL-2.0 Imports: 29 Imported by: 0

Documentation

Overview

Package components implements specific widgets for the dashboard.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FormatStatus added in v1.12.12 

func FormatStatus(status any) string

func FormatText added in v1.12.12 

func FormatText(text string, ok bool) string

Types

type BaseGraph 

type BaseGraph struct {
	tview.Primitive
	// contains filtered or unexported fields
}

BaseGraph represents the widget with some usage graph.

func NewBaseGraph 

func NewBaseGraph(title string, labels []string) *BaseGraph

NewBaseGraph initializes BaseGraph.

func NewCPUGraph 

func NewCPUGraph() *BaseGraph

NewCPUGraph creates CPU usage graph.

func NewLoadAvgGraph 

func NewLoadAvgGraph() *BaseGraph

NewLoadAvgGraph creates loadavg graph.

func NewMemGraph 

func NewMemGraph() *BaseGraph

NewMemGraph creates mem usage graph.

func (*BaseGraph) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type BaseSparklineGroup 

type BaseSparklineGroup struct {
	tview.Primitive
	// contains filtered or unexported fields
}

BaseSparklineGroup represents the widget with some sparklines.

func NewBaseSparklineGroup 

func NewBaseSparklineGroup(title string, labels, dataLabels []string) *BaseSparklineGroup

NewBaseSparklineGroup initializes BaseSparklineGroup.

func NewDiskSparkline 

func NewDiskSparkline() *BaseSparklineGroup

NewDiskSparkline creates disk sparkline.

func NewNetSparkline 

func NewNetSparkline() *BaseSparklineGroup

NewNetSparkline creates network sparkline.

func (*BaseSparklineGroup) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type CPUInfo 

type CPUInfo struct {
	tview.TextView
}

CPUInfo represents the widget with CPU info.

func NewCPUInfo 

func NewCPUInfo() *CPUInfo

NewCPUInfo initializes CPUInfo.

func (*CPUInfo) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type Diagnostics added in v1.8.0 

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

Diagnostics represents the diagnostics widget.

func NewDiagnostics added in v1.8.0 

func NewDiagnostics() *Diagnostics

NewDiagnostics initializes Diagnostics.

func (*Diagnostics) GetCurrentHeight added in v1.8.0 

func (widget *Diagnostics) GetCurrentHeight() int

GetCurrentHeight returns the height of the widget.

func (*Diagnostics) OnNodeSelect added in v1.8.0 

func (widget *Diagnostics) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*Diagnostics) OnResourceDataChange added in v1.8.0 

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

OnResourceDataChange implements the ResourceDataListener interface. 

type Footer struct {
	tview.TextView

	// NodeClick is called when a node label is clicked. May be nil.
	NodeClick func(node string)
	// ScreenClick is called when a screen label is clicked. May be nil.
	ScreenClick func(screen string)
	// contains filtered or unexported fields
}

Footer represents the top bar with host info.

func NewFooter 

func NewFooter(screenKeyToName map[string]string, nodes []string) *Footer

NewFooter initializes Footer.

func (*Footer) Draw added in v1.14.0 

func (widget *Footer) Draw(screen tcell.Screen)

Draw renders the footer, windowing the node list to the available width so the selected node and the screen tabs always stay visible.

func (*Footer) OnNodeSelect 

func (widget *Footer) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*Footer) Render added in v1.14.0 

func (widget *Footer) Render(width int)

Render rebuilds the footer text and the mouse-click hit regions for the given inner width.

The footer format is: [node1 | node2 | node3] --- [F1: Screen1] --- [Screen2] --- ... where the selected node/screen is highlighted in red.

The screens section (and the PAUSED indicator) is always rendered in full; the node list gets the remaining width and is windowed around the selected node so it stays visible. "‹"/"›" indicators are shown when nodes are hidden to the left/right. Hit regions track the x-offset ranges of each visible node and screen label.

func (*Footer) SelectScreen 

func (widget *Footer) SelectScreen(screen string)

SelectScreen refreshes the footer with the tabs and screens data.

func (*Footer) SetPaused added in v1.11.0 

func (widget *Footer) SetPaused(paused bool)

SetPaused refreshes the footer with the new paused state. 

type Header struct {
	tview.TextView
	// contains filtered or unexported fields
}

Header represents the top bar with host info.

func NewHeader 

func NewHeader() *Header

NewHeader initializes Header.

func (*Header) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

func (*Header) OnNodeSelect 

func (widget *Header) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*Header) OnResourceDataChange 

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

OnResourceDataChange implements the ResourceDataListener interface.

func (*Header) OnTick added in v1.12.0 

func (widget *Header) OnTick()

OnTick implements the TickerListener interface.

type HorizontalLine 

type HorizontalLine struct {
	tview.TextView
	// contains filtered or unexported fields
}

HorizontalLine is a widget that draws a horizontal line.

func NewHorizontalLine 

func NewHorizontalLine(label string) *HorizontalLine

NewHorizontalLine initializes HorizontalLine.

type KubernetesInfo 

type KubernetesInfo struct {
	tview.TextView
	// contains filtered or unexported fields
}

KubernetesInfo represents the kubernetes info widget.

func NewKubernetesInfo 

func NewKubernetesInfo() *KubernetesInfo

NewKubernetesInfo initializes KubernetesInfo.

func (*KubernetesInfo) Configured added in v1.14.0 

func (widget *KubernetesInfo) Configured() bool

Configured returns true if Kubernetes is configured on the selected node.

Kubernetes is assumed to be configured if the Kubernetes version was detected.

func (*KubernetesInfo) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

func (*KubernetesInfo) OnNodeSelect 

func (widget *KubernetesInfo) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*KubernetesInfo) OnResourceDataChange 

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

OnResourceDataChange implements the ResourceDataListener interface.

type LoadAvgInfo 

type LoadAvgInfo struct {
	tview.TextView
}

LoadAvgInfo represents the widget with load average info.

func NewLoadAvgInfo 

func NewLoadAvgInfo() *LoadAvgInfo

NewLoadAvgInfo initializes LoadAvgInfo.

func (*LoadAvgInfo) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type LogViewer 

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

LogViewer represents the logs widget.

func NewLogViewer 

func NewLogViewer(app *tview.Application) *LogViewer

NewLogViewer initializes LogViewer.

func (*LogViewer) WriteLog 

func (widget *LogViewer) WriteLog(logLine, logError string)

WriteLog writes the log line to the widget.

type MemInfo 

type MemInfo struct {
	tview.TextView
}

MemInfo represents the widget with memory info.

func NewMemInfo 

func NewMemInfo() *MemInfo

NewMemInfo initializes LoadAvgInfo.

func (*MemInfo) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type NetworkInfo 

type NetworkInfo struct {
	tview.TextView
	// contains filtered or unexported fields
}

NetworkInfo represents the network info widget.

func NewNetworkInfo 

func NewNetworkInfo() *NetworkInfo

NewNetworkInfo initializes NetworkInfo.

func (*NetworkInfo) OnNodeSelect 

func (widget *NetworkInfo) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*NetworkInfo) OnResourceDataChange 

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

OnResourceDataChange implements the ResourceDataListener interface.

type ProcessTable 

type ProcessTable struct {
	*tview.Table
	// contains filtered or unexported fields
}

ProcessTable represents the widget with process info.

func NewProcessTable 

func NewProcessTable() *ProcessTable

NewProcessTable initializes ProcessTable.

func (*ProcessTable) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type ProcsInfo 

type ProcsInfo struct {
	tview.TextView
}

ProcsInfo represents the widget with processes info.

func NewProcsInfo 

func NewProcsInfo() *ProcsInfo

NewProcsInfo initializes ProcsInfo.

func (*ProcsInfo) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type SystemGauges 

type SystemGauges struct {
	tview.Primitive
	// contains filtered or unexported fields
}

SystemGauges quickly show CPU/mem load.

func NewSystemGauges 

func NewSystemGauges() *SystemGauges

NewSystemGauges creates SystemGauges.

func (*SystemGauges) OnAPIDataChange 

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

OnAPIDataChange implements the APIDataListener interface.

type TalosInfo 

type TalosInfo struct {
	tview.TextView
	// contains filtered or unexported fields
}

TalosInfo represents the Talos info widget.

func NewTalosInfo 

func NewTalosInfo() *TalosInfo

NewTalosInfo initializes TalosInfo.

func (*TalosInfo) OnNodeSelect 

func (widget *TalosInfo) OnNodeSelect(node string)

OnNodeSelect implements the NodeSelectListener interface.

func (*TalosInfo) OnResourceDataChange 

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

OnResourceDataChange implements the ResourceDataListener interface.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.