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,
and db.sql.tokenized_id.
Note
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
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.
Contents
- Dimensions
-
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.
Valid values for elements in the
Dimensionsarray are:-
db.application.name- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) -
db.host.id- The host ID of the connected client (all engines) -
db.host.name- The host name of the connected client (all engines) -
db.name- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB) -
db.session_type.name- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) -
db.sql.id- The SQL ID generated by Performance Insights (all engines) -
db.sql.db_id- The SQL ID generated by the database (all engines) -
db.sql.statement- The SQL text that is being executed (all engines) -
db.sql.tokenized_id -
db.sql_tokenized.id- The SQL digest ID generated by Performance Insights (all engines) -
db.sql_tokenized.db_id- SQL digest ID generated by the database (all engines) -
db.sql_tokenized.statement- The SQL digest text (all engines) -
db.user.id- The ID of the user logged in to the database (all engines) -
db.user.name- The name of the user logged in to the database (all engines) -
db.wait_event.name- The event for which the backend is waiting (all engines) -
db.wait_event.type- The type of event for which the backend is waiting (all engines) -
db.wait_event_type.name- The name of the event type for which the backend is waiting (all engines)
Type: Array of strings
Required: No
-
- Group
-
The name of the dimension group. Its valid values are:
-
db- The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB) -
db.application- The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL) -
db.host- The host name of the connected client (all engines) -
db.session_type- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL) -
db.sql- The SQL that is currently executing (all engines) -
db.sql_tokenized- The SQL digest (all engines) -
db.wait_event- The event for which the database backend is waiting (all engines) -
db.wait_event_type- The type of event for which the database backend is waiting (all engines) -
db.user- The user logged in to the database (all engines)
Type: String
Required: No
-
- Limit
-
The maximum number of items to fetch for this dimension group.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
