Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EditorMode ¶
type EditorMode string
Specifies which editor is being used to prepare the query. It can be "code" or "builder"
const ( EditorModeBuilder EditorMode = "builder" EditorModeCode EditorMode = "code" )
Defines values for EditorMode.
type Format ¶
type Format string
Query format to determine how to display data points in panel. It can be "time_series", "table", "heatmap"
type PromQueryFormat ¶
type PromQueryFormat string
PromQueryFormat defines model for PromQueryFormat.
const ( PromQueryFormatHeatmap PromQueryFormat = "heatmap" PromQueryFormatTable PromQueryFormat = "table" PromQueryFormatTimeSeries PromQueryFormat = "time_series" )
Defines values for PromQueryFormat.
type PrometheusDataQuery ¶
type PrometheusDataQuery struct {
// For mixed data sources the selected datasource is on the query level.
// For non mixed scenarios this is undefined.
// TODO find a better way to do this ^ that's friendly to schema
// TODO this shouldn't be unknown but DataSourceRef | null
Datasource *interface{} `json:"datasource,omitempty"`
// Specifies which editor is being used to prepare the query. It can be "code" or "builder"
EditorMode *EditorMode `json:"editorMode,omitempty"`
// Execute an additional query to identify interesting raw samples relevant for the given expr
Exemplar *bool `json:"exemplar,omitempty"`
// The actual expression/query that will be evaluated by Prometheus
Expr string `json:"expr"`
// Query format to determine how to display data points in panel. It can be "time_series", "table", "heatmap"
Format *Format `json:"format,omitempty"`
// Hide true if query is disabled (ie should not be returned to the dashboard)
// Note this does not always imply that the query should not be executed since
// the results from a hidden query may be used as the input to other queries (SSE etc)
Hide *bool `json:"hide,omitempty"`
// Returns only the latest value that Prometheus has scraped for the requested time series
Instant *bool `json:"instant,omitempty"`
// Specify the query flavor
// TODO make this required and give it a default
QueryType *string `json:"queryType,omitempty"`
// Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series
Range *bool `json:"range,omitempty"`
// A unique identifier for the query within the list of targets.
// In server side expressions, the refId is used as a variable name to identify results.
// By default, the UI will assign A->Z; however setting meaningful names may be useful.
RefId string `json:"refId"`
}
PrometheusDataQuery defines model for PrometheusDataQuery.
type QueryEditorMode ¶
type QueryEditorMode string
QueryEditorMode defines model for QueryEditorMode.
const ( QueryEditorModeBuilder QueryEditorMode = "builder" QueryEditorModeCode QueryEditorMode = "code" )
Defines values for QueryEditorMode.
Click to show internal directories.
Click to hide internal directories.