opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-02 13:07:47 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/tempodataquery/schema-reference.md
Joan López de la Franca Beltran 19ed9181e1 Kindsys: Extend DocsJenny with support for 'allOf' (#62558) 
* Kindsys: Extend DocsJenny with support for 'allOf'

* Update generated docs

* Multiple refinements

* Minor fixes

* Undo undesired changes

* Fix

* Fix linter complains

---------

Co-authored-by: Tania B <yalyna.ts@gmail.com>
2023-02-02 16:12:31 +01:00

7.4 KiB
Raw Blame History

keywords title
grafana
schema
TempoDataQuery kind

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

TempoDataQuery

Maturity: experimental

Version: 0.0

It extends DataQuery.

Property Type Required Description
query string Yes TraceQL query or trace ID
refId string Yes (Inherited from DataQuery)
A - Z
datasource No (Inherited from DataQuery)
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
hide boolean No (Inherited from DataQuery)
true if query is disabled (ie should not be returned to the dashboard)
key string No (Inherited from DataQuery)
Unique, guid like, string used in explore mode
limit integer No Defines the maximum number of traces that are returned from Tempo
maxDuration string No Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms
minDuration string No Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms
queryType string No (Inherited from DataQuery)
Specify the query flavor
TODO make this required and give it a default
search string No Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true
serviceMapQuery string No Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}
serviceName string No Query traces by service name
spanName string No Query traces by span name

DataQuery

These are the common properties available to all queries in all datasources. Specific implementations will extend this interface, adding the required properties for the given context.

Property Type Required Description
refId string Yes A - Z
datasource No 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
hide boolean No true if query is disabled (ie should not be returned to the dashboard)
key string No Unique, guid like, string used in explore mode
queryType string No Specify the query flavor
TODO make this required and give it a default