Skip to content

DataqueryBuilder🔗

Constructor🔗

new DataqueryBuilder()

Methods🔗

build🔗

Builds the object.

public Dataquery build()

datasource🔗

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

public DataqueryBuilder datasource(DataSourceRef datasource)

exemplars🔗

For metric queries, how many exemplars to request, 0 means no exemplars

public DataqueryBuilder exemplars(Long exemplars)

filters🔗

public DataqueryBuilder filters(List<com.grafana.foundation.cog.Builder<TraceqlFilter>> filters)

groupBy🔗

Filters that are used to query the metrics summary

public DataqueryBuilder groupBy(List<com.grafana.foundation.cog.Builder<TraceqlFilter>> groupBy)

hide🔗

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

public DataqueryBuilder hide(Boolean hide)

limit🔗

Defines the maximum number of traces that are returned from Tempo

public DataqueryBuilder limit(Long limit)

maxDuration🔗

@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms

public DataqueryBuilder maxDuration(String maxDuration)

metricsQueryType🔗

For metric queries, whether to run instant or range queries

public DataqueryBuilder metricsQueryType(MetricsQueryType metricsQueryType)

minDuration🔗

@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms

public DataqueryBuilder minDuration(String minDuration)

query🔗

TraceQL query or trace ID

public DataqueryBuilder query(String query)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

public DataqueryBuilder queryType(String queryType)

refId🔗

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.

public DataqueryBuilder refId(String refId)

@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true

public DataqueryBuilder search(String search)

serviceMapIncludeNamespace🔗

Use service.namespace in addition to service.name to uniquely identify a service.

public DataqueryBuilder serviceMapIncludeNamespace(Boolean serviceMapIncludeNamespace)

serviceMapQuery🔗

Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.

public DataqueryBuilder serviceMapQuery(StringOrArrayOfString serviceMapQuery)

serviceName🔗

@deprecated Query traces by service name

public DataqueryBuilder serviceName(String serviceName)

spanName🔗

@deprecated Query traces by span name

public DataqueryBuilder spanName(String spanName)

spss🔗

Defines the maximum number of spans per spanset that are returned from Tempo

public DataqueryBuilder spss(Long spss)

step🔗

For metric queries, the step size to use

public DataqueryBuilder step(String step)

tableType🔗

The type of the table that is used to display the search results

public DataqueryBuilder tableType(SearchTableType tableType)

See also🔗