View Source AWS.PI (aws-elixir v0.13.3)
Amazon RDS Performance Insights
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance.
The guide provides detailed information about Performance Insights data types, parameters and errors.
When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.
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 .
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
Link to this section Summary
Functions
For a specific time period, retrieve the top N dimension keys for a metric.
Get the attributes of the specified dimension group for a DB instance or data source.
Retrieve the metadata for different features.
Retrieve Performance Insights metrics for a set of data sources over a time period.
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
Retrieve metrics of the specified types that can be queried for a specified DB instance.
Link to this section Functions
For a specific time period, retrieve the top N dimension keys for a metric.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Get the attributes of the specified dimension group for a DB instance or data source.
For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the
full text of the dimension db.sql.statement associated with this ID. This
operation is useful because GetResourceMetrics and DescribeDimensionKeys
don't support retrieval of large SQL statement text.
Retrieve the metadata for different features.
For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
Retrieve Performance Insights metrics for a set of data sources over a time period.
You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
Retrieve metrics of the specified types that can be queried for a specified DB instance.