Documentation
¶
Overview ¶
Package dashboards stores the operator's own views over FlatRun's telemetry: which series they care about, arranged how they want them. The panels name what to draw; the data behind each one is fetched from whichever part of the agent owns it.
Index ¶
Constants ¶
const ( SourceContainer = "container" SourceServing = "serving" )
Panel sources. Container metrics come from the observability engine; serving metrics come from the proxy's record of real requests.
const ( ServingRequests = "requests" ServingErrors = "errors" ServingLatency = "latency" )
Serving series a panel can draw, named for what an operator is asking rather than for the column behind it.
const ( PanelLine = "line" PanelStat = "stat" )
Panel shapes.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Dashboard ¶
type Dashboard struct {
ID string `json:"id" yaml:"id"`
Name string `json:"name" yaml:"name"`
Panels []Panel `json:"panels" yaml:"panels"`
}
Dashboard is a named set of panels.
type Panel ¶
type Panel struct {
ID string `json:"id" yaml:"id"`
Title string `json:"title" yaml:"title"`
Source string `json:"source" yaml:"source"`
// Series is a container metric name for the container source, or one of the serving
// series for the serving source.
Series string `json:"series" yaml:"series"`
// Deployment scopes the panel. Empty means every deployment.
Deployment string `json:"deployment,omitempty" yaml:"deployment,omitempty"`
Type string `json:"type" yaml:"type"`
// Width is how many of the grid's twelve columns the panel takes.
Width int `json:"width" yaml:"width"`
}
Panel is one chart: a series, scoped to a deployment or to the whole host.
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store keeps dashboards in a flat file beside the rest of FlatRun's state, so they can be read, edited and copied between hosts without the UI.
Source Files