elasticsearch

grafonnet.query.elasticsearch

Subpackages

• bucketAggs
• metrics

Index

• fn withAlias(value)
• fn withBucketAggs(value)
• fn withBucketAggsMixin(value)
• fn withDatasource(value)
• fn withHide(value=true)
• fn withMetrics(value)
• fn withMetricsMixin(value)
• fn withQuery(value)
• fn withQueryType(value)
• fn withRefId(value)
• fn withTimeField(value)

Fields

fn withAlias

withAlias(value)

PARAMETERS:

• value (string)

Alias pattern

fn withBucketAggs

withBucketAggs(value)

PARAMETERS:

• value (array)

List of bucket aggregations

fn withBucketAggsMixin

withBucketAggsMixin(value)

PARAMETERS:

• value (array)

List of bucket aggregations

fn withDatasource

withDatasource(value)

PARAMETERS:

• value (string)

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

fn withHide

withHide(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

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)

fn withMetrics

withMetrics(value)

PARAMETERS:

• value (array)

List of metric aggregations

fn withMetricsMixin

withMetricsMixin(value)

PARAMETERS:

• value (array)

List of metric aggregations

fn withQuery

withQuery(value)

PARAMETERS:

• value (string)

Lucene query

fn withQueryType

withQueryType(value)

PARAMETERS:

• value (string)

Specify the query flavor TODO make this required and give it a default

fn withRefId

withRefId(value)

PARAMETERS:

• value (string)

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.

fn withTimeField

withTimeField(value)

PARAMETERS:

• value (string)

Name of time field