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.
40709 Commits
2158 Branches
608 Tags
1.9 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 19ed9181e1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '19ed9181e1'
${ noResults }
grafana/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md

7.0 KiB
Raw Blame History

keywords title
[grafana schema] ElasticsearchDataQuery kind

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

ElasticsearchDataQuery

Maturity: merged

Version: 0.0

It extends DataQuery.

Property Type Required Description
refId string Yes (Inherited from DataQuery)
A - Z
alias string No
bucketAggs BucketAggregation[] No
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
metrics MetricAggregation[] No
queryType string No (Inherited from DataQuery)
Specify the query flavor
TODO make this required and give it a default
query string No
timeField string No

BucketAggregation

Property Type Required Description

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

MetricAggregation

Property Type Required Description