Skip to content

cloudWatch

grafonnet.query.cloudWatch

Subpackages

Index

Fields

obj CloudWatchAnnotationQuery

fn CloudWatchAnnotationQuery.withAccountId

CloudWatchAnnotationQuery.withAccountId(value)

PARAMETERS:

  • value (string)

The ID of the AWS account to query for the metric, specifying all will query all accounts that the monitoring account is permitted to query.

fn CloudWatchAnnotationQuery.withActionPrefix

CloudWatchAnnotationQuery.withActionPrefix(value)

PARAMETERS:

  • value (string)

Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic. e.g. arn:aws:sns:us-east-1:123456789012:my-app- would match arn:aws:sns:us-east-1:123456789012:my-app-action but not match arn:aws:sns:us-east-1:123456789012:your-app-action

fn CloudWatchAnnotationQuery.withAlarmNamePrefix

CloudWatchAnnotationQuery.withAlarmNamePrefix(value)

PARAMETERS:

  • value (string)

An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix. e.g. my-team-service- would match my-team-service-high-cpu but not match your-team-service-high-cpu

fn CloudWatchAnnotationQuery.withDatasource

CloudWatchAnnotationQuery.withDatasource(value)

PARAMETERS:

  • value (string)

Set the datasource for this query.

fn CloudWatchAnnotationQuery.withDimensions

CloudWatchAnnotationQuery.withDimensions(value)

PARAMETERS:

  • value (object)

A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.

fn CloudWatchAnnotationQuery.withDimensionsMixin

CloudWatchAnnotationQuery.withDimensionsMixin(value)

PARAMETERS:

  • value (object)

A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.

fn CloudWatchAnnotationQuery.withHide

CloudWatchAnnotationQuery.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 CloudWatchAnnotationQuery.withMatchExact

CloudWatchAnnotationQuery.withMatchExact(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Only show metrics that exactly match all defined dimension names.

fn CloudWatchAnnotationQuery.withMetricName

CloudWatchAnnotationQuery.withMetricName(value)

PARAMETERS:

  • value (string)

Name of the metric

fn CloudWatchAnnotationQuery.withNamespace

CloudWatchAnnotationQuery.withNamespace(value)

PARAMETERS:

  • value (string)

A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.

fn CloudWatchAnnotationQuery.withPeriod

CloudWatchAnnotationQuery.withPeriod(value)

PARAMETERS:

  • value (string)

The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes

fn CloudWatchAnnotationQuery.withPrefixMatching

CloudWatchAnnotationQuery.withPrefixMatching(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix

fn CloudWatchAnnotationQuery.withQueryMode

CloudWatchAnnotationQuery.withQueryMode(value="Annotations")

PARAMETERS:

  • value (string)
    • default value: "Annotations"
    • valid values: "Metrics", "Logs", "Annotations"

Whether a query is a Metrics, Logs, or Annotations query

fn CloudWatchAnnotationQuery.withQueryType

CloudWatchAnnotationQuery.withQueryType(value)

PARAMETERS:

  • value (string)

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

fn CloudWatchAnnotationQuery.withRefId

CloudWatchAnnotationQuery.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 CloudWatchAnnotationQuery.withRegion

CloudWatchAnnotationQuery.withRegion(value)

PARAMETERS:

  • value (string)

AWS region to query for the metric

fn CloudWatchAnnotationQuery.withStatistic

CloudWatchAnnotationQuery.withStatistic(value)

PARAMETERS:

  • value (string)

Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.

fn CloudWatchAnnotationQuery.withStatistics

CloudWatchAnnotationQuery.withStatistics(value)

PARAMETERS:

  • value (array)

@deprecated use statistic

fn CloudWatchAnnotationQuery.withStatisticsMixin

CloudWatchAnnotationQuery.withStatisticsMixin(value)

PARAMETERS:

  • value (array)

@deprecated use statistic

obj CloudWatchAnnotationQuery.datasource

fn CloudWatchAnnotationQuery.datasource.withType
CloudWatchAnnotationQuery.datasource.withType(value)

PARAMETERS:

  • value (string)

The plugin type-id

fn CloudWatchAnnotationQuery.datasource.withUid
CloudWatchAnnotationQuery.datasource.withUid(value)

PARAMETERS:

  • value (string)

Specific datasource instance

obj CloudWatchLogsQuery

fn CloudWatchLogsQuery.withDatasource

CloudWatchLogsQuery.withDatasource(value)

PARAMETERS:

  • value (string)

Set the datasource for this query.

fn CloudWatchLogsQuery.withExpression

CloudWatchLogsQuery.withExpression(value)

PARAMETERS:

  • value (string)

The CloudWatch Logs Insights query to execute

fn CloudWatchLogsQuery.withHide

CloudWatchLogsQuery.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 CloudWatchLogsQuery.withId

CloudWatchLogsQuery.withId(value)

PARAMETERS:

  • value (string)

fn CloudWatchLogsQuery.withLogGroupNames

CloudWatchLogsQuery.withLogGroupNames(value)

PARAMETERS:

  • value (array)

@deprecated use logGroups

fn CloudWatchLogsQuery.withLogGroupNamesMixin

CloudWatchLogsQuery.withLogGroupNamesMixin(value)

PARAMETERS:

  • value (array)

@deprecated use logGroups

fn CloudWatchLogsQuery.withLogGroups

CloudWatchLogsQuery.withLogGroups(value)

PARAMETERS:

  • value (array)

Log groups to query

fn CloudWatchLogsQuery.withLogGroupsMixin

CloudWatchLogsQuery.withLogGroupsMixin(value)

PARAMETERS:

  • value (array)

Log groups to query

fn CloudWatchLogsQuery.withQueryLanguage

CloudWatchLogsQuery.withQueryLanguage(value)

PARAMETERS:

  • value (string)
    • valid values: "CWLI", "SQL", "PPL"

Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI.

fn CloudWatchLogsQuery.withQueryMode

CloudWatchLogsQuery.withQueryMode(value="Logs")

PARAMETERS:

  • value (string)
    • default value: "Logs"
    • valid values: "Metrics", "Logs", "Annotations"

Whether a query is a Metrics, Logs, or Annotations query

fn CloudWatchLogsQuery.withQueryType

CloudWatchLogsQuery.withQueryType(value)

PARAMETERS:

  • value (string)

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

fn CloudWatchLogsQuery.withRefId

CloudWatchLogsQuery.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 CloudWatchLogsQuery.withRegion

CloudWatchLogsQuery.withRegion(value)

PARAMETERS:

  • value (string)

AWS region to query for the logs

fn CloudWatchLogsQuery.withStatsGroups

CloudWatchLogsQuery.withStatsGroups(value)

PARAMETERS:

  • value (array)

Fields to group the results by, this field is automatically populated whenever the query is updated

fn CloudWatchLogsQuery.withStatsGroupsMixin

CloudWatchLogsQuery.withStatsGroupsMixin(value)

PARAMETERS:

  • value (array)

Fields to group the results by, this field is automatically populated whenever the query is updated

obj CloudWatchLogsQuery.datasource

fn CloudWatchLogsQuery.datasource.withType
CloudWatchLogsQuery.datasource.withType(value)

PARAMETERS:

  • value (string)

The plugin type-id

fn CloudWatchLogsQuery.datasource.withUid
CloudWatchLogsQuery.datasource.withUid(value)

PARAMETERS:

  • value (string)

Specific datasource instance

obj CloudWatchMetricsQuery

fn CloudWatchMetricsQuery.withAccountId

CloudWatchMetricsQuery.withAccountId(value)

PARAMETERS:

  • value (string)

The ID of the AWS account to query for the metric, specifying all will query all accounts that the monitoring account is permitted to query.

fn CloudWatchMetricsQuery.withAlias

CloudWatchMetricsQuery.withAlias(value)

PARAMETERS:

  • value (string)

Deprecated: use label @deprecated use label

fn CloudWatchMetricsQuery.withDatasource

CloudWatchMetricsQuery.withDatasource(value)

PARAMETERS:

  • value (string)

Set the datasource for this query.

fn CloudWatchMetricsQuery.withDimensions

CloudWatchMetricsQuery.withDimensions(value)

PARAMETERS:

  • value (object)

A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.

fn CloudWatchMetricsQuery.withDimensionsMixin

CloudWatchMetricsQuery.withDimensionsMixin(value)

PARAMETERS:

  • value (object)

A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.

fn CloudWatchMetricsQuery.withExpression

CloudWatchMetricsQuery.withExpression(value)

PARAMETERS:

  • value (string)

Math expression query

fn CloudWatchMetricsQuery.withHide

CloudWatchMetricsQuery.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 CloudWatchMetricsQuery.withId

CloudWatchMetricsQuery.withId(value)

PARAMETERS:

  • value (string)

ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.

fn CloudWatchMetricsQuery.withLabel

CloudWatchMetricsQuery.withLabel(value)

PARAMETERS:

  • value (string)

Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.

fn CloudWatchMetricsQuery.withMatchExact

CloudWatchMetricsQuery.withMatchExact(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Only show metrics that exactly match all defined dimension names.

fn CloudWatchMetricsQuery.withMetricEditorMode

CloudWatchMetricsQuery.withMetricEditorMode(value)

PARAMETERS:

  • value (string)
    • valid values: 0, 1

Whether to use the query builder or code editor to create the query

fn CloudWatchMetricsQuery.withMetricName

CloudWatchMetricsQuery.withMetricName(value)

PARAMETERS:

  • value (string)

Name of the metric

fn CloudWatchMetricsQuery.withMetricQueryType

CloudWatchMetricsQuery.withMetricQueryType(value)

PARAMETERS:

  • value (string)
    • valid values: 0, 1

Whether to use a metric search or metric insights query

fn CloudWatchMetricsQuery.withNamespace

CloudWatchMetricsQuery.withNamespace(value)

PARAMETERS:

  • value (string)

A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.

fn CloudWatchMetricsQuery.withPeriod

CloudWatchMetricsQuery.withPeriod(value)

PARAMETERS:

  • value (string)

The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes

fn CloudWatchMetricsQuery.withQueryMode

CloudWatchMetricsQuery.withQueryMode(value="Metrics")

PARAMETERS:

  • value (string)
    • default value: "Metrics"
    • valid values: "Metrics", "Logs", "Annotations"

Whether a query is a Metrics, Logs, or Annotations query

fn CloudWatchMetricsQuery.withQueryType

CloudWatchMetricsQuery.withQueryType(value)

PARAMETERS:

  • value (string)

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

fn CloudWatchMetricsQuery.withRefId

CloudWatchMetricsQuery.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 CloudWatchMetricsQuery.withRegion

CloudWatchMetricsQuery.withRegion(value)

PARAMETERS:

  • value (string)

AWS region to query for the metric

fn CloudWatchMetricsQuery.withSql

CloudWatchMetricsQuery.withSql(value)

PARAMETERS:

  • value (object)

When the metric query type is set to Insights and the metricEditorMode is set to Builder, this field is used to build up an object representation of a SQL query.

fn CloudWatchMetricsQuery.withSqlExpression

CloudWatchMetricsQuery.withSqlExpression(value)

PARAMETERS:

  • value (string)

When the metric query type is set to Insights, this field is used to specify the query string.

fn CloudWatchMetricsQuery.withSqlMixin

CloudWatchMetricsQuery.withSqlMixin(value)

PARAMETERS:

  • value (object)

When the metric query type is set to Insights and the metricEditorMode is set to Builder, this field is used to build up an object representation of a SQL query.

fn CloudWatchMetricsQuery.withStatistic

CloudWatchMetricsQuery.withStatistic(value)

PARAMETERS:

  • value (string)

Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.

fn CloudWatchMetricsQuery.withStatistics

CloudWatchMetricsQuery.withStatistics(value)

PARAMETERS:

  • value (array)

@deprecated use statistic

fn CloudWatchMetricsQuery.withStatisticsMixin

CloudWatchMetricsQuery.withStatisticsMixin(value)

PARAMETERS:

  • value (array)

@deprecated use statistic

obj CloudWatchMetricsQuery.datasource

fn CloudWatchMetricsQuery.datasource.withType
CloudWatchMetricsQuery.datasource.withType(value)

PARAMETERS:

  • value (string)

The plugin type-id

fn CloudWatchMetricsQuery.datasource.withUid
CloudWatchMetricsQuery.datasource.withUid(value)

PARAMETERS:

  • value (string)

Specific datasource instance

obj CloudWatchMetricsQuery.sql

fn CloudWatchMetricsQuery.sql.withFrom
CloudWatchMetricsQuery.sql.withFrom(value)

PARAMETERS:

  • value (object)

FROM part of the SQL expression

fn CloudWatchMetricsQuery.sql.withFromMixin
CloudWatchMetricsQuery.sql.withFromMixin(value)

PARAMETERS:

  • value (object)

FROM part of the SQL expression

fn CloudWatchMetricsQuery.sql.withGroupBy
CloudWatchMetricsQuery.sql.withGroupBy(value)

PARAMETERS:

  • value (object)

GROUP BY part of the SQL expression

fn CloudWatchMetricsQuery.sql.withGroupByMixin
CloudWatchMetricsQuery.sql.withGroupByMixin(value)

PARAMETERS:

  • value (object)

GROUP BY part of the SQL expression

fn CloudWatchMetricsQuery.sql.withLimit
CloudWatchMetricsQuery.sql.withLimit(value)

PARAMETERS:

  • value (integer)

LIMIT part of the SQL expression

fn CloudWatchMetricsQuery.sql.withOrderBy
CloudWatchMetricsQuery.sql.withOrderBy(value)

PARAMETERS:

  • value (object)

ORDER BY part of the SQL expression

fn CloudWatchMetricsQuery.sql.withOrderByDirection
CloudWatchMetricsQuery.sql.withOrderByDirection(value)

PARAMETERS:

  • value (string)

The sort order of the SQL expression, ASC or DESC

fn CloudWatchMetricsQuery.sql.withOrderByMixin
CloudWatchMetricsQuery.sql.withOrderByMixin(value)

PARAMETERS:

  • value (object)

ORDER BY part of the SQL expression

fn CloudWatchMetricsQuery.sql.withSelect
CloudWatchMetricsQuery.sql.withSelect(value)

PARAMETERS:

  • value (object)

SELECT part of the SQL expression

fn CloudWatchMetricsQuery.sql.withSelectMixin
CloudWatchMetricsQuery.sql.withSelectMixin(value)

PARAMETERS:

  • value (object)

SELECT part of the SQL expression

fn CloudWatchMetricsQuery.sql.withWhere
CloudWatchMetricsQuery.sql.withWhere(value)

PARAMETERS:

  • value (object)

WHERE part of the SQL expression

fn CloudWatchMetricsQuery.sql.withWhereMixin
CloudWatchMetricsQuery.sql.withWhereMixin(value)

PARAMETERS:

  • value (object)

WHERE part of the SQL expression

obj CloudWatchMetricsQuery.sql.from
fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression
CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression(value)

PARAMETERS:

  • value (object)
fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin
CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin(value)

PARAMETERS:

  • value (object)
fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression
CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression(value)

PARAMETERS:

  • value (object)
fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin
CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin(value)

PARAMETERS:

  • value (object)
obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression
# fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName
CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName(value)

PARAMETERS:

  • value (string)
# fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters
CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters(value)

PARAMETERS:

  • value (array)
# fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin
CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin(value)

PARAMETERS:

  • value (array)
# fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType
CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType()
obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression
# fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty
CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty(value)

PARAMETERS:

  • value (object)
# fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin
CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin(value)

PARAMETERS:

  • value (object)
# fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType
CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType()
# obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property
## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName
CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName(value)

PARAMETERS:

  • value (string)
## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType
CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType(value)

PARAMETERS:

  • value (string)
    • valid values: "string"
obj CloudWatchMetricsQuery.sql.groupBy
fn CloudWatchMetricsQuery.sql.groupBy.withExpressions
CloudWatchMetricsQuery.sql.groupBy.withExpressions(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin
CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.groupBy.withType
CloudWatchMetricsQuery.sql.groupBy.withType(value)

PARAMETERS:

  • value (string)
    • valid values: "and", "or"
obj CloudWatchMetricsQuery.sql.orderBy
fn CloudWatchMetricsQuery.sql.orderBy.withName
CloudWatchMetricsQuery.sql.orderBy.withName(value)

PARAMETERS:

  • value (string)
fn CloudWatchMetricsQuery.sql.orderBy.withParameters
CloudWatchMetricsQuery.sql.orderBy.withParameters(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.orderBy.withParametersMixin
CloudWatchMetricsQuery.sql.orderBy.withParametersMixin(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.orderBy.withType
CloudWatchMetricsQuery.sql.orderBy.withType()
obj CloudWatchMetricsQuery.sql.select
fn CloudWatchMetricsQuery.sql.select.withName
CloudWatchMetricsQuery.sql.select.withName(value)

PARAMETERS:

  • value (string)
fn CloudWatchMetricsQuery.sql.select.withParameters
CloudWatchMetricsQuery.sql.select.withParameters(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.select.withParametersMixin
CloudWatchMetricsQuery.sql.select.withParametersMixin(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.select.withType
CloudWatchMetricsQuery.sql.select.withType()
obj CloudWatchMetricsQuery.sql.where
fn CloudWatchMetricsQuery.sql.where.withExpressions
CloudWatchMetricsQuery.sql.where.withExpressions(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.where.withExpressionsMixin
CloudWatchMetricsQuery.sql.where.withExpressionsMixin(value)

PARAMETERS:

  • value (array)
fn CloudWatchMetricsQuery.sql.where.withType
CloudWatchMetricsQuery.sql.where.withType(value)

PARAMETERS:

  • value (string)
    • valid values: "and", "or"