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.
44048 Commits
651 Branches
650 Tags
2.2 GiB
Tag: Branch: Tree: ec479b8d88
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ec479b8d88'
${ noResults }
grafana/docs/sources/developers/kinds/composable/elasticsearchdataquery/schema-reference.md

279 lines
41 KiB
Raw Normal View History Unescape

Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago
---
keywords:
- grafana
- schema
title: ElasticsearchDataQuery kind
---
> Both documentation generation and kinds schemas are in active development and subject to change without prior notice.
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>
3 years ago
## ElasticsearchDataQuery
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago
Docs: Add Schema maturity docs (#61963) * Docs: Add Schema maturity docs * Remove 'which category' section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Maturity process guides from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Defaults and Field optionality from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove MaybeRemove section from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Remove Milestone 3 and 4 from maturity.md Co-authored-by: sam boyer <sdboyer@grafana.com> * Rearrange schema maturity docs * Regenerate schema docs after merge with main * Update Maturity docs headers, keep single h1 * Update wording in Schema docs Co-authored-by: Tania <yalyna.ts@gmail.com> * Regenerate docs after merge with main --------- Co-authored-by: sam boyer <sdboyer@grafana.com> Co-authored-by: Tania <yalyna.ts@gmail.com>
3 years ago
#### Maturity: [experimental](../../../maturity/#experimental)
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>
3 years ago
#### Version: 0.0
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago
kindsys: Adapt to new flattened lineage syntax in Thema (#68034) * Update all core kinds to flattened lineages * Regen Go types, without any * Regen Go types, s/interface{}/any/ * Update generated core typescript * Update generate docs * Fix defaults gen in veneer index jenny * Flatten plugindef lineage * Convert all plugin kinds to flattened form * Switch back to interface{} for now * Switch to fs.Sub in plugin DeclParser * Mostly undesirable codegen changes, to be fixed * Update mod and sum * Update pfs tests to flattened lineages * Update thema to latest, regen docs
3 years ago
| 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 |
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>
3 years ago
### BucketAggregation
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### DateHistogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### BucketAggregationWithField
It extends [BaseBucketAggregation](#basebucketaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### BaseBucketAggregation
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|------------|--------|----------|---------|---------------------------------------------------------------------------------------------------|
| `id` | string | **Yes** | | |
| `type` | string | **Yes** | | Possible values are: `terms`, `filters`, `geohash_grid`, `date_histogram`, `histogram`, `nested`. |
| `settings` | | No | | |
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Filters
It extends [BaseBucketAggregation](#basebucketaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### GeoHashGrid
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Histogram
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Nested
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Terms
It extends [BucketAggregationWithField](#bucketaggregationwithfield).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
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>
3 years ago
### MetricAggregation
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [Count](#count), [PipelineMetricAggregation](#pipelinemetricaggregation), [](#). | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Count
It extends [BaseMetricAggregation](#basemetricaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### BaseMetricAggregation
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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 | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### PipelineMetricAggregation
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### BucketScript
It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricaggregationwithmultiplebucketpaths).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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 | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### PipelineMetricAggregationWithMultipleBucketPaths
It extends [BaseMetricAggregation](#basemetricaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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 | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### PipelineVariable
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|---------------|--------|----------|---------|-------------|
| `name` | string | **Yes** | | |
| `pipelineAgg` | string | **Yes** | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Settings
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
| `script` | | No | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### CumulativeSum
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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 | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### BasePipelineMetricAggregation
It extends [MetricAggregationWithField](#metricaggregationwithfield).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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 | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### MetricAggregationWithField
It extends [BaseMetricAggregation](#basemetricaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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))* |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Settings
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|--------|----------|---------|-------------|
| `format` | string | No | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Derivative
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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 | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Settings
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|--------|----------|---------|-------------|
| `unit` | string | No | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### MovingAverage
#MovingAverage's settings are overridden in types.ts
It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| 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 | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
Elastic Search: Fix BasePipelineMetricAggregation schema type (#64335) * Fix type * Tweak BaseBucketAggregation type * Remove comment
3 years ago
### Settings
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
Elastic Search: Fix BasePipelineMetricAggregation schema type (#64335) * Fix type * Tweak BaseBucketAggregation type * Remove comment
3 years ago
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Meta
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|----------|------|----------|---------|-------------|
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
### Settings
Docs: Add `Default` column to generated schema docs (#64550) Docs: Add column to generated schema docs
3 years ago
| Property | Type | Required | Default | Description |
|-----------|----------|----------|---------|-------------|
| `metrics` | string[] | No | | |
| `orderBy` | string | No | | |
| `order` | string | No | | |
Codegen: Render disjunctions in docs (#63590) * Codegen: Render disjunctions in docs * Fix references * Regenerate docs
3 years ago
Elasticsearch: Implement schema for query (#62147) * Elasticsearch: Implement schema for query * Comment out types I am not sure how to do * Manually fix typing for PipelineMetricAggregationWithMultipleBucketPaths and BasePipelineMetricAggregation * Import types to types.ts to have single source of truth * Cleanup, reorder * Remove unnecesary Schema. * Fix test * Refactor
3 years ago