We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
Optional
DimensionsA 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 Dimensions
array are:
db.application.name
- The name of the application that is connected to the database. Valid values are as follows:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Amazon DocumentDB
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. Valid values are as follows:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Aurora MySQL
Amazon RDS MySQL
Amazon RDS MariaDB
Amazon DocumentDB
db.query.id
- The query ID generated by Performance Insights (only Amazon DocumentDB).
db.query.db_id
- The query ID generated by the database (only Amazon DocumentDB).
db.query.statement
- The text of the query that is being run (only Amazon DocumentDB).
db.query.tokenized_id
db.query.tokenized.id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.db_id
- The query digest ID generated by Performance Insights (only Amazon DocumentDB).
db.query.tokenized.statement
- The text of the query digest (only Amazon DocumentDB).
db.session_type.name
- The type of the current session (only Amazon DocumentDB).
db.sql.id
- The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).
db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with
pi-
(all engines except Amazon DocumentDB).
db.sql.statement
- The full text of the SQL statement that is running, as in SELECT * FROM employees
(all engines except Amazon DocumentDB)
db.sql.tokenized_id
db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console,
db.sql_tokenized.id
is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot
database issues.
db.sql_tokenized.db_id
- Either the native database ID used to refer to the SQL statement, or a synthetic ID such as
pi-2372568224
that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).
db.sql_tokenized.statement
- The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id =
?
(all engines except Amazon DocumentDB)
db.user.id
- The ID of the user logged in to the database (all engines except Amazon DocumentDB).
db.user.name
- The name of the user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event.name
- The event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event.type
- The type of event for which the backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type.name
- The name of the event type for which the backend is waiting (all engines except
Amazon DocumentDB).
db.wait_state.name
- The event for which the backend is waiting (only Amazon DocumentDB).
The name of the dimension group. Valid values are as follows:
db
- The name of the database to which the client is connected. The following values are permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Aurora MySQL
Amazon RDS MySQL
Amazon RDS MariaDB
Amazon DocumentDB
db.application
- The name of the application that is connected to the database. The following values are
permitted:
Aurora PostgreSQL
Amazon RDS PostgreSQL
Amazon DocumentDB
db.host
- The host name of the connected client (all engines).
db.query
- The query that is currently running (only Amazon DocumentDB).
db.query_tokenized
- The digest query (only Amazon DocumentDB).
db.session_type
- The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL).
db.sql
- The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).
db.sql_tokenized
- The SQL digest (all engines except Amazon DocumentDB).
db.user
- The user logged in to the database (all engines except Amazon DocumentDB).
db.wait_event
- The event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_event_type
- The type of event for which the database backend is waiting (all engines except Amazon DocumentDB).
db.wait_state
- The event for which the database backend is waiting (only Amazon DocumentDB).
Optional
LimitThe maximum number of items to fetch for this 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
- The hash of a running SQL statement, generated by Performance Insights.db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins withpi-
.db.sql.statement
- The full text of the SQL statement that is running, for example,SELECT * FROM employees
.db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights.Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.