#[non_exhaustive]pub struct PerformanceInsightsMetricDimensionGroup {
pub group: Option<String>,
pub dimensions: Option<Vec<String>>,
pub limit: Option<i32>,
}
Expand description
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
.
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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.group: Option<String>
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)
dimensions: Option<Vec<String>>
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 Dimensions
array 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)
limit: Option<i32>
The maximum number of items to fetch for this dimension group.
Implementations§
source§impl PerformanceInsightsMetricDimensionGroup
impl PerformanceInsightsMetricDimensionGroup
sourcepub fn group(&self) -> Option<&str>
pub fn group(&self) -> Option<&str>
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)
sourcepub fn dimensions(&self) -> &[String]
pub fn dimensions(&self) -> &[String]
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 Dimensions
array 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)
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dimensions.is_none()
.
source§impl PerformanceInsightsMetricDimensionGroup
impl PerformanceInsightsMetricDimensionGroup
sourcepub fn builder() -> PerformanceInsightsMetricDimensionGroupBuilder
pub fn builder() -> PerformanceInsightsMetricDimensionGroupBuilder
Creates a new builder-style object to manufacture PerformanceInsightsMetricDimensionGroup
.
Trait Implementations§
source§impl Clone for PerformanceInsightsMetricDimensionGroup
impl Clone for PerformanceInsightsMetricDimensionGroup
source§fn clone(&self) -> PerformanceInsightsMetricDimensionGroup
fn clone(&self) -> PerformanceInsightsMetricDimensionGroup
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for PerformanceInsightsMetricDimensionGroup
impl PartialEq for PerformanceInsightsMetricDimensionGroup
source§fn eq(&self, other: &PerformanceInsightsMetricDimensionGroup) -> bool
fn eq(&self, other: &PerformanceInsightsMetricDimensionGroup) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for PerformanceInsightsMetricDimensionGroup
Auto Trait Implementations§
impl Freeze for PerformanceInsightsMetricDimensionGroup
impl RefUnwindSafe for PerformanceInsightsMetricDimensionGroup
impl Send for PerformanceInsightsMetricDimensionGroup
impl Sync for PerformanceInsightsMetricDimensionGroup
impl Unpin for PerformanceInsightsMetricDimensionGroup
impl UnwindSafe for PerformanceInsightsMetricDimensionGroup
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more