elasticsearch
grafonnet.query.elasticsearch
Subpackages
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)obj datasource
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)
Set the datasource for this query.
fn withHide
withHide(value=true)
PARAMETERS:
- value (
boolean)- default value:
true
- default value:
If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
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
obj datasource
fn datasource.withType
datasource.withType(value)
PARAMETERS:
- value (
string)
The plugin type-id
fn datasource.withUid
datasource.withUid(value)
PARAMETERS:
- value (
string)
Specific datasource instance