Menu
Enterprise
Open source
Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
ElasticsearchDataQuery
Maturity: experimental
Version: 0.0
It extends DataQuery.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
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. | |
alias | string | No | Alias pattern | |
bucketAggs | BucketAggregation[] | No | List of bucket aggregations | |
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) | |
metrics | MetricAggregation[] | No | List of metric aggregations | |
queryType | string | No | (Inherited from DataQuery) Specify the query flavor 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, Histogram, Terms, Filters, GeoHashGrid, Nested. |
DateHistogram
It extends BucketAggregationWithField.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BucketAggregationWithField) Possible values are: terms, filters, geohash_grid, date_histogram, histogram, nested. | |
field | string | No | (Inherited from BucketAggregationWithField) | |
id | string | No | (Inherited from BucketAggregationWithField) | |
settings | No | (Inherited from BucketAggregationWithField) |
BucketAggregationWithField
It extends BaseBucketAggregation.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | (Inherited from BaseBucketAggregation) | |
type | string | Yes | (Inherited from BaseBucketAggregation) Possible values are: terms, filters, geohash_grid, date_histogram, histogram, nested. | |
field | string | No | ||
settings | No | (Inherited from 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.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | (Inherited from BaseBucketAggregation) | |
type | string | Yes | (Inherited from BaseBucketAggregation) Possible values are: terms, filters, geohash_grid, date_histogram, histogram, nested. | |
settings | No | (Inherited from BaseBucketAggregation) |
GeoHashGrid
It extends BucketAggregationWithField.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BucketAggregationWithField) Possible values are: terms, filters, geohash_grid, date_histogram, histogram, nested. | |
field | string | No | (Inherited from BucketAggregationWithField) | |
id | string | No | (Inherited from BucketAggregationWithField) | |
settings | No | (Inherited from BucketAggregationWithField) |
Histogram
It extends BucketAggregationWithField.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BucketAggregationWithField) Possible values are: terms, filters, geohash_grid, date_histogram, histogram, nested. | |
field | string | No | (Inherited from BucketAggregationWithField) | |
id | string | No | (Inherited from BucketAggregationWithField) | |
settings | No | (Inherited from BucketAggregationWithField) |
Nested
It extends BucketAggregationWithField.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BucketAggregationWithField) Possible values are: terms, filters, geohash_grid, date_histogram, histogram, nested. | |
field | string | No | (Inherited from BucketAggregationWithField) | |
id | string | No | (Inherited from BucketAggregationWithField) | |
settings | No | (Inherited from BucketAggregationWithField) |
Terms
It extends BucketAggregationWithField.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BucketAggregationWithField) Possible values are: terms, filters, geohash_grid, date_histogram, histogram, nested. | |
field | string | No | (Inherited from BucketAggregationWithField) | |
id | string | No | (Inherited from BucketAggregationWithField) | |
settings | No | (Inherited from BucketAggregationWithField) |
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 | Default | 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 |
MetricAggregation
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
object | Possible types are: Count, PipelineMetricAggregation, . |
Count
It extends BaseMetricAggregation.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | (Inherited from BaseMetricAggregation) | |
type | string | Yes | (Inherited from BaseMetricAggregation) 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
| 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, Derivative, CumulativeSum, BucketScript. |
BucketScript
It extends PipelineMetricAggregationWithMultipleBucketPaths.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from PipelineMetricAggregationWithMultipleBucketPaths) 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) | |
id | string | No | (Inherited from PipelineMetricAggregationWithMultipleBucketPaths) | |
pipelineVariables | PipelineVariable[] | No | (Inherited from PipelineMetricAggregationWithMultipleBucketPaths) | |
settings | object | No |
PipelineMetricAggregationWithMultipleBucketPaths
It extends BaseMetricAggregation.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | (Inherited from BaseMetricAggregation) | |
type | string | Yes | (Inherited from BaseMetricAggregation) 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) | |
pipelineVariables | 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.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BasePipelineMetricAggregation) 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) | |
hide | boolean | No | (Inherited from BasePipelineMetricAggregation) | |
id | string | No | (Inherited from BasePipelineMetricAggregation) | |
pipelineAgg | string | No | (Inherited from BasePipelineMetricAggregation) | |
settings | object | No |
BasePipelineMetricAggregation
It extends MetricAggregationWithField.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from MetricAggregationWithField) 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) | |
hide | boolean | No | (Inherited from MetricAggregationWithField) | |
id | string | No | (Inherited from MetricAggregationWithField) | |
pipelineAgg | string | No |
MetricAggregationWithField
It extends BaseMetricAggregation.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | (Inherited from BaseMetricAggregation) | |
type | string | Yes | (Inherited from BaseMetricAggregation) 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) |
Settings
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
format | string | No |
Derivative
It extends BasePipelineMetricAggregation.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BasePipelineMetricAggregation) 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) | |
hide | boolean | No | (Inherited from BasePipelineMetricAggregation) | |
id | string | No | (Inherited from BasePipelineMetricAggregation) | |
pipelineAgg | string | No | (Inherited from BasePipelineMetricAggregation) | |
settings | object | No |
Settings
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
unit | string | No |
MovingAverage
#MovingAverage’s settings are overridden in types.ts
It extends BasePipelineMetricAggregation.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | (Inherited from BasePipelineMetricAggregation) 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) | |
hide | boolean | No | (Inherited from BasePipelineMetricAggregation) | |
id | string | No | (Inherited from BasePipelineMetricAggregation) | |
pipelineAgg | string | No | (Inherited from BasePipelineMetricAggregation) | |
settings | object | 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 |
