dashspec

type Agg string

type Annotation struct {
	Source AnnotationSource `json:"source"`
	Label  string           `json:"label,omitempty"`
}

type AnnotationSource string

type Dashboard struct {
	// Scope is empty for ScopeProject.
	Scope       Scope     `json:"scope,omitempty"`
	Sections    []Section `json:"sections,omitempty"`
	ID          string    `json:"id"`
	Title       string    `json:"title"`
	Description string    `json:"description,omitempty"`
	// Group is the list section (see Group); Tags are free-form labels
	// (lowercase letters, digits, '.', '_' and '-', at most MaxTags).
	Group Group    `json:"group,omitempty"`
	Tags  []string `json:"tags,omitempty"`
	// Replaces lists the ids of dashboards this one supersedes (a renamed
	// generated dashboard, or several consolidated into one). A reader that
	// keeps per-dashboard state (stars, copies) moves it from a replaced id
	// to this one. It never changes what the dashboard draws.
	Replaces    []string     `json:"replaces,omitempty"`
	Filters     []Filter     `json:"filters,omitempty"`
	Annotations []Annotation `json:"annotations,omitempty"`
	// DefaultRange is the time range the dashboard opens on when the viewer
	// picked none: a number and a unit of s, m, h or d ("24h", "7d"), at most
	// MaxDefaultRange. A dashboard whose panels bucket by day declares "7d";
	// without it a renderer opens on its own default (an hour, in the console).
	// A renderer with fixed presets rounds up to the nearest one.
	DefaultRange string  `json:"defaultRange,omitempty"`
	Panels       []Panel `json:"panels"`
}

type Display struct {
	// Style is one of DisplayStyles(kind). Empty is the kind's default.
	Style DisplayStyle `json:"style,omitempty"`
	// Stack stacks the series, so the top edge is their total and each band
	// or bar segment is one series' share: a line or sql panel drawn as area
	// or bars, or a bar panel drawn as bars. Only additive values (counts,
	// sums, rates) add up to a meaningful whole; the author decides.
	Stack bool `json:"stack,omitempty"`
	// Horizontal lays a bar panel's bars along the y axis, which suits long
	// group names.
	Horizontal bool `json:"horizontal,omitempty"`
	// Min and Max are a gauge's scale. Min defaults to 0; Max is required
	// unless the panel's unit is percent, whose scale is 0 to 1.
	Min *float64 `json:"min,omitempty"`
	Max *float64 `json:"max,omitempty"`
	// TopN is how many series a line panel (or slices a pie or donut) draws
	// before folding the rest into one "Other": summed where the values add
	// up, left out where they do not. The full list stays a click away. Zero
	// is the reader's own default; at most MaxTopN.
	TopN int `json:"topN,omitempty"`
}

type DisplayStyle string

type Filter struct {
	// PanelIDs restricts this filter to declared panels. Empty preserves the
	// dashboard-wide default. RPC filters must not blank runtime/billing panels.
	PanelIDs []string `json:"panelIds,omitempty"`
	ID       string   `json:"id"`
	Label    string   `json:"label"`
	Field    string   `json:"field"`
	// Signal is the telemetry the dropdown reads its values from. Empty is
	// Traces, which every dashboard but the metrics ones draws.
	Signal Signal `json:"signal,omitempty"`
}

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

type Funnel struct {
	// Steps are product event names (the names passed to track()), in order.
	Steps []string `json:"steps"`
	// Window is how long a journey may take from its first step to its last:
	// a number and a unit of s, m, h or d ("1h", "7d"). Empty is "1h".
	Window string `json:"window,omitempty"`
	// By is the journey's identity. Empty is FunnelBySession.
	By FunnelBy `json:"by,omitempty"`
}

type FunnelBy string

type Group string

type Op string

type Panel struct {
	// Section is an optional declared dashboard section, for temporary viewer
	// toggles. Empty retains the unsectioned layout.
	Section     string    `json:"section,omitempty"`
	ID          string    `json:"id"`
	Title       string    `json:"title"`
	Description string    `json:"description,omitempty"`
	Kind        PanelKind `json:"kind"`
	// Signal is required on every kind but KindSQL, whose statement names its
	// own tables.
	Signal Signal   `json:"signal,omitempty"`
	Series []Series `json:"series,omitempty"`
	// Ratio makes a two-series line panel plot Series[0]/Series[1]
	// (an error rate is failed requests over all requests).
	Ratio bool `json:"ratio,omitempty"`
	// Formula makes a line or number panel plot one arithmetic expression
	// over its series instead of the series themselves: "A / B * 100", where
	// A is Series[0], B is Series[1], and so on (see ParseFormula). It is the
	// general form of Ratio, which a panel uses instead of, not with, it.
	Formula string `json:"formula,omitempty"`
	// Limit keeps the top Limit rows of a table or bar panel, largest
	// Series[0] first. Zero is DefaultBarLimit for a bar and the reader's own
	// row cap for a table; at most MaxLimit.
	Limit int `json:"limit,omitempty"`
	// SQL is a KindSQL panel's statement: one read-only SELECT over the
	// telemetry tables, which may use the SQLParam* query parameters. Only
	// that kind takes it.
	SQL string `json:"sql,omitempty"`
	// MinStep is the narrowest bucket a KindSQL panel's statement produces,
	// in the same form as DefaultRange ("1d"): set it when the statement
	// groups by a fixed bucket (toDate, toStartOfWeek) rather than by the
	// {step} parameter. A range shorter than two buckets can draw only one
	// point, so a renderer widens such a panel's range to hold two, and says
	// so. Only a sql panel takes it.
	MinStep string `json:"minStep,omitempty"`
	// Where narrows every series of the panel.
	Where   []Predicate `json:"where,omitempty"`
	GroupBy []string    `json:"groupBy,omitempty"`
	// Columns are the fields a KindSearch panel shows.
	Columns []string `json:"columns,omitempty"`
	// Funnel is what a KindFunnel panel draws; only that kind takes it.
	Funnel *Funnel `json:"funnel,omitempty"`
	// Postgres is the query a KindPostgres panel draws; only that kind takes
	// it, and it takes no Signal, Series or SQL.
	Postgres *PostgresQuery `json:"postgres,omitempty"`
	// HasError narrows a KindSessions panel to sessions that hit an error;
	// only that kind takes it.
	HasError bool `json:"hasError,omitempty"`
	// Markdown is a KindText panel's content (CommonMark with GFM tables and
	// links, at most MaxMarkdownBytes); only that kind takes it.
	Markdown string `json:"markdown,omitempty"`
	// Display picks how a line, bar, number or sql panel is drawn (see
	// Display); nil draws the kind's default.
	Display *Display `json:"display,omitempty"`
	Unit    Unit     `json:"unit,omitempty"`
	// Width is in grid columns out of 24; Height in rows. Zero takes the
	// default for the kind.
	Width  int `json:"width,omitempty"`
	Height int `json:"height,omitempty"`
}

type PanelKind string

type PostgresQuery struct {
	// Database names the database to run against: the same name as `forge db
	// query` takes (a DNS-label-like identifier of at most 63 bytes).
	Database string `json:"database"`
	// SQL is one SELECT, WITH, TABLE or VALUES statement that may use the
	// PostgresParam* parameters. Nothing a viewer picks is spliced into it.
	SQL string `json:"sql"`
	// Draw is how the result is drawn: PostgresDrawAuto (or empty), line,
	// number, table or bar. Auto draws a line when Time names a column, a
	// number for one row and one value, a table otherwise.
	Draw string `json:"draw,omitempty"`
	// Time names the result column holding each row's timestamp. A line
	// requires it.
	Time string `json:"time,omitempty"`
	// Values names the numeric result columns to plot. Empty means every
	// column that is not Time or in Group. A number takes at most one.
	Values []string `json:"values,omitempty"`
	// Group names the result columns that split rows into separate series.
	Group []string `json:"group,omitempty"`
}

type Predicate struct {
	Field  string   `json:"field"`
	Op     Op       `json:"op"`
	Value  string   `json:"value,omitempty"`
	Values []string `json:"values,omitempty"`
}

type Problem struct {
	// Line and Col are 1-based; zero when the position is unknown.
	Line, Col int
	// Path is where in the document: panels[2].series[0].agg.
	Path    string
	Message string
}

type Scope string

type Section struct {
	ID    string `json:"id"`
	Title string `json:"title"`
}

type Series struct {
	Label string `json:"label"`
	Agg   Agg    `json:"agg"`
	// Quantile is the level for AggQuantile, e.g. 0.95.
	Quantile float64 `json:"quantile,omitempty"`
	// Field is the aggregated value: a semantic field for traces and logs
	// (span.duration, span.attr.lcp), the metric NAME for metrics. Empty for
	// AggCount.
	Field string `json:"field,omitempty"`
	// MetricType is "sum", "gauge", "histogram", "exp_histogram" or "summary"
	// (metrics only).
	MetricType string `json:"metricType,omitempty"`
	// Where narrows this series alone (e.g. only the failed requests).
	Where []Predicate `json:"where,omitempty"`
	// Thresholds grade the series' values good / needs improvement / poor.
	Thresholds *Thresholds `json:"thresholds,omitempty"`
}

type Signal string

type Thresholds struct {
	Good float64 `json:"good"`
	Poor float64 `json:"poor"`
}

type Unit string