mirror of https://github.com/grafana/grafana
prometheushacktoberfestmetricsmonitoringalertinggrafanagoinfluxdbmysqlpostgresanalyticsdata-visualizationdashboardbusiness-intelligenceelasticsearch
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1064 lines
36 KiB
1064 lines
36 KiB
// This file is autogenerated. DO NOT EDIT.
|
|
//
|
|
// Generated by pkg/framework/coremodel/gen.go
|
|
//
|
|
// Derived from the Thema lineage declared in pkg/coremodel/dashboard/coremodel.cue
|
|
//
|
|
// Run `make gen-cue` from repository root to regenerate.
|
|
|
|
package dashboard
|
|
|
|
import (
|
|
"embed"
|
|
"path/filepath"
|
|
|
|
"github.com/grafana/grafana/pkg/cuectx"
|
|
"github.com/grafana/grafana/pkg/framework/coremodel"
|
|
"github.com/grafana/thema"
|
|
)
|
|
|
|
// Defines values for GraphTooltip.
|
|
const (
|
|
GraphTooltipN0 GraphTooltip = 0
|
|
|
|
GraphTooltipN1 GraphTooltip = 1
|
|
|
|
GraphTooltipN2 GraphTooltip = 2
|
|
)
|
|
|
|
// Defines values for Style.
|
|
const (
|
|
StyleDark Style = "dark"
|
|
|
|
StyleLight Style = "light"
|
|
)
|
|
|
|
// Defines values for Timezone.
|
|
const (
|
|
TimezoneBrowser Timezone = "browser"
|
|
|
|
TimezoneEmpty Timezone = ""
|
|
|
|
TimezoneUtc Timezone = "utc"
|
|
)
|
|
|
|
// Defines values for DashboardCursorSync.
|
|
const (
|
|
DashboardCursorSyncN0 DashboardCursorSync = 0
|
|
|
|
DashboardCursorSyncN1 DashboardCursorSync = 1
|
|
|
|
DashboardCursorSyncN2 DashboardCursorSync = 2
|
|
)
|
|
|
|
// Defines values for DashboardLinkType.
|
|
const (
|
|
DashboardLinkTypeDashboards DashboardLinkType = "dashboards"
|
|
|
|
DashboardLinkTypeLink DashboardLinkType = "link"
|
|
)
|
|
|
|
// Defines values for FieldColorModeId.
|
|
const (
|
|
FieldColorModeIdContinuousGrYlRd FieldColorModeId = "continuous-GrYlRd"
|
|
|
|
FieldColorModeIdFixed FieldColorModeId = "fixed"
|
|
|
|
FieldColorModeIdPaletteClassic FieldColorModeId = "palette-classic"
|
|
|
|
FieldColorModeIdPaletteSaturated FieldColorModeId = "palette-saturated"
|
|
|
|
FieldColorModeIdThresholds FieldColorModeId = "thresholds"
|
|
)
|
|
|
|
// Defines values for FieldColorSeriesByMode.
|
|
const (
|
|
FieldColorSeriesByModeLast FieldColorSeriesByMode = "last"
|
|
|
|
FieldColorSeriesByModeMax FieldColorSeriesByMode = "max"
|
|
|
|
FieldColorSeriesByModeMin FieldColorSeriesByMode = "min"
|
|
)
|
|
|
|
// Defines values for GraphPanelType.
|
|
const (
|
|
GraphPanelTypeGraph GraphPanelType = "graph"
|
|
)
|
|
|
|
// Defines values for HeatmapPanelType.
|
|
const (
|
|
HeatmapPanelTypeHeatmap HeatmapPanelType = "heatmap"
|
|
)
|
|
|
|
// Defines values for MappingType.
|
|
const (
|
|
MappingTypeRange MappingType = "range"
|
|
|
|
MappingTypeRegex MappingType = "regex"
|
|
|
|
MappingTypeSpecial MappingType = "special"
|
|
|
|
MappingTypeValue MappingType = "value"
|
|
)
|
|
|
|
// Defines values for PanelRepeatDirection.
|
|
const (
|
|
PanelRepeatDirectionH PanelRepeatDirection = "h"
|
|
|
|
PanelRepeatDirectionV PanelRepeatDirection = "v"
|
|
)
|
|
|
|
// Defines values for RangeMapType.
|
|
const (
|
|
RangeMapTypeRange RangeMapType = "range"
|
|
)
|
|
|
|
// Defines values for RegexMapType.
|
|
const (
|
|
RegexMapTypeRegex RegexMapType = "regex"
|
|
)
|
|
|
|
// Defines values for RowPanelType.
|
|
const (
|
|
RowPanelTypeRow RowPanelType = "row"
|
|
)
|
|
|
|
// Defines values for SpecialValueMapOptionsMatch.
|
|
const (
|
|
SpecialValueMapOptionsMatchFalse SpecialValueMapOptionsMatch = "false"
|
|
|
|
SpecialValueMapOptionsMatchTrue SpecialValueMapOptionsMatch = "true"
|
|
)
|
|
|
|
// Defines values for SpecialValueMapType.
|
|
const (
|
|
SpecialValueMapTypeSpecial SpecialValueMapType = "special"
|
|
)
|
|
|
|
// Defines values for SpecialValueMatch.
|
|
const (
|
|
SpecialValueMatchEmpty SpecialValueMatch = "empty"
|
|
|
|
SpecialValueMatchFalse SpecialValueMatch = "false"
|
|
|
|
SpecialValueMatchNan SpecialValueMatch = "nan"
|
|
|
|
SpecialValueMatchNull SpecialValueMatch = "null"
|
|
|
|
SpecialValueMatchNullNan SpecialValueMatch = "null+nan"
|
|
|
|
SpecialValueMatchTrue SpecialValueMatch = "true"
|
|
)
|
|
|
|
// Defines values for ThresholdsConfigMode.
|
|
const (
|
|
ThresholdsConfigModeAbsolute ThresholdsConfigMode = "absolute"
|
|
|
|
ThresholdsConfigModePercentage ThresholdsConfigMode = "percentage"
|
|
)
|
|
|
|
// Defines values for ThresholdsMode.
|
|
const (
|
|
ThresholdsModeAbsolute ThresholdsMode = "absolute"
|
|
|
|
ThresholdsModePercentage ThresholdsMode = "percentage"
|
|
)
|
|
|
|
// Defines values for ValueMapType.
|
|
const (
|
|
ValueMapTypeValue ValueMapType = "value"
|
|
)
|
|
|
|
// Defines values for VariableModelType.
|
|
const (
|
|
VariableModelTypeAdhoc VariableModelType = "adhoc"
|
|
|
|
VariableModelTypeConstant VariableModelType = "constant"
|
|
|
|
VariableModelTypeCustom VariableModelType = "custom"
|
|
|
|
VariableModelTypeDatasource VariableModelType = "datasource"
|
|
|
|
VariableModelTypeInterval VariableModelType = "interval"
|
|
|
|
VariableModelTypeQuery VariableModelType = "query"
|
|
|
|
VariableModelTypeSystem VariableModelType = "system"
|
|
|
|
VariableModelTypeTextbox VariableModelType = "textbox"
|
|
)
|
|
|
|
// Defines values for VariableType.
|
|
const (
|
|
VariableTypeAdhoc VariableType = "adhoc"
|
|
|
|
VariableTypeConstant VariableType = "constant"
|
|
|
|
VariableTypeCustom VariableType = "custom"
|
|
|
|
VariableTypeDatasource VariableType = "datasource"
|
|
|
|
VariableTypeInterval VariableType = "interval"
|
|
|
|
VariableTypeQuery VariableType = "query"
|
|
|
|
VariableTypeSystem VariableType = "system"
|
|
|
|
VariableTypeTextbox VariableType = "textbox"
|
|
)
|
|
|
|
// Model is the Go representation of a dashboard.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type Model struct {
|
|
Annotations *struct {
|
|
// TODO docs
|
|
List []AnnotationQuery `json:"list"`
|
|
} `json:"annotations,omitempty"`
|
|
|
|
// Description of dashboard.
|
|
Description *string `json:"description,omitempty"`
|
|
|
|
// Whether a dashboard is editable or not.
|
|
Editable bool `json:"editable"`
|
|
|
|
// TODO docs
|
|
FiscalYearStartMonth *int `json:"fiscalYearStartMonth,omitempty"`
|
|
GnetId *string `json:"gnetId,omitempty"`
|
|
GraphTooltip GraphTooltip `json:"graphTooltip"`
|
|
|
|
// Unique numeric identifier for the dashboard.
|
|
// TODO must isolate or remove identifiers local to a Grafana instance...?
|
|
Id *int64 `json:"id,omitempty"`
|
|
|
|
// TODO docs
|
|
Links *[]DashboardLink `json:"links,omitempty"`
|
|
|
|
// TODO docs
|
|
LiveNow *bool `json:"liveNow,omitempty"`
|
|
Panels *[]interface{} `json:"panels,omitempty"`
|
|
|
|
// TODO docs
|
|
Refresh *interface{} `json:"refresh,omitempty"`
|
|
|
|
// Version of the JSON schema, incremented each time a Grafana update brings
|
|
// changes to said schema.
|
|
// TODO this is the existing schema numbering system. It will be replaced by Thema's themaVersion
|
|
SchemaVersion int `json:"schemaVersion"`
|
|
|
|
// Theme of dashboard.
|
|
Style Style `json:"style"`
|
|
|
|
// Tags associated with dashboard.
|
|
Tags *[]string `json:"tags,omitempty"`
|
|
Templating *struct {
|
|
// TODO docs
|
|
List []VariableModel `json:"list"`
|
|
} `json:"templating,omitempty"`
|
|
|
|
// Time range for dashboard, e.g. last 6 hours, last 7 days, etc
|
|
Time *struct {
|
|
From string `json:"from"`
|
|
To string `json:"to"`
|
|
} `json:"time,omitempty"`
|
|
|
|
// TODO docs
|
|
// TODO this appears to be spread all over in the frontend. Concepts will likely need tidying in tandem with schema changes
|
|
Timepicker *struct {
|
|
// Whether timepicker is collapsed or not.
|
|
Collapse bool `json:"collapse"`
|
|
|
|
// Whether timepicker is enabled or not.
|
|
Enable bool `json:"enable"`
|
|
|
|
// Whether timepicker is visible or not.
|
|
Hidden bool `json:"hidden"`
|
|
|
|
// Selectable intervals for auto-refresh.
|
|
RefreshIntervals []string `json:"refresh_intervals"`
|
|
|
|
// TODO docs
|
|
TimeOptions []string `json:"time_options"`
|
|
} `json:"timepicker,omitempty"`
|
|
|
|
// Timezone of dashboard,
|
|
Timezone *Timezone `json:"timezone,omitempty"`
|
|
|
|
// Title of dashboard.
|
|
Title *string `json:"title,omitempty"`
|
|
|
|
// Unique dashboard identifier that can be generated by anyone. string (8-40)
|
|
Uid *string `json:"uid,omitempty"`
|
|
|
|
// Version of the dashboard, incremented each time the dashboard is updated.
|
|
Version *int `json:"version,omitempty"`
|
|
|
|
// TODO docs
|
|
WeekStart *string `json:"weekStart,omitempty"`
|
|
}
|
|
|
|
// GraphTooltip is the Go representation of a Model.GraphTooltip.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type GraphTooltip int
|
|
|
|
// Theme of dashboard.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type Style string
|
|
|
|
// Timezone of dashboard,
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type Timezone string
|
|
|
|
// TODO docs
|
|
// FROM: AnnotationQuery in grafana-data/src/types/annotations.ts
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type AnnotationQuery struct {
|
|
BuiltIn int `json:"builtIn"`
|
|
|
|
// Datasource to use for annotation.
|
|
Datasource struct {
|
|
Type *string `json:"type,omitempty"`
|
|
Uid *string `json:"uid,omitempty"`
|
|
} `json:"datasource"`
|
|
|
|
// Whether annotation is enabled.
|
|
Enable bool `json:"enable"`
|
|
|
|
// Whether to hide annotation.
|
|
Hide *bool `json:"hide,omitempty"`
|
|
|
|
// Annotation icon color.
|
|
IconColor *string `json:"iconColor,omitempty"`
|
|
|
|
// Name of annotation.
|
|
Name *string `json:"name,omitempty"`
|
|
|
|
// Query for annotation data.
|
|
RawQuery *string `json:"rawQuery,omitempty"`
|
|
ShowIn int `json:"showIn"`
|
|
|
|
// Schema for panel targets is specified by datasource
|
|
// plugins. We use a placeholder definition, which the Go
|
|
// schema loader either left open/as-is with the Base
|
|
// variant of the Model and Panel families, or filled
|
|
// with types derived from plugins in the Instance variant.
|
|
// When working directly from CUE, importers can extend this
|
|
// type directly to achieve the same effect.
|
|
Target *Target `json:"target,omitempty"`
|
|
Type string `json:"type"`
|
|
}
|
|
|
|
// 0 for no shared crosshair or tooltip (default).
|
|
// 1 for shared crosshair.
|
|
// 2 for shared crosshair AND shared tooltip.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type DashboardCursorSync int
|
|
|
|
// FROM public/app/features/dashboard/state/Models.ts - ish
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type DashboardLink struct {
|
|
AsDropdown bool `json:"asDropdown"`
|
|
Icon *string `json:"icon,omitempty"`
|
|
IncludeVars bool `json:"includeVars"`
|
|
KeepTime bool `json:"keepTime"`
|
|
Tags []string `json:"tags"`
|
|
TargetBlank bool `json:"targetBlank"`
|
|
Title string `json:"title"`
|
|
Tooltip *string `json:"tooltip,omitempty"`
|
|
Type DashboardLinkType `json:"type"`
|
|
Url *string `json:"url,omitempty"`
|
|
}
|
|
|
|
// DashboardLinkType is the Go representation of a DashboardLink.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type DashboardLinkType string
|
|
|
|
// DynamicConfigValue is the Go representation of a dashboard.DynamicConfigValue.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type DynamicConfigValue struct {
|
|
Id string `json:"id"`
|
|
Value *interface{} `json:"value,omitempty"`
|
|
}
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type FieldColor struct {
|
|
// Stores the fixed color value if mode is fixed
|
|
FixedColor *string `json:"fixedColor,omitempty"`
|
|
|
|
// The main color scheme mode
|
|
Mode interface{} `json:"mode"`
|
|
|
|
// TODO docs
|
|
SeriesBy *FieldColorSeriesByMode `json:"seriesBy,omitempty"`
|
|
}
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type FieldColorModeId string
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type FieldColorSeriesByMode string
|
|
|
|
// FieldConfig is the Go representation of a dashboard.FieldConfig.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type FieldConfig struct {
|
|
// TODO docs
|
|
Color *FieldColor `json:"color,omitempty"`
|
|
|
|
// custom is specified by the PanelFieldConfig field
|
|
// in panel plugin schemas.
|
|
Custom *map[string]interface{} `json:"custom,omitempty"`
|
|
|
|
// Significant digits (for display)
|
|
Decimals *float32 `json:"decimals,omitempty"`
|
|
|
|
// Human readable field metadata
|
|
Description *string `json:"description,omitempty"`
|
|
|
|
// The display value for this field. This supports template variables blank is auto
|
|
DisplayName *string `json:"displayName,omitempty"`
|
|
|
|
// This can be used by data sources that return and explicit naming structure for values and labels
|
|
// When this property is configured, this value is used rather than the default naming strategy.
|
|
DisplayNameFromDS *string `json:"displayNameFromDS,omitempty"`
|
|
|
|
// True if data source field supports ad-hoc filters
|
|
Filterable *bool `json:"filterable,omitempty"`
|
|
|
|
// The behavior when clicking on a result
|
|
Links *[]interface{} `json:"links,omitempty"`
|
|
|
|
// Convert input values into a display string
|
|
Mappings *[]ValueMapping `json:"mappings,omitempty"`
|
|
Max *float32 `json:"max,omitempty"`
|
|
Min *float32 `json:"min,omitempty"`
|
|
|
|
// Alternative to empty string
|
|
NoValue *string `json:"noValue,omitempty"`
|
|
|
|
// An explict path to the field in the datasource. When the frame meta includes a path,
|
|
// This will default to `${frame.meta.path}/${field.name}
|
|
//
|
|
// When defined, this value can be used as an identifier within the datasource scope, and
|
|
// may be used to update the results
|
|
Path *string `json:"path,omitempty"`
|
|
Thresholds *ThresholdsConfig `json:"thresholds,omitempty"`
|
|
|
|
// Numeric Options
|
|
Unit *string `json:"unit,omitempty"`
|
|
|
|
// True if data source can write a value to the path. Auth/authz are supported separately
|
|
Writeable *bool `json:"writeable,omitempty"`
|
|
}
|
|
|
|
// FieldConfigSource is the Go representation of a dashboard.FieldConfigSource.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type FieldConfigSource struct {
|
|
Defaults struct {
|
|
// TODO docs
|
|
Color *FieldColor `json:"color,omitempty"`
|
|
|
|
// custom is specified by the PanelFieldConfig field
|
|
// in panel plugin schemas.
|
|
Custom *map[string]interface{} `json:"custom,omitempty"`
|
|
|
|
// Significant digits (for display)
|
|
Decimals *float32 `json:"decimals,omitempty"`
|
|
|
|
// Human readable field metadata
|
|
Description *string `json:"description,omitempty"`
|
|
|
|
// The display value for this field. This supports template variables blank is auto
|
|
DisplayName *string `json:"displayName,omitempty"`
|
|
|
|
// This can be used by data sources that return and explicit naming structure for values and labels
|
|
// When this property is configured, this value is used rather than the default naming strategy.
|
|
DisplayNameFromDS *string `json:"displayNameFromDS,omitempty"`
|
|
|
|
// True if data source field supports ad-hoc filters
|
|
Filterable *bool `json:"filterable,omitempty"`
|
|
|
|
// The behavior when clicking on a result
|
|
Links *[]interface{} `json:"links,omitempty"`
|
|
|
|
// Convert input values into a display string
|
|
Mappings *[]ValueMapping `json:"mappings,omitempty"`
|
|
Max *float32 `json:"max,omitempty"`
|
|
Min *float32 `json:"min,omitempty"`
|
|
|
|
// Alternative to empty string
|
|
NoValue *string `json:"noValue,omitempty"`
|
|
|
|
// An explict path to the field in the datasource. When the frame meta includes a path,
|
|
// This will default to `${frame.meta.path}/${field.name}
|
|
//
|
|
// When defined, this value can be used as an identifier within the datasource scope, and
|
|
// may be used to update the results
|
|
Path *string `json:"path,omitempty"`
|
|
Thresholds *ThresholdsConfig `json:"thresholds,omitempty"`
|
|
|
|
// Numeric Options
|
|
Unit *string `json:"unit,omitempty"`
|
|
|
|
// True if data source can write a value to the path. Auth/authz are supported separately
|
|
Writeable *bool `json:"writeable,omitempty"`
|
|
} `json:"defaults"`
|
|
Overrides []struct {
|
|
Matcher struct {
|
|
Id string `json:"id"`
|
|
Options *interface{} `json:"options,omitempty"`
|
|
} `json:"matcher"`
|
|
Properties []struct {
|
|
Id string `json:"id"`
|
|
Value *interface{} `json:"value,omitempty"`
|
|
} `json:"properties"`
|
|
} `json:"overrides"`
|
|
}
|
|
|
|
// GraphPanel is the Go representation of a dashboard.GraphPanel.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type GraphPanel struct {
|
|
// Support for legacy graph and heatmap panels.
|
|
Type GraphPanelType `json:"type"`
|
|
}
|
|
|
|
// Support for legacy graph and heatmap panels.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type GraphPanelType string
|
|
|
|
// GridPos is the Go representation of a dashboard.GridPos.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type GridPos struct {
|
|
// Panel
|
|
H int `json:"h"`
|
|
|
|
// true if fixed
|
|
Static *bool `json:"static,omitempty"`
|
|
|
|
// Panel
|
|
W int `json:"w"`
|
|
|
|
// Panel x
|
|
X int `json:"x"`
|
|
|
|
// Panel y
|
|
Y int `json:"y"`
|
|
}
|
|
|
|
// HeatmapPanel is the Go representation of a dashboard.HeatmapPanel.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type HeatmapPanel struct {
|
|
Type HeatmapPanelType `json:"type"`
|
|
}
|
|
|
|
// HeatmapPanelType is the Go representation of a HeatmapPanel.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type HeatmapPanelType string
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type MappingType string
|
|
|
|
// MatcherConfig is the Go representation of a dashboard.MatcherConfig.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type MatcherConfig struct {
|
|
Id string `json:"id"`
|
|
Options *interface{} `json:"options,omitempty"`
|
|
}
|
|
|
|
// Model panels. Panels are canonically defined inline
|
|
// because they share a version timeline with the dashboard
|
|
// schema; they do not evolve independently.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type Panel struct {
|
|
// The datasource used in all targets.
|
|
Datasource *struct {
|
|
Type *string `json:"type,omitempty"`
|
|
Uid *string `json:"uid,omitempty"`
|
|
} `json:"datasource,omitempty"`
|
|
|
|
// Description.
|
|
Description *string `json:"description,omitempty"`
|
|
FieldConfig struct {
|
|
Defaults struct {
|
|
// TODO docs
|
|
Color *FieldColor `json:"color,omitempty"`
|
|
|
|
// custom is specified by the PanelFieldConfig field
|
|
// in panel plugin schemas.
|
|
Custom *map[string]interface{} `json:"custom,omitempty"`
|
|
|
|
// Significant digits (for display)
|
|
Decimals *float32 `json:"decimals,omitempty"`
|
|
|
|
// Human readable field metadata
|
|
Description *string `json:"description,omitempty"`
|
|
|
|
// The display value for this field. This supports template variables blank is auto
|
|
DisplayName *string `json:"displayName,omitempty"`
|
|
|
|
// This can be used by data sources that return and explicit naming structure for values and labels
|
|
// When this property is configured, this value is used rather than the default naming strategy.
|
|
DisplayNameFromDS *string `json:"displayNameFromDS,omitempty"`
|
|
|
|
// True if data source field supports ad-hoc filters
|
|
Filterable *bool `json:"filterable,omitempty"`
|
|
|
|
// The behavior when clicking on a result
|
|
Links *[]interface{} `json:"links,omitempty"`
|
|
|
|
// Convert input values into a display string
|
|
Mappings *[]ValueMapping `json:"mappings,omitempty"`
|
|
Max *float32 `json:"max,omitempty"`
|
|
Min *float32 `json:"min,omitempty"`
|
|
|
|
// Alternative to empty string
|
|
NoValue *string `json:"noValue,omitempty"`
|
|
|
|
// An explict path to the field in the datasource. When the frame meta includes a path,
|
|
// This will default to `${frame.meta.path}/${field.name}
|
|
//
|
|
// When defined, this value can be used as an identifier within the datasource scope, and
|
|
// may be used to update the results
|
|
Path *string `json:"path,omitempty"`
|
|
Thresholds *ThresholdsConfig `json:"thresholds,omitempty"`
|
|
|
|
// Numeric Options
|
|
Unit *string `json:"unit,omitempty"`
|
|
|
|
// True if data source can write a value to the path. Auth/authz are supported separately
|
|
Writeable *bool `json:"writeable,omitempty"`
|
|
} `json:"defaults"`
|
|
Overrides []struct {
|
|
Matcher struct {
|
|
Id string `json:"id"`
|
|
Options *interface{} `json:"options,omitempty"`
|
|
} `json:"matcher"`
|
|
Properties []struct {
|
|
Id string `json:"id"`
|
|
Value *interface{} `json:"value,omitempty"`
|
|
} `json:"properties"`
|
|
} `json:"overrides"`
|
|
} `json:"fieldConfig"`
|
|
GridPos *GridPos `json:"gridPos,omitempty"`
|
|
|
|
// TODO docs
|
|
Id *int `json:"id,omitempty"`
|
|
|
|
// TODO docs
|
|
// TODO tighter constraint
|
|
Interval *string `json:"interval,omitempty"`
|
|
|
|
// Panel links.
|
|
// TODO fill this out - seems there are a couple variants?
|
|
Links *[]DashboardLink `json:"links,omitempty"`
|
|
|
|
// TODO docs
|
|
MaxDataPoints *float32 `json:"maxDataPoints,omitempty"`
|
|
|
|
// options is specified by the PanelOptions field in panel
|
|
// plugin schemas.
|
|
Options map[string]interface{} `json:"options"`
|
|
|
|
// FIXME this almost certainly has to be changed in favor of scuemata versions
|
|
PluginVersion *string `json:"pluginVersion,omitempty"`
|
|
|
|
// Name of template variable to repeat for.
|
|
Repeat *string `json:"repeat,omitempty"`
|
|
|
|
// Direction to repeat in if 'repeat' is set.
|
|
// "h" for horizontal, "v" for vertical.
|
|
RepeatDirection PanelRepeatDirection `json:"repeatDirection"`
|
|
|
|
// TODO docs
|
|
Tags *[]string `json:"tags,omitempty"`
|
|
|
|
// TODO docs
|
|
Targets *[]Target `json:"targets,omitempty"`
|
|
|
|
// TODO docs - seems to be an old field from old dashboard alerts?
|
|
Thresholds *[]interface{} `json:"thresholds,omitempty"`
|
|
|
|
// TODO docs
|
|
// TODO tighter constraint
|
|
TimeFrom *string `json:"timeFrom,omitempty"`
|
|
|
|
// TODO docs
|
|
TimeRegions *[]interface{} `json:"timeRegions,omitempty"`
|
|
|
|
// TODO docs
|
|
// TODO tighter constraint
|
|
TimeShift *string `json:"timeShift,omitempty"`
|
|
|
|
// Panel title.
|
|
Title *string `json:"title,omitempty"`
|
|
Transformations []struct {
|
|
Id string `json:"id"`
|
|
Options map[string]interface{} `json:"options"`
|
|
} `json:"transformations"`
|
|
|
|
// Whether to display the panel without a background.
|
|
Transparent bool `json:"transparent"`
|
|
|
|
// The panel plugin type id. May not be empty.
|
|
Type string `json:"type"`
|
|
}
|
|
|
|
// Direction to repeat in if 'repeat' is set.
|
|
// "h" for horizontal, "v" for vertical.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type PanelRepeatDirection string
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type RangeMap struct {
|
|
Options struct {
|
|
// to and from are `number | null` in current ts, really not sure what to do
|
|
From int32 `json:"from"`
|
|
Result struct {
|
|
Color *string `json:"color,omitempty"`
|
|
Icon *string `json:"icon,omitempty"`
|
|
Index *int32 `json:"index,omitempty"`
|
|
Text *string `json:"text,omitempty"`
|
|
} `json:"result"`
|
|
To int32 `json:"to"`
|
|
} `json:"options"`
|
|
Type RangeMapType `json:"type"`
|
|
}
|
|
|
|
// RangeMapType is the Go representation of a RangeMap.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type RangeMapType string
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type RegexMap struct {
|
|
Options struct {
|
|
Pattern string `json:"pattern"`
|
|
Result struct {
|
|
Color *string `json:"color,omitempty"`
|
|
Icon *string `json:"icon,omitempty"`
|
|
Index *int32 `json:"index,omitempty"`
|
|
Text *string `json:"text,omitempty"`
|
|
} `json:"result"`
|
|
} `json:"options"`
|
|
Type RegexMapType `json:"type"`
|
|
}
|
|
|
|
// RegexMapType is the Go representation of a RegexMap.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type RegexMapType string
|
|
|
|
// Row panel
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type RowPanel struct {
|
|
Collapsed bool `json:"collapsed"`
|
|
|
|
// Name of default datasource.
|
|
Datasource *struct {
|
|
Type *string `json:"type,omitempty"`
|
|
Uid *string `json:"uid,omitempty"`
|
|
} `json:"datasource,omitempty"`
|
|
GridPos *GridPos `json:"gridPos,omitempty"`
|
|
Id int `json:"id"`
|
|
Panels []interface{} `json:"panels"`
|
|
|
|
// Name of template variable to repeat for.
|
|
Repeat *string `json:"repeat,omitempty"`
|
|
Title *string `json:"title,omitempty"`
|
|
Type RowPanelType `json:"type"`
|
|
}
|
|
|
|
// RowPanelType is the Go representation of a RowPanel.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type RowPanelType string
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type SpecialValueMap struct {
|
|
Options struct {
|
|
Match SpecialValueMapOptionsMatch `json:"match"`
|
|
Pattern string `json:"pattern"`
|
|
Result struct {
|
|
Color *string `json:"color,omitempty"`
|
|
Icon *string `json:"icon,omitempty"`
|
|
Index *int32 `json:"index,omitempty"`
|
|
Text *string `json:"text,omitempty"`
|
|
} `json:"result"`
|
|
} `json:"options"`
|
|
Type SpecialValueMapType `json:"type"`
|
|
}
|
|
|
|
// SpecialValueMapOptionsMatch is the Go representation of a SpecialValueMap.Options.Match.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type SpecialValueMapOptionsMatch string
|
|
|
|
// SpecialValueMapType is the Go representation of a SpecialValueMap.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type SpecialValueMapType string
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type SpecialValueMatch string
|
|
|
|
// Schema for panel targets is specified by datasource
|
|
// plugins. We use a placeholder definition, which the Go
|
|
// schema loader either left open/as-is with the Base
|
|
// variant of the Model and Panel families, or filled
|
|
// with types derived from plugins in the Instance variant.
|
|
// When working directly from CUE, importers can extend this
|
|
// type directly to achieve the same effect.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type Target map[string]interface{}
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type Threshold struct {
|
|
// TODO docs
|
|
Color string `json:"color"`
|
|
|
|
// TODO docs
|
|
// TODO are the values here enumerable into a disjunction?
|
|
// Some seem to be listed in typescript comment
|
|
State *string `json:"state,omitempty"`
|
|
|
|
// TODO docs
|
|
// FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON
|
|
Value *float32 `json:"value,omitempty"`
|
|
}
|
|
|
|
// ThresholdsConfig is the Go representation of a dashboard.ThresholdsConfig.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type ThresholdsConfig struct {
|
|
Mode ThresholdsConfigMode `json:"mode"`
|
|
|
|
// Must be sorted by 'value', first value is always -Infinity
|
|
Steps []struct {
|
|
// TODO docs
|
|
Color string `json:"color"`
|
|
|
|
// TODO docs
|
|
// TODO are the values here enumerable into a disjunction?
|
|
// Some seem to be listed in typescript comment
|
|
State *string `json:"state,omitempty"`
|
|
|
|
// TODO docs
|
|
// FIXME the corresponding typescript field is required/non-optional, but nulls currently appear here when serializing -Infinity to JSON
|
|
Value *float32 `json:"value,omitempty"`
|
|
} `json:"steps"`
|
|
}
|
|
|
|
// ThresholdsConfigMode is the Go representation of a ThresholdsConfig.Mode.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type ThresholdsConfigMode string
|
|
|
|
// ThresholdsMode is the Go representation of a dashboard.ThresholdsMode.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type ThresholdsMode string
|
|
|
|
// TODO docs
|
|
// FIXME this is extremely underspecfied; wasn't obvious which typescript types corresponded to it
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type Transformation struct {
|
|
Id string `json:"id"`
|
|
Options map[string]interface{} `json:"options"`
|
|
}
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type ValueMap struct {
|
|
Options map[string]interface{} `json:"options"`
|
|
Type ValueMapType `json:"type"`
|
|
}
|
|
|
|
// ValueMapType is the Go representation of a ValueMap.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type ValueMapType string
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type ValueMapping interface{}
|
|
|
|
// TODO docs
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type ValueMappingResult struct {
|
|
Color *string `json:"color,omitempty"`
|
|
Icon *string `json:"icon,omitempty"`
|
|
Index *int32 `json:"index,omitempty"`
|
|
Text *string `json:"text,omitempty"`
|
|
}
|
|
|
|
// FROM: packages/grafana-data/src/types/templateVars.ts
|
|
// TODO docs
|
|
// TODO what about what's in public/app/features/types.ts?
|
|
// TODO there appear to be a lot of different kinds of [template] vars here? if so need a disjunction
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type VariableModel struct {
|
|
Label *string `json:"label,omitempty"`
|
|
Name string `json:"name"`
|
|
Type VariableModelType `json:"type"`
|
|
}
|
|
|
|
// VariableModelType is the Go representation of a VariableModel.Type.
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type VariableModelType string
|
|
|
|
// FROM: packages/grafana-data/src/types/templateVars.ts
|
|
// TODO docs
|
|
// TODO this implies some wider pattern/discriminated union, probably?
|
|
//
|
|
// THIS TYPE IS INTENDED FOR INTERNAL USE BY THE GRAFANA BACKEND, AND IS SUBJECT TO BREAKING CHANGES.
|
|
// Equivalent Go types at stable import paths are provided in https://github.com/grafana/grok.
|
|
type VariableType string
|
|
|
|
//go:embed coremodel.cue
|
|
var cueFS embed.FS
|
|
|
|
// The current version of the coremodel schema, as declared in coremodel.cue.
|
|
// This version determines what schema version is returned from [Coremodel.CurrentSchema],
|
|
// and which schema version is used for code generation within the grafana/grafana repository.
|
|
//
|
|
// The code generator ensures that this is always the latest Thema schema version.
|
|
var currentVersion = thema.SV(0, 0)
|
|
|
|
// Lineage returns the Thema lineage representing a Grafana dashboard.
|
|
//
|
|
// The lineage is the canonical specification of the current dashboard schema,
|
|
// all prior schema versions, and the mappings that allow migration between
|
|
// schema versions.
|
|
func Lineage(lib thema.Library, opts ...thema.BindOption) (thema.Lineage, error) {
|
|
return cuectx.LoadGrafanaInstancesWithThema(filepath.Join("pkg", "coremodel", "dashboard"), cueFS, lib, opts...)
|
|
}
|
|
|
|
var _ thema.LineageFactory = Lineage
|
|
var _ coremodel.Interface = &Coremodel{}
|
|
|
|
// Coremodel contains the foundational schema declaration for dashboards.
|
|
// It implements coremodel.Interface.
|
|
type Coremodel struct {
|
|
lin thema.Lineage
|
|
}
|
|
|
|
// Lineage returns the canonical dashboard Lineage.
|
|
func (c *Coremodel) Lineage() thema.Lineage {
|
|
return c.lin
|
|
}
|
|
|
|
// CurrentSchema returns the current (latest) dashboard Thema schema.
|
|
func (c *Coremodel) CurrentSchema() thema.Schema {
|
|
return thema.SchemaP(c.lin, currentVersion)
|
|
}
|
|
|
|
// GoType returns a pointer to an empty Go struct that corresponds to
|
|
// the current Thema schema.
|
|
func (c *Coremodel) GoType() interface{} {
|
|
return &Model{}
|
|
}
|
|
|
|
// New returns a new instance of the dashboard coremodel.
|
|
//
|
|
// Note that this function does not cache, and initially loading a Thema lineage
|
|
// can be expensive. As such, the Grafana backend should prefer to access this
|
|
// coremodel through a registry (pkg/framework/coremodel/registry), which does cache.
|
|
func New(lib thema.Library) (*Coremodel, error) {
|
|
lin, err := Lineage(lib)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &Coremodel{
|
|
lin: lin,
|
|
}, nil
|
|
}
|
|
|