#[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.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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

source

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)

source

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

pub fn limit(&self) -> Option<i32>

The maximum number of items to fetch for this dimension group.

source§

impl PerformanceInsightsMetricDimensionGroup

Trait Implementations§

source§

impl Clone for PerformanceInsightsMetricDimensionGroup

source§

fn clone(&self) -> PerformanceInsightsMetricDimensionGroup

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for PerformanceInsightsMetricDimensionGroup

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq for PerformanceInsightsMetricDimensionGroup

source§

fn eq(&self, other: &PerformanceInsightsMetricDimensionGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for PerformanceInsightsMetricDimensionGroup

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more