TempoQueryBuilder🔗

Constructor🔗

new TempoQueryBuilder()

Methods🔗

build🔗

Builds the object.

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

datasource(datasource: dashboard.DataSourceRef)

filters🔗

filters(filters: cog.Builder<tempo.TraceqlFilter>[])

groupBy🔗

Filters that are used to query the metrics summary

groupBy(groupBy: cog.Builder<tempo.TraceqlFilter>[])

hide🔗

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

hide(hide: boolean)

limit🔗

Defines the maximum number of traces that are returned from Tempo

limit(limit: number)

maxDuration🔗

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

maxDuration(maxDuration: string)

minDuration🔗

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

minDuration(minDuration: string)

query🔗

TraceQL query or trace ID

query(query: string)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

queryType(queryType: string)

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.

refId(refId: string)

search🔗

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

search(search: string)

serviceMapIncludeNamespace🔗

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

serviceMapIncludeNamespace(serviceMapIncludeNamespace: boolean)

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.

serviceMapQuery(serviceMapQuery: string | string[])

serviceName🔗

@deprecated Query traces by service name

serviceName(serviceName: string)

spanName🔗

@deprecated Query traces by span name

spanName(spanName: string)

spss🔗

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

spss(spss: number)

step🔗

For metric queries, the step size to use

step(step: string)

tableType🔗

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

tableType(tableType: tempo.SearchTableType)