charts

type Board struct {
	Title string
	About string
	// Sections is read on every render, so it can follow services that
	// start and stop.
	Sections func() []Section
	// Summary, when set, is a table shown before the sections.
	Summary func() *Table
	Log     logrus.FieldLogger
	// Separate keeps each section's process charts in it, for sections that
	// are separate processes, such as the visors of a hypervisor.
	Separate bool
	// contains filtered or unexported fields
}

type Chart struct {
	Title  string
	Note   string
	Kind   Kind
	From   time.Time
	To     time.Time
	Times  []time.Time
	Series []Series
	// Format renders a value. Count is used when it is nil.
	Format func(float64) string
	// Dates labels the x axis and readout with dates only.
	Dates bool
	// Binary rounds the y axis to powers of 1024, for byte counts.
	Binary bool
	// Legend, when set, draws the legend as a table with these column headers.
	// The first column is the series name and the last is its latest value.
	Legend []string
	// Process marks a chart of the whole process rather than one service. A
	// Board draws these once, not in each section of a service sharing it.
	Process bool
	// Starts are the service's starts, drawn as markers where they fall in the chart's window.
	Starts []Start
	// contains filtered or unexported fields
}

type Collect func(ctx context.Context) (map[string]float64, error)

type Content struct {
	Charts []Chart
	Tables []Table
}

type Extra struct {
	Path    string
	Handler http.Handler
}

type Frame struct {
	Times []time.Time
	// contains filtered or unexported fields
}

type Kind int

type Link struct {
	Name string
	Href string
}

type NoteError string

type Page struct {
	Title string
	// About is a line under the title, such as the service's public key.
	About string
	// Links are other pages of the service, shown under the title.
	Links []Link
	// Extra are the pages Links point to, so a Board that shows this page
	// can serve them too.
	Extra []Extra
	Build func(ctx context.Context, r Range, now time.Time) (Content, error)
	// Stats, when set, adds the service's process and traffic charts after
	// Build's, read from Store.
	Stats *ServiceStats
	Store Store
	// Log, when set, records why a render failed; the client only sees a 503.
	Log logrus.FieldLogger
	// contains filtered or unexported fields
}

type Range struct {
	Name string
	Span time.Duration
	// Hourly reads the hourly means instead of the raw samples.
	Hourly bool
	// Bucket averages the samples down to this width.
	Bucket time.Duration
}

type Sample struct {
	At time.Time          `json:"-"`
	V  map[string]float64 `json:"v"`
}

type Section struct {
	Title string
	About string
	// Page is the service's charts. Nil shows the title, About and Note only.
	Page *Page
	// Note is shown under the title, such as why there are no charts.
	Note string
}

type Series struct {
	Name string
	// Title is shown on hover over the legend entry, such as a full key.
	Title string
	// Cells fill the columns named by the chart's Legend.
	Cells []string
	Vals  []float64
}

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

type Start struct {
	At      time.Time `json:"-"`
	Version string    `json:"version"`
	Commit  string    `json:"commit,omitempty"`
}

type Store interface {
	Add(ctx context.Context, s Sample) error
	// Range returns samples in [from, to), oldest first, from the hourly
	// series when hourly is set.
	Range(ctx context.Context, from, to time.Time, hourly bool) ([]Sample, error)
	// AddStart records a start of the service, and Starts returns those in [from, to).
	AddStart(ctx context.Context, s Start) error
	Starts(ctx context.Context, from, to time.Time) ([]Start, error)
}

type Table struct {
	Title string
	Note  string
	Head  []string
	Rows  [][]string
	// Marks, when set, gives a row a color to stand out in. Empty leaves it plain.
	Marks []string
	// Tall keeps a long table to a scrolling box with its header in view.
	Tall bool
}