PerformanceInsightsMetricQuery
A single Performance Insights metric query to process. You must provide the metric to the query.
If other parameters aren't specified, Performance Insights returns all data points for the
specified metric. Optionally, you can request the data points to be aggregated by dimension
group (GroupBy
) and return only those data points that match your criteria (Filter
).
Constraints:
-
Must be a valid Performance Insights query.
Contents
Note
In the following list, the required parameters are described first.
- GroupBy
-
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.
Type: PerformanceInsightsMetricDimensionGroup object
Required: No
- Metric
-
The name of a Performance Insights metric to be measured.
Valid Values:
-
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.
If the number of active sessions is less than an internal Performance Insights threshold,
db.load.avg
anddb.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avg
showing the scaled values,db.sampledload.avg
showing the raw values, anddb.sampledload.avg
less thandb.load.avg
. For most use cases, you can querydb.load.avg
only.Type: String
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: