opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 00:17:08 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md
Jack Baldry 7eb17bccca Explicitly set all front matter labels in the source files (#71548) 
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix introduction pages products

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00

281 lines
41 KiB
Markdown
Raw Blame History

---
keywords:
- grafana
- schema
labels:
products:
- enterprise
- oss
title: ElasticsearchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
## ElasticsearchDataQuery
#### Maturity: [experimental](../../../maturity/#experimental)
#### Version: 0.0
| Property | Type | Required | Default | Description |
| ------------ | ----------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `refId` | string | **Yes** | | A unique identifier for the query within the list of targets.<br/>In server side expressions, the refId is used as a variable name to identify results.<br/>By default, the UI will assign A->Z; however setting meaningful names may be useful. |
| `alias` | string | No | | Alias pattern |
| `bucketAggs` | [BucketAggregation](#bucketaggregation)[] | No | | List of bucket aggregations |
| `datasource` | | No | | For mixed data sources the selected datasource is on the query level.<br/>For non mixed scenarios this is undefined.<br/>TODO find a better way to do this ^ that's friendly to schema<br/>TODO this shouldn't be unknown but DataSourceRef &#124; null |
| `hide` | boolean | No | | true if query is disabled (ie should not be returned to the dashboard)<br/>Note this does not always imply that the query should not be executed since<br/>the results from a hidden query may be used as the input to other queries (SSE etc) |
| `metrics` | [MetricAggregation](#metricaggregation)[] | No | | List of metric aggregations |
| `queryType` | string | No | | Specify the query flavor<br/>TODO make this required and give it a default |
| `query` | string | No | | Lucene query |
| `timeField` | string | No | | Name of time field |
### BucketAggregation
| Property | Type | Required | Default | Description |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
### DateHistogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### BucketAggregationWithField
It extends [BaseBucketAggregation](#basebucketaggregation).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | |
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
### BaseBucketAggregation
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | |
| `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `settings` | | No | | |
### Filters
It extends [BaseBucketAggregation](#basebucketaggregation).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `settings` | | No | | _(Inherited from [BaseBucketAggregation](#basebucketaggregation))_ |
### GeoHashGrid
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### Histogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### Nested
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### Terms
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
| Property | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_<br/>Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `field` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
| `settings` | | No | | _(Inherited from [BucketAggregationWithField](#bucketaggregationwithfield))_ |
### MetricAggregation
| Property | Type | Required | Default | Description |
| -------- | ---------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
### Count
It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
### BaseMetricAggregation
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | |
| `type` | string | **Yes** | | Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | |
### PipelineMetricAggregation
| Property | Type | Required | Default | Description |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
### BucketScript
It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths).
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | **Yes** | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
| `id` | string | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | _(Inherited from [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths))_ |
| `settings` | [object](#settings) | No | | |
### PipelineMetricAggregationWithMultipleBucketPaths
It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `pipelineVariables` | [PipelineVariable](#pipelinevariable)[] | No | | |
### PipelineVariable
| Property | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------- |
| `name` | string | **Yes** | | |
| `pipelineAgg` | string | **Yes** | | |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |
| `script` | | No | | |
### CumulativeSum
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `settings` | [object](#settings) | No | | |
### BasePipelineMetricAggregation
It extends [MetricAggregationWithField](#metricaggregationwithfield).
| Property | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
| `hide` | boolean | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
| `id` | string | No | | _(Inherited from [MetricAggregationWithField](#metricaggregationwithfield))_ |
| `pipelineAgg` | string | No | | |
### MetricAggregationWithField
It extends [BaseMetricAggregation](#basemetricaggregation).
| Property | Type | Required | Default | Description |
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
| `type` | string | **Yes** | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | |
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------- |
| `format` | string | No | | |
### Derivative
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `settings` | [object](#settings) | No | | |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------- |
| `unit` | string | No | | |
### MovingAverage
#MovingAverage's settings are overridden in types.ts
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
| Property | Type | Required | Default | Description |
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | string | **Yes** | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_<br/>Possible values are: `count`, `avg`, `sum`, `min`, `max`, `extended_stats`, `percentiles`, `cardinality`, `raw_document`, `raw_data`, `logs`, `rate`, `top_metrics`, `moving_avg`, `moving_fn`, `derivative`, `serial_diff`, `cumulative_sum`, `bucket_script`. |
| `field` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `hide` | boolean | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `id` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `pipelineAgg` | string | No | | _(Inherited from [BasePipelineMetricAggregation](#basepipelinemetricaggregation))_ |
| `settings` | [object](#settings) | No | | |
### Settings
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |
### Meta
| Property | Type | Required | Default | Description |
| -------- | ---- | -------- | ------- | ----------- |
### Settings
| Property | Type | Required | Default | Description |
| --------- | -------- | -------- | ------- | ----------- |
| `metrics` | string[] | No | | |
| `orderBy` | string | No | | |
| `order` | string | No | | |
Reference in New Issue View Git Blame Copy Permalink