Expand description
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 AWS 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.
If you’re using the service, you’re probably looking for PerformanceInsightsClient and PerformanceInsights.
Structs§
- Data
Point A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.
- Describe
Dimension Keys Request - Describe
Dimension Keys Response - Dimension
Group A logical grouping of Performance Insights metrics for a related subject area. For example, the
db.sqldimension group consists of the following dimensions:db.sql.id,db.sql.dbid,db.sql.statement, anddb.sql.tokenizedid.Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
- Dimension
KeyDescription An array of descriptions and aggregated values for each dimension within a dimension group.
- Dimension
KeyDetail An object that describes the details for a specified dimension.
- GetDimension
KeyDetails Request - GetDimension
KeyDetails Response - GetResource
Metrics Request - GetResource
Metrics Response - Metric
KeyData Points A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.
- Metric
Query 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).- Performance
Insights Client - A client for the AWS PI API.
- Response
Partition Key If
PartitionBywas specified in aDescribeDimensionKeysrequest, the dimensions are returned in an array. Each element in the array specifies one dimension.- Response
Resource Metric Key An object describing a Performance Insights metric and one or more dimensions for that metric.
Enums§
- Describe
Dimension Keys Error - Errors returned by DescribeDimensionKeys
- GetDimension
KeyDetails Error - Errors returned by GetDimensionKeyDetails
- GetResource
Metrics Error - Errors returned by GetResourceMetrics
Traits§
- Performance
Insights - Trait representing the capabilities of the AWS PI API. AWS PI clients implement this trait.