You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PI::Types::MetricQuery

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing MetricQuery as input to an Aws::Client method, you can use a vanilla Hash:

{
  metric: "String", # required
  group_by: {
    group: "String", # required
    dimensions: ["String"],
    limit: 1,
  },
  filter: {
    "String" => "String",
  },
}

A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy), and return only those data points that match your criteria (Filter).

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ Hash<String,String>

One or more filters to apply in the request. Restrictions:

  • Any number of filters by the same dimension, as specified in the GroupBy parameter.

  • A single filter for any other dimension in this dimension group.

Returns:

  • (Hash<String,String>) —

    One or more filters to apply in the request.

#group_by ⇒ Types::DimensionGroup

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

Returns:

#metric ⇒ String

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

  • db.load.avg - a scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - the raw number of active sessions for the database engine.

Returns:

  • (String) —

    The name of a Performance Insights metric to be measured.