Expand description
AWS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running RDS instance. The guide provides detailed information about Performance Insights data types, parameters and errors. For more information about Performance Insights capabilities see Using Amazon RDS Performance Insights in the Amazon RDS User Guide.
The AWS Performance Insights API provides visibility into the performance of your RDS instance, when Performance Insights is enabled for supported engine types. While Amazon CloudWatch provides the authoritative source for AWS service vended monitoring metrics, AWS Performance Insights offers a domain-specific view of database load measured as Average Active Sessions and provided to API consumers as a 2-dimensional time-series dataset. The time dimension of the data provides DB load data for each time point in the queried time range, and each time point decomposes overall load in relation to the requested dimensions, such as SQL, Wait-event, User or Host, measured at that time point.
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.sql
dimension group consists of the following dimensions:db.sql.id
,db.sql.db_id
,db.sql.statement
, anddb.sql.tokenized_id
.- Dimension
KeyDescription An array of descriptions and aggregated values for each dimension within a dimension group.
- GetResource
Metrics Request - GetResource
Metrics Response - Metric
KeyData Points A time-ordered series of data points, correpsonding 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
PartitionBy
was specified in aDescribeDimensionKeys
request, 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
- 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.