Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DataQuery ¶
type DataQuery 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"`
// 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"`
// Specify the query flavor
// TODO make this required and give it a default
QueryType *string `json:"queryType,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"`
}
These are the common properties available to all queries in all datasources. Specific implementations will *extend* this interface, adding the required properties for the given context.
type LokiDataQuery ¶
type LokiDataQuery struct {
// DataQuery These are the common properties available to all queries in all datasources.
// Specific implementations will *extend* this interface, adding the required
// properties for the given context.
DataQuery
// 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"`
EditorMode *QueryEditorMode `json:"editorMode,omitempty"`
// The LogQL query.
Expr string `json:"expr"`
// 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"`
// @deprecated, now use queryType.
Instant *bool `json:"instant,omitempty"`
// Used to override the name of the series.
LegendFormat *string `json:"legendFormat,omitempty"`
// Used to limit the number of log rows returned.
MaxLines *int64 `json:"maxLines,omitempty"`
// Specify the query flavor
// TODO make this required and give it a default
QueryType *string `json:"queryType,omitempty"`
// @deprecated, now use queryType.
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"`
// Used to scale the interval value.
Resolution *int64 `json:"resolution,omitempty"`
// Used to set step value for range queries.
Step *string `json:"step,omitempty"`
}
LokiDataQuery defines model for LokiDataQuery.
type LokiQueryDirection ¶
type LokiQueryDirection string
LokiQueryDirection defines model for LokiQueryDirection.
const ( LokiQueryDirectionBackward LokiQueryDirection = "backward" LokiQueryDirectionForward LokiQueryDirection = "forward" )
Defines values for LokiQueryDirection.
type LokiQueryType ¶
type LokiQueryType string
LokiQueryType defines model for LokiQueryType.
const ( LokiQueryTypeInstant LokiQueryType = "instant" LokiQueryTypeRange LokiQueryType = "range" LokiQueryTypeStream LokiQueryType = "stream" )
Defines values for LokiQueryType.
type QueryEditorMode ¶
type QueryEditorMode string
QueryEditorMode defines model for QueryEditorMode.
const ( QueryEditorModeBuilder QueryEditorMode = "builder" QueryEditorModeCode QueryEditorMode = "code" )
Defines values for QueryEditorMode.
type SupportingQueryType ¶
type SupportingQueryType string
SupportingQueryType defines model for SupportingQueryType.
const ( SupportingQueryTypeDataSample SupportingQueryType = "dataSample" SupportingQueryTypeLogsSample SupportingQueryType = "logsSample" SupportingQueryTypeLogsVolume SupportingQueryType = "logsVolume" )
Defines values for SupportingQueryType.
Click to show internal directories.
Click to hide internal directories.