obsdash

type Agg string

type AlertDefaultInfo struct {
	ID       string `json:"id"`
	Alert    string `json:"alert"`
	Title    string `json:"title"`
	Severity string `json:"severity"`
	For      string `json:"for"`
	Interval string `json:"interval"`
	// Signal is where the default reads: metrics, traces, metadata (the node
	// agent's customer metadata) or platform (the control plane's own events).
	Signal string `json:"signal"`
	// Requires names the observability category whose opt-out leaves the
	// default nothing to read ("metadata"). Empty = always applicable.
	Requires string `json:"requires,omitempty"`
	// AlertNames are further rule names the default also takes, beyond Alert.
	AlertNames []string     `json:"alert_names,omitempty"`
	Params     []AlertParam `json:"params"`
}

type AlertDefaultsDoc struct {
	Version  string             `json:"version"`
	Input    AlertInput         `json:"input"`
	Defaults []AlertDefaultInfo `json:"defaults"`
}

type AlertInput struct {
	Project string `json:"project"`
	// Services are the project's services that have at least one rpc.
	Services []AlertService `json:"services"`
	// FrontendService is the browser SDK's service.name ("<project>-frontend"),
	// empty when the project has no web frontend.
	FrontendService string `json:"frontend_service,omitempty"`
}

type AlertParam struct {
	Name    string  `json:"name"`
	Default float64 `json:"default"`
	Doc     string  `json:"doc"`
}

type AlertRule struct {
	ID          string
	Alert       string
	Expr        string
	For         string
	Interval    string
	Labels      map[string]string
	Annotations map[string]string
}

type AlertService struct {
	Name       string `json:"name"`
	RPCService string `json:"rpc_service"`
}

type AlertSkip struct{ ID, Reason string }

type AlertTuning struct {
	Enabled bool
	Labels  map[string]string
	For     string
	Params  map[string]float64
}

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

type AnnotationSource string

type BundleDashboard struct {
	// Name is the file name without ".json", and without "_gen" for a
	// generated one: the key a project file overrides by.
	Name   string
	Source BundleDashboardSource
	// Path is the file's path inside the bundle.
	Path string
	// Dashboard is the parsed content; Data is the exact bytes shipped.
	Dashboard Dashboard
	Data      []byte
}

type BundleDashboardSource string

type BundleFile struct {
	Path string
	Data []byte
}

type BundleSet struct {
	Dashboards []BundleDashboard
	// MetricsSchema is the raw forge.metrics/v1 document, or nil.
	MetricsSchema []byte
	// Notes are things worth telling the person cutting the release (a
	// HyperDX-only file that was not shipped).
	Notes []string
}

type BundleSetInput struct {
	// ProjectDir is the project root; the project's name is the one
	// dashboard-spec_gen.json records.
	ProjectDir string
	// MetricsSchema is the raw metrics schema the build produced, or nil.
	MetricsSchema []byte
}

type Dashboard struct {
	ID          string       `json:"id"`
	Title       string       `json:"title"`
	Description string       `json:"description,omitempty"`
	Filters     []Filter     `json:"filters,omitempty"`
	Annotations []Annotation `json:"annotations,omitempty"`
	Panels      []Panel      `json:"panels"`
}

type Filter struct {
	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 HyperDXChart struct {
	Name          string            `json:"name"`
	Source        string            `json:"source"`
	DisplayType   string            `json:"displayType"`
	Select        any               `json:"select"` // []HyperDXSelect, or a column string for a search tile
	Where         string            `json:"where"`
	WhereLanguage string            `json:"whereLanguage"`
	GroupBy       string            `json:"groupBy,omitempty"`
	Granularity   string            `json:"granularity,omitempty"`
	SeriesReturn  string            `json:"seriesReturnType,omitempty"`
	NumberFormat  *HyperDXNumFormat `json:"numberFormat,omitempty"`
	Align         *bool             `json:"alignDateRangeToGranularity,omitempty"`
}

type HyperDXDashboard struct {
	Name    string          `json:"name"`
	Tags    []string        `json:"tags"`
	Tiles   []HyperDXTile   `json:"tiles"`
	Filters []HyperDXFilter `json:"filters,omitempty"`
}

type HyperDXFilter struct {
	ID            string `json:"id"`
	Type          string `json:"type"`
	Name          string `json:"name"`
	Expression    string `json:"expression"`
	Source        string `json:"source"`
	WhereLanguage string `json:"whereLanguage"`
}

type HyperDXNumFormat struct {
	Output            string `json:"output"`
	Mantissa          *int   `json:"mantissa,omitempty"`
	ThousandSeparated bool   `json:"thousandSeparated,omitempty"`
	Unit              string `json:"unit,omitempty"`
}

type HyperDXSavedSearch struct {
	Name          string   `json:"name"`
	Source        string   `json:"source"`
	Select        string   `json:"select"`
	Where         string   `json:"where"`
	WhereLanguage string   `json:"whereLanguage"`
	OrderBy       string   `json:"orderBy"`
	Tags          []string `json:"tags"`
}

type HyperDXSelect struct {
	AggFn         string            `json:"aggFn"`
	Level         float64           `json:"level,omitempty"`
	ValueExpr     string            `json:"valueExpression"`
	AggCondition  string            `json:"aggCondition,omitempty"`
	AggCondLang   string            `json:"aggConditionLanguage,omitempty"`
	Alias         string            `json:"alias,omitempty"`
	MetricName    string            `json:"metricName,omitempty"`
	MetricType    string            `json:"metricType,omitempty"`
	NumberFormatP *HyperDXNumFormat `json:"numberFormat,omitempty"`
}

type HyperDXTile struct {
	ID     string       `json:"id"`
	X      int          `json:"x"`
	Y      int          `json:"y"`
	W      int          `json:"w"`
	H      int          `json:"h"`
	Config HyperDXChart `json:"config"`
}

type Input struct {
	Project   string
	Services  []Service
	Frontends []string
	// HasDatabase adds the database panels: true once the project has a
	// migration, since the panels read spans the ORM's query hook emits.
	HasDatabase bool
}

type Method struct {
	Name string
}

type Op string

type Panel struct {
	ID          string    `json:"id"`
	Title       string    `json:"title"`
	Description string    `json:"description,omitempty"`
	Kind        PanelKind `json:"kind"`
	Signal      Signal    `json:"signal"`
	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"`
	// 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"`
	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 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 Rendered struct {
	File    string
	Content []byte
}

type SavedSearch struct {
	ID      string      `json:"id"`
	Title   string      `json:"title"`
	Signal  Signal      `json:"signal"`
	Where   []Predicate `json:"where"`
	Columns []string    `json:"columns,omitempty"`
}

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" or "gauge" (metrics only).
	MetricType string `json:"metricType,omitempty"`
	// Where narrows this series alone (e.g. only the failed requests).
	Where []Predicate `json:"where,omitempty"`
}

type Service struct {
	// Name is the short service name used in file names and titles
	// ("orders").
	Name string
	// Package is the proto package ("orders.v1"); ProtoService the proto
	// service name ("OrdersService"). Together they give the procedure
	// "orders.v1.OrdersService/GetOrder" the RPC interceptors name spans by.
	Package      string
	ProtoService string
	Methods      []Method
}

type Signal string

type Spec struct {
	Version       string        `json:"version"`
	Project       string        `json:"project"`
	Dashboards    []Dashboard   `json:"dashboards"`
	SavedSearches []SavedSearch `json:"savedSearches"`
}

type Unit string