googleCloudMonitoring

grafonnet.query.googleCloudMonitoring

Index

• fn withAliasBy(value)
• fn withDatasource(value)
• fn withHide(value=true)
• fn withIntervalMs(value)
• fn withPromQLQuery(value)
• fn withPromQLQueryMixin(value)
• fn withQueryType(value)
• fn withRefId(value)
• fn withSloQuery(value)
• fn withSloQueryMixin(value)
• fn withTimeSeriesList(value)
• fn withTimeSeriesListMixin(value)
• fn withTimeSeriesQuery(value)
• fn withTimeSeriesQueryMixin(value)
• obj datasource
  • fn withType(value)
  • fn withUid(value)
• obj promQLQuery
  • fn withExpr(value)
  • fn withProjectName(value)
  • fn withStep(value)
• obj sloQuery
  • fn withAlignmentPeriod(value)
  • fn withGoal(value)
  • fn withLookbackPeriod(value)
  • fn withPerSeriesAligner(value)
  • fn withProjectName(value)
  • fn withSelectorName(value)
  • fn withServiceId(value)
  • fn withServiceName(value)
  • fn withSloId(value)
  • fn withSloName(value)
• obj timeSeriesList
  • fn withAlignmentPeriod(value)
  • fn withCrossSeriesReducer(value)
  • fn withFilters(value)
  • fn withFiltersMixin(value)
  • fn withGroupBys(value)
  • fn withGroupBysMixin(value)
  • fn withPerSeriesAligner(value)
  • fn withPreprocessor(value)
  • fn withProjectName(value)
  • fn withSecondaryAlignmentPeriod(value)
  • fn withSecondaryCrossSeriesReducer(value)
  • fn withSecondaryGroupBys(value)
  • fn withSecondaryGroupBysMixin(value)
  • fn withSecondaryPerSeriesAligner(value)
  • fn withText(value)
  • fn withTitle(value)
  • fn withView(value)
• obj timeSeriesQuery
  • fn withGraphPeriod(value="disabled")
  • fn withProjectName(value)
  • fn withQuery(value)

Fields

fn withAliasBy

withAliasBy(value)

PARAMETERS:

• value (string)

Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.

fn withDatasource

withDatasource(value)

PARAMETERS:

• value (string)

Set the datasource for this query.

fn withHide

withHide(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

fn withIntervalMs

withIntervalMs(value)

PARAMETERS:

• value (number)

Time interval in milliseconds.

fn withPromQLQuery

withPromQLQuery(value)

PARAMETERS:

• value (object)

PromQL sub-query properties.

fn withPromQLQueryMixin

withPromQLQueryMixin(value)

PARAMETERS:

• value (object)

PromQL sub-query properties.

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 withSloQuery

withSloQuery(value)

PARAMETERS:

• value (object)

SLO sub-query properties.

fn withSloQueryMixin

withSloQueryMixin(value)

PARAMETERS:

• value (object)

SLO sub-query properties.

fn withTimeSeriesList

withTimeSeriesList(value)

PARAMETERS:

• value (object)

Time Series List sub-query properties.

fn withTimeSeriesListMixin

withTimeSeriesListMixin(value)

PARAMETERS:

• value (object)

Time Series List sub-query properties.

fn withTimeSeriesQuery

withTimeSeriesQuery(value)

PARAMETERS:

• value (object)

Time Series sub-query properties.

fn withTimeSeriesQueryMixin

withTimeSeriesQueryMixin(value)

PARAMETERS:

• value (object)

Time Series sub-query properties.

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

obj promQLQuery

fn promQLQuery.withExpr

promQLQuery.withExpr(value)

PARAMETERS:

• value (string)

PromQL expression/query to be executed.

fn promQLQuery.withProjectName

promQLQuery.withProjectName(value)

PARAMETERS:

• value (string)

GCP project to execute the query against.

fn promQLQuery.withStep

promQLQuery.withStep(value)

PARAMETERS:

• value (string)

PromQL min step

obj sloQuery

fn sloQuery.withAlignmentPeriod

sloQuery.withAlignmentPeriod(value)

PARAMETERS:

• value (string)

Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.

fn sloQuery.withGoal

sloQuery.withGoal(value)

PARAMETERS:

• value (number)

SLO goal value.

fn sloQuery.withLookbackPeriod

sloQuery.withLookbackPeriod(value)

PARAMETERS:

• value (string)

Specific lookback period for the SLO.

fn sloQuery.withPerSeriesAligner

sloQuery.withPerSeriesAligner(value)

PARAMETERS:

• value (string)

Alignment function to be used. Defaults to ALIGN_MEAN.

fn sloQuery.withProjectName

sloQuery.withProjectName(value)

PARAMETERS:

• value (string)

GCP project to execute the query against.

fn sloQuery.withSelectorName

sloQuery.withSelectorName(value)

PARAMETERS:

• value (string)

SLO selector.

fn sloQuery.withServiceId

sloQuery.withServiceId(value)

PARAMETERS:

• value (string)

ID for the service the SLO is in.

fn sloQuery.withServiceName

sloQuery.withServiceName(value)

PARAMETERS:

• value (string)

Name for the service the SLO is in.

fn sloQuery.withSloId

sloQuery.withSloId(value)

PARAMETERS:

• value (string)

ID for the SLO.

fn sloQuery.withSloName

sloQuery.withSloName(value)

PARAMETERS:

• value (string)

Name of the SLO.

obj timeSeriesList

fn timeSeriesList.withAlignmentPeriod

timeSeriesList.withAlignmentPeriod(value)

PARAMETERS:

• value (string)

Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.

fn timeSeriesList.withCrossSeriesReducer

timeSeriesList.withCrossSeriesReducer(value)

PARAMETERS:

• value (string)

Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.

fn timeSeriesList.withFilters

timeSeriesList.withFilters(value)

PARAMETERS:

• value (array)

Array of filters to query data by. Labels that can be filtered on are defined by the metric.

fn timeSeriesList.withFiltersMixin

timeSeriesList.withFiltersMixin(value)

PARAMETERS:

• value (array)

Array of filters to query data by. Labels that can be filtered on are defined by the metric.

fn timeSeriesList.withGroupBys

timeSeriesList.withGroupBys(value)

PARAMETERS:

• value (array)

Array of labels to group data by.

fn timeSeriesList.withGroupBysMixin

timeSeriesList.withGroupBysMixin(value)

PARAMETERS:

• value (array)

Array of labels to group data by.

fn timeSeriesList.withPerSeriesAligner

timeSeriesList.withPerSeriesAligner(value)

PARAMETERS:

• value (string)

Alignment function to be used. Defaults to ALIGN_MEAN.

fn timeSeriesList.withPreprocessor

timeSeriesList.withPreprocessor(value)

PARAMETERS:

• value (string)
  • valid values: "none", "rate", "delta"

Types of pre-processor available. Defined by the metric.

fn timeSeriesList.withProjectName

timeSeriesList.withProjectName(value)

PARAMETERS:

• value (string)

GCP project to execute the query against.

fn timeSeriesList.withSecondaryAlignmentPeriod

timeSeriesList.withSecondaryAlignmentPeriod(value)

PARAMETERS:

• value (string)

Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.

fn timeSeriesList.withSecondaryCrossSeriesReducer

timeSeriesList.withSecondaryCrossSeriesReducer(value)

PARAMETERS:

• value (string)

Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.

fn timeSeriesList.withSecondaryGroupBys

timeSeriesList.withSecondaryGroupBys(value)

PARAMETERS:

• value (array)

Only present if a preprocessor is selected. Array of labels to group data by.

fn timeSeriesList.withSecondaryGroupBysMixin

timeSeriesList.withSecondaryGroupBysMixin(value)

PARAMETERS:

• value (array)

Only present if a preprocessor is selected. Array of labels to group data by.

fn timeSeriesList.withSecondaryPerSeriesAligner

timeSeriesList.withSecondaryPerSeriesAligner(value)

PARAMETERS:

• value (string)

Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN.

fn timeSeriesList.withText

timeSeriesList.withText(value)

PARAMETERS:

• value (string)

Annotation text.

fn timeSeriesList.withTitle

timeSeriesList.withTitle(value)

PARAMETERS:

• value (string)

Annotation title.

fn timeSeriesList.withView

timeSeriesList.withView(value)

PARAMETERS:

• value (string)

Data view, defaults to FULL.

obj timeSeriesQuery

fn timeSeriesQuery.withGraphPeriod

timeSeriesQuery.withGraphPeriod(value="disabled")

PARAMETERS:

• value (string)
  • default value: "disabled"

To disable the graphPeriod, it should explictly be set to 'disabled'.

fn timeSeriesQuery.withProjectName

timeSeriesQuery.withProjectName(value)

PARAMETERS:

• value (string)

GCP project to execute the query against.

fn timeSeriesQuery.withQuery

timeSeriesQuery.withQuery(value)

PARAMETERS:

• value (string)

MQL query to be executed.