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

Inherits:

Struct

• Object
• Struct
• Aws::PI::Types::MetricQuery

Defined in:

gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb

Overview

A single query to be processed. You must provide the metric to query and append an aggregate function to the metric. For example, to find the average for the metric db.load you must use db.load.avg. Valid values for aggregate functions include .avg, .min, .max, and .sum. If no other parameters are specified, Performance Insights returns all data points for the specified metric. Optionally, you can request that the data points be aggregated by dimension group (GroupBy), and return only those data points that match your criteria (Filter).

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filter ⇒ 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.

• #metric ⇒ String

  The name of a Performance Insights metric to be measured.

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.

The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1595

class MetricQuery < Struct.new(
  :metric,
  :group_by,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#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:

• (Types::DimensionGroup)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1595

class MetricQuery < Struct.new(
  :metric,
  :group_by,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end

#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.

• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

• The counter metrics listed in Performance Insights operating system counters in the Amazon RDS User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

Returns:

• (String)

# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/types.rb', line 1595

class MetricQuery < Struct.new(
  :metric,
  :group_by,
  :filter)
  SENSITIVE = []
  include Aws::Structure
end