QueryBuilder🔗

Constructor🔗

func NewQueryBuilder() *QueryBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *QueryBuilder) Build() (dashboardv2beta1.DataQueryKind, error)

AdhocFilters🔗

Additional Ad-hoc filters that take precedence over Scope on conflict.

func (builder *QueryBuilder) AdhocFilters(adhocFilters []cog.Builder[prometheus.AdhocFilters]) *QueryBuilder

Datasource🔗

New type for datasource reference

Not creating a new type until we figure out how to handle DS refs for group by, adhoc, and every place that uses DataSourceRef in TS.

func (builder *QueryBuilder) Datasource(datasource cog.Builder[dashboardv2beta1.Dashboardv2beta1DataQueryKindDatasource]) *QueryBuilder

EditorMode🔗

what we should show in the editor

Possible enum values:

• "builder"

• "code"

func (builder *QueryBuilder) EditorMode(editorMode prometheus.QueryEditorMode) *QueryBuilder

Exemplar🔗

Execute an additional query to identify interesting raw samples relevant for the given expr

func (builder *QueryBuilder) Exemplar(exemplar bool) *QueryBuilder

Expr🔗

The actual expression/query that will be evaluated by Prometheus

func (builder *QueryBuilder) Expr(expr string) *QueryBuilder

Format🔗

The response format

Possible enum values:

• "time_series"

• "table"

• "heatmap"

func (builder *QueryBuilder) Format(format prometheus.PromQueryFormat) *QueryBuilder

GroupByKeys🔗

Group By parameters to apply to aggregate expressions in the query

func (builder *QueryBuilder) GroupByKeys(groupByKeys []string) *QueryBuilder

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)

func (builder *QueryBuilder) Hide(hide bool) *QueryBuilder

Instant🔗

Returns only the latest value that Prometheus has scraped for the requested time series

func (builder *QueryBuilder) Instant() *QueryBuilder

Interval🔗

An additional lower limit for the step parameter of the Prometheus query and for the

$__interval and $__rate_interval variables.

func (builder *QueryBuilder) Interval(interval string) *QueryBuilder

IntervalFactor🔗

Used to specify how many times to divide max data points by. We use max data points under query options

See https://github.com/grafana/grafana/issues/48081

Deprecated: use interval

func (builder *QueryBuilder) IntervalFactor(intervalFactor int64) *QueryBuilder

IntervalMs🔗

Interval is the suggested duration between time points in a time series query.

NOTE: the values for intervalMs is not saved in the query model. It is typically calculated

from the interval required to fill a pixels in the visualization

func (builder *QueryBuilder) IntervalMs(intervalMs float64) *QueryBuilder

Labels🔗

func (builder *QueryBuilder) Labels(labels map[string]string) *QueryBuilder

LegendFormat🔗

Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname

func (builder *QueryBuilder) LegendFormat(legendFormat string) *QueryBuilder

MaxDataPoints🔗

MaxDataPoints is the maximum number of data points that should be returned from a time series query.

NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated

from the number of pixels visible in a visualization

func (builder *QueryBuilder) MaxDataPoints(maxDataPoints int64) *QueryBuilder

QueryType🔗

QueryType is an optional identifier for the type of query.

It can be used to distinguish different types of queries.

func (builder *QueryBuilder) QueryType(queryType string) *QueryBuilder

Range🔗

Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series

func (builder *QueryBuilder) Range() *QueryBuilder

RangeAndInstant🔗

func (builder *QueryBuilder) RangeAndInstant() *QueryBuilder

RefId🔗

RefID is the unique identifier of the query, set by the frontend call.

func (builder *QueryBuilder) RefId(refId string) *QueryBuilder

ResultAssertions🔗

Optionally define expected query result behavior

func (builder *QueryBuilder) ResultAssertions(resultAssertions cog.Builder[prometheus.ResultAssertions]) *QueryBuilder

Scopes🔗

A set of filters applied to apply to the query

func (builder *QueryBuilder) Scopes(scopes []cog.Builder[prometheus.Scopes]) *QueryBuilder

TimeRange🔗

TimeRange represents the query range

NOTE: unlike generic /ds/query, we can now send explicit time values in each query

NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly

func (builder *QueryBuilder) TimeRange(timeRange cog.Builder[prometheus.TimeRange]) *QueryBuilder

Version🔗

func (builder *QueryBuilder) Version(version string) *QueryBuilder

See also🔗

• dashboardv2beta1.DataQueryKind