grafana/schema-reference.md at ccc38e760cfdd0cfbc509aed5a94e8dc295e5936

mirror of https://github.com/grafana/grafana.git synced 2025-07-28 18:02:22 +08:00

Files

Jack Baldry 7eb17bccca Explicitly set all front matter labels in the source files (#71548 )

* Set every page to have defaults of 'Enterprise' and 'Open source' labels

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Fix introduction pages products

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

* Apply updated labels from review

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

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

2023-07-18 09:10:12 +01:00

41 KiB

Raw Blame History

keywords

labels

title

grafana

schema

products

enterprise

oss

ElasticsearchDataQuery kind

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

ElasticsearchDataQuery

Maturity: experimental

Version: 0.0

Property	Type	Required	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.
`alias`	string	No	Alias pattern
`bucketAggs`	BucketAggregation[]	No	List of bucket aggregations
`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)
`metrics`	MetricAggregation[]	No	List of metric aggregations
`queryType`	string	No	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	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	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	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	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	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	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	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	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)

MetricAggregation

Property	Type	Required	Default	Description
`object`	Possible types are: Count, PipelineMetricAggregation, .

Count

It extends BaseMetricAggregation.

Property	Type	Required	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	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	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	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	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	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	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	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	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

Settings

Property	Type	Required
`metrics`	string[]	No
`orderBy`	string	No
`order`	string	No

41 KiB Raw Blame History

ElasticsearchDataQuery

Maturity: experimental

Version: 0.0

BucketAggregation

DateHistogram

BucketAggregationWithField

BaseBucketAggregation

Filters

GeoHashGrid

Histogram

Nested

Terms

MetricAggregation

Count

BaseMetricAggregation

PipelineMetricAggregation

BucketScript

PipelineMetricAggregationWithMultipleBucketPaths

PipelineVariable

Settings

CumulativeSum

BasePipelineMetricAggregation

MetricAggregationWithField

Settings

Derivative

Settings

MovingAverage

Settings

Meta

Settings

41 KiB

Raw Blame History