apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41362 Commits
2179 Branches
608 Tags
1.9 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 4b94c7e5d2
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4b94c7e5d2'
${ noResults }
grafana/docs/sources/developers/kinds/composable/phlaredataquery/schema-reference.md

5.2 KiB
Raw Blame History

keywords title
[grafana schema] PhlareDataQuery kind

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

PhlareDataQuery

Maturity: experimental

Version: 0.0

It extends DataQuery.

Property Type Required Description
groupBy string[] Yes Allows to group the results.
labelSelector string Yes Specifies the query label selectors. Default: {}.
profileTypeId string Yes Specifies the type of profile to query.
refId string Yes (Inherited from DataQuery)
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.
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)
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)
queryType string No (Inherited from DataQuery)
Specify the query flavor
TODO make this required and give it a default

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 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.
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)
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)
queryType string No Specify the query flavor
TODO make this required and give it a default