mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 08:42:19 +08:00
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>
This commit is contained in:
Jack Baldry
@ -1,20 +1,24 @@
|
||||
---
|
||||
keywords:
|
||||
- grafana
|
||||
- schema
|
||||
- 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 |
|
||||
@ -28,7 +32,7 @@ title: ElasticsearchDataQuery kind
|
||||
### BucketAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [DateHistogram](#datehistogram), [Histogram](#histogram), [Terms](#terms), [Filters](#filters), [GeoHashGrid](#geohashgrid), [Nested](#nested). | | |
|
||||
|
||||
### DateHistogram
|
||||
@ -36,27 +40,27 @@ title: ElasticsearchDataQuery kind
|
||||
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))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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`. |
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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))* |
|
||||
| `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 | | |
|
||||
@ -66,59 +70,59 @@ It extends [BaseBucketAggregation](#basebucketaggregation).
|
||||
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))* |
|
||||
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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))* |
|
||||
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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
|
||||
@ -126,15 +130,15 @@ It extends [BucketAggregationWithField](#bucketaggregationwithfield).
|
||||
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))* |
|
||||
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 | | |
|
||||
@ -142,7 +146,7 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
### PipelineMetricAggregation
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-------------|
|
||||
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------- |
|
||||
| `object` | Possible types are: [MovingAverage](#movingaverage), [Derivative](#derivative), [CumulativeSum](#cumulativesum), [BucketScript](#bucketscript). | | |
|
||||
|
||||
### BucketScript
|
||||
@ -150,11 +154,11 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
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))* |
|
||||
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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
|
||||
@ -162,23 +166,23 @@ It extends [PipelineMetricAggregationWithMultipleBucketPaths](#pipelinemetricagg
|
||||
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))* |
|
||||
| ------------------- | --------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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
|
||||
@ -186,12 +190,12 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
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))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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
|
||||
@ -199,11 +203,11 @@ It extends [BasePipelineMetricAggregation](#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))* |
|
||||
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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
|
||||
@ -211,16 +215,16 @@ It extends [MetricAggregationWithField](#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`. |
|
||||
| -------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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))* |
|
||||
| `hide` | boolean | No | | _(Inherited from [BaseMetricAggregation](#basemetricaggregation))_ |
|
||||
|
||||
### Settings
|
||||
|
||||
| Property | Type | Required | Default | Description |
|
||||
|----------|--------|----------|---------|-------------|
|
||||
| -------- | ------ | -------- | ------- | ----------- |
|
||||
| `format` | string | No | | |
|
||||
|
||||
### Derivative
|
||||
@ -228,18 +232,18 @@ It extends [BaseMetricAggregation](#basemetricaggregation).
|
||||
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))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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
|
||||
@ -249,30 +253,28 @@ It extends [BasePipelineMetricAggregation](#basepipelinemetricaggregation).
|
||||
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))* |
|
||||
| ------------- | ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `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
Block a user