Retrieving metrics with the Performance Insights API for Amazon RDS
When Performance Insights is turned on, the API provides visibility into instance performance. Amazon CloudWatch Logs provides the authoritative source for vended monitoring metrics for AWS services.
Performance Insights offers a domain-specific view of database load measured as average active sessions (AAS). This
metric appears to API consumers as a two-dimensional time-series dataset. The time dimension of the data 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, such as SQL, Wait-event, User, or Host,
measured at that time point.
Amazon RDS Performance Insights monitors your Amazon RDS DB instance so that you can analyze and troubleshoot database performance. One way to view Performance Insights data is in the AWS Management Console. Performance Insights also provides a public API so that you can query your own data. You can use the API to do the following:
-
Offload data into a database
-
Add Performance Insights data to existing monitoring dashboards
-
Build monitoring tools
To use the Performance Insights API, enable Performance Insights on one of your Amazon RDS DB instances. For information about enabling Performance Insights, see Turning Performance Insights on and off for Amazon RDS. For more information about the Performance Insights API, see the Amazon RDS Performance Insights API Reference.
The Performance Insights API provides the following operations.
|
Performance Insights action |
AWS CLI command |
Description |
|---|---|---|
|
Creates a performance analysis report for a specific time period for the DB instance.
The result is |
||
|
Deletes a performance analysis report. |
||
|
Retrieves the top N dimension keys for a metric for a specific time period. |
||
|
Retrieves the attributes of the specified dimension group for a DB instance or data source. For
example, if you specify a SQL ID, and if the dimension details are available,
|
||
|
Retrieves the report including the insights for the report. The result includes the report status, report ID, report time details, insights, and recommendations. |
||
GetResourceMetadata |
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. |
|
|
Retrieves 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. |
||
ListAvailableResourceDimensions |
Retrieve the dimensions that can be queried for each specified metric type on a specified instance. |
|
ListAvailableResourceMetrics |
Retrieve all available metrics of the specified metric types that can be queried for a specified DB instance. |
|
| Retrieves all the analysis reports available for the DB instance. The reports are listed based on the start time of each report. | ||
|
Lists all the metadata tags added to the resource. The list includes the name and value of the tag. |
||
|
Adds metadata tags to the Amazon RDS resource. The tag includes a name and a value. |
||
|
Removes the metadata tag from the resource. |
For more information about retrieving time-series metrics and AWS CLI examples for Performance Insights, see the following topics.
Topics
