#[non_exhaustive]pub struct PerformanceInsightsMetricQuery {
pub metric: Option<String>,
pub group_by: Option<PerformanceInsightsMetricDimensionGroup>,
pub filter: Option<HashMap<String, String>>,
}
Expand description
A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics
API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics
in the Amazon RDS Performance Insights API Reference.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
-
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
-
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.metric: Option<String>
The name of the meteric used used when querying an Performance Insights GetResourceMetrics
API for anomaly metrics.
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.
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.
group_by: Option<PerformanceInsightsMetricDimensionGroup>
The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics
API query. The Performance Insights query returns 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.
filter: Option<HashMap<String, String>>
One or more filters to apply to a Performance Insights GetResourceMetrics
API query. 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.
Implementations
The name of the meteric used used when querying an Performance Insights GetResourceMetrics
API for anomaly metrics.
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.
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.
The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics
API query. The Performance Insights query returns 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.
One or more filters to apply to a Performance Insights GetResourceMetrics
API query. 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.
Creates a new builder-style object to manufacture PerformanceInsightsMetricQuery
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl Send for PerformanceInsightsMetricQuery
impl Sync for PerformanceInsightsMetricQuery
impl Unpin for PerformanceInsightsMetricQuery
impl UnwindSafe for PerformanceInsightsMetricQuery
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more