QueryV2Builder🔗

Constructor🔗

new QueryV2Builder()

Methods🔗

build🔗

Builds the object.

build()

adhocFilters🔗

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

adhocFilters(adhocFilters: cog.Builder<prometheus.AdhocFilters>[])

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.

datasource(ref: {
    name?: string;
})

editorMode🔗

what we should show in the editor

Possible enum values:

"builder"
"code"

editorMode(editorMode: prometheus.QueryEditorMode)

exemplar🔗

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

exemplar(exemplar: boolean)

expr🔗

The actual expression/query that will be evaluated by Prometheus

expr(expr: string)

format🔗

The response format

Possible enum values:

"time_series"
"table"
"heatmap"

format(format: prometheus.PromQueryFormat)

groupByKeys🔗

Group By parameters to apply to aggregate expressions in the query

groupByKeys(groupByKeys: string[])

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(hide: boolean)

instant🔗

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

instant(instant: boolean)

interval🔗

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

$__interval and $__rate_interval variables.

interval(interval: string)

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

intervalFactor(intervalFactor: number)

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

intervalMs(intervalMs: number)

labels🔗

labels(labels: Record<string, string>)

legendFormat🔗

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

legendFormat(legendFormat: string)

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

maxDataPoints(maxDataPoints: number)

queryType🔗

QueryType is an optional identifier for the type of query.

It can be used to distinguish different types of queries.

queryType(queryType: string)

range🔗

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

range(range: boolean)

refId🔗

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

refId(refId: string)

resultAssertions🔗

Optionally define expected query result behavior

resultAssertions(resultAssertions: cog.Builder<prometheus.ResultAssertions>)

scopes🔗

A set of filters applied to apply to the query

scopes(scopes: cog.Builder<prometheus.Scopes>[])

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

timeRange(timeRange: cog.Builder<prometheus.TimeRange>)

version🔗

version(version: string)