tempo

grafonnet.query.tempo

Subpackages

• filters
• groupBy

Index

• fn new(datasource, query, filters)
• fn withDatasource(value)
• fn withFilters(value)
• fn withFiltersMixin(value)
• fn withGroupBy(value)
• fn withGroupByMixin(value)
• fn withHide(value=true)
• fn withLimit(value)
• fn withMaxDuration(value)
• fn withMinDuration(value)
• fn withQuery(value)
• fn withQueryType(value)
• fn withRefId(value)
• fn withSearch(value)
• fn withServiceMapIncludeNamespace(value=true)
• fn withServiceMapQuery(value)
• fn withServiceMapQueryMixin(value)
• fn withServiceName(value)
• fn withSpanName(value)
• fn withSpss(value)
• fn withStep(value)
• fn withTableType(value)
• obj datasource
  • fn withType(value)
  • fn withUid(value)

Fields

fn new

new(datasource, query, filters)

PARAMETERS:

• datasource (string)
• query (string)
• filters (array)

Creates a new tempo query target for panels.

fn withDatasource

withDatasource(value)

PARAMETERS:

• value (string)

Set the datasource for this query.

fn withFilters

withFilters(value)

PARAMETERS:

• value (array)

fn withFiltersMixin

withFiltersMixin(value)

PARAMETERS:

• value (array)

fn withGroupBy

withGroupBy(value)

PARAMETERS:

• value (array)

Filters that are used to query the metrics summary

fn withGroupByMixin

withGroupByMixin(value)

PARAMETERS:

• value (array)

Filters that are used to query the metrics summary

fn withHide

withHide(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

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

fn withLimit

withLimit(value)

PARAMETERS:

• value (integer)

Defines the maximum number of traces that are returned from Tempo

fn withMaxDuration

withMaxDuration(value)

PARAMETERS:

• value (string)

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

fn withMinDuration

withMinDuration(value)

PARAMETERS:

• value (string)

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

fn withQuery

withQuery(value)

PARAMETERS:

• value (string)

TraceQL query or trace ID

fn withQueryType

withQueryType(value)

PARAMETERS:

• value (string)

Specify the query flavor TODO make this required and give it a default

fn withRefId

withRefId(value)

PARAMETERS:

• value (string)

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.

fn withSearch

withSearch(value)

PARAMETERS:

• value (string)

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

fn withServiceMapIncludeNamespace

withServiceMapIncludeNamespace(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

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

fn withServiceMapQuery

withServiceMapQuery(value)

PARAMETERS:

• value (array,string)

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.

fn withServiceMapQueryMixin

withServiceMapQueryMixin(value)

PARAMETERS:

• value (array,string)

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.

fn withServiceName

withServiceName(value)

PARAMETERS:

• value (string)

@deprecated Query traces by service name

fn withSpanName

withSpanName(value)

PARAMETERS:

• value (string)

@deprecated Query traces by span name

fn withSpss

withSpss(value)

PARAMETERS:

• value (integer)

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

fn withStep

withStep(value)

PARAMETERS:

• value (string)

For metric queries, the step size to use

fn withTableType

withTableType(value)

PARAMETERS:

• value (string)
  • valid values: "traces", "spans", "raw"

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

obj datasource

fn datasource.withType

datasource.withType(value)

PARAMETERS:

• value (string)

The plugin type-id

fn datasource.withUid

datasource.withUid(value)

PARAMETERS:

• value (string)

Specific datasource instance