ui

Documentation

Index

• Constants
• type DataLine
  • func (dl *DataLine) Print()
  • func (dl *DataLine) SetVal(s string)
• type GooeyApp
  • func (a *GooeyApp) NewDataLine(line int, label, defval string) *DataLine
  • func (a *GooeyApp) Print()
• type Log
  • func NewLog(writer io.Writer, line, size int) *Log
  • func (l *Log) Add(m string)
  • func (l *Log) Print()
• type LogNotifee
  • func (ln *LogNotifee) ClosedStream(net.Network, net.Stream)
  • func (ln *LogNotifee) Connected(_ net.Network, c net.Conn)
  • func (ln *LogNotifee) Disconnected(_ net.Network, c net.Conn)
  • func (ln *LogNotifee) Listen(net.Network, ma.Multiaddr)
  • func (ln *LogNotifee) ListenClose(net.Network, ma.Multiaddr)
  • func (ln *LogNotifee) OpenedStream(net.Network, net.Stream)
• type Theme
• type UI
  • func NewUI(theme Theme, opts ...uiopts.Option) (*UI, error)
  • func (ui *UI) Render(ctx context.Context) error

Constants

const (
	QClrLine = "\033[K"
	QReset   = "\033[2J"
)

...

const (
	Clear     = 0
	LightBlue = 94
)

...

const (
	Black = 30 + iota
	Red
	Green
	Yellow
	Blue
	Magenta
	Cyan
	LightGray
)

...

Types

type DataLine

type DataLine struct {
	Label   string
	Line    int
	Default string
	LastVal string
	// contains filtered or unexported fields
}

DataLine ...

func (*DataLine) Print

func (dl *DataLine) Print()

Print ...

func (*DataLine) SetVal

func (dl *DataLine) SetVal(s string)

SetVal ...

type GooeyApp

type GooeyApp struct {
	Title      string
	DataFields []*DataLine
	Log        *Log
	// contains filtered or unexported fields
}

GooeyApp ..

func (*GooeyApp) NewDataLine

func (a *GooeyApp) NewDataLine(line int, label, defval string) *DataLine

NewDataLine ...

func (*GooeyApp) Print

func (a *GooeyApp) Print()

Print ...

type Log

type Log struct {
	Size      int
	StartLine int
	Messages  []string
	// contains filtered or unexported fields
}

Log ...

func NewLog

func NewLog(writer io.Writer, line, size int) *Log

NewLog ...

func (*Log) Add

func (l *Log) Add(m string)

Add ...

func (*Log) Print

func (l *Log) Print()

Print ...

type LogNotifee

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

LogNotifee ...

func (*LogNotifee) ClosedStream

func (ln *LogNotifee) ClosedStream(net.Network, net.Stream)

ClosedStream ...

func (*LogNotifee) Connected

func (ln *LogNotifee) Connected(_ net.Network, c net.Conn)

Connected ...

func (*LogNotifee) Disconnected

func (ln *LogNotifee) Disconnected(_ net.Network, c net.Conn)

Disconnected ...

func (*LogNotifee) Listen

func (ln *LogNotifee) Listen(net.Network, ma.Multiaddr)

Listen ...

func (*LogNotifee) ListenClose

func (ln *LogNotifee) ListenClose(net.Network, ma.Multiaddr)

ListenClose ...

func (*LogNotifee) OpenedStream

func (ln *LogNotifee) OpenedStream(net.Network, net.Stream)

OpenedStream ...

type Theme

type Theme int

Theme is the style of UI to render

const (
	// Logey is a UI theme that simply logs data periodically to stdout
	Logey Theme = iota
	// Gooey is a UI theme that refreshes values in place
	Gooey
)

type UI

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

UI is a simple command line interface to the Prometheus /metrics endpoint

func NewUI

func NewUI(theme Theme, opts ...uiopts.Option) (*UI, error)

NewUI constructs a new "UI" for the Prometheus /metrics endpoint

func (*UI) Render

func (ui *UI) Render(ctx context.Context) error

Render displays and updates a "UI" for the Prometheus /metrics endpoint