Struct AppMonitorConfiguration

#[non_exhaustive]
pub struct AppMonitorConfiguration {
    pub identity_pool_id: Option<String>,
    pub excluded_pages: Option<Vec<String>>,
    pub included_pages: Option<Vec<String>>,
    pub favorite_pages: Option<Vec<String>>,
    pub session_sample_rate: f64,
    pub guest_role_arn: Option<String>,
    pub allow_cookies: Option<bool>,
    pub telemetries: Option<Vec<Telemetry>>,
    pub enable_x_ray: Option<bool>,
}

This structure contains much of the configuration data for the app monitor.

Fields (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.

identity_pool_id: Option<String>

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

excluded_pages: Option<Vec<String>>

A list of URLs in your website or application to exclude from RUM data collection.

You can't include both ExcludedPages and IncludedPages in the same operation.

included_pages: Option<Vec<String>>

If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.

You can't include both ExcludedPages and IncludedPages in the same operation.

favorite_pages: Option<Vec<String>>

A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

session_sample_rate: f64

Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.

The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

guest_role_arn: Option<String>

The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service.

If this issue affects you, you can take one of the following steps:

• Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.

• Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.

allow_cookies: Option<bool>

If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.

telemetries: Option<Vec<Telemetry>>

An array that lists the types of telemetry data that this app monitor is to collect.

• errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

• performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

• http indicates that RUM collects data about HTTP errors thrown by your application.

enable_x_ray: Option<bool>

If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?

Implementations

impl AppMonitorConfiguration

pub fn identity_pool_id(&self) -> Option<&str>

The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

pub fn excluded_pages(&self) -> &[String]

A list of URLs in your website or application to exclude from RUM data collection.

You can't include both ExcludedPages and IncludedPages in the same operation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .excluded_pages.is_none().

pub fn included_pages(&self) -> &[String]

If this app monitor is to collect data from only certain pages in your application, this structure lists those pages.

You can't include both ExcludedPages and IncludedPages in the same operation.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .included_pages.is_none().

pub fn favorite_pages(&self) -> &[String]

A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .favorite_pages.is_none().

pub fn session_sample_rate(&self) -> f64

Specifies the portion of user sessions to use for RUM data collection. Choosing a higher portion gives you more data but also incurs more costs.

The range for this value is 0 to 1 inclusive. Setting this to 1 means that 100% of user sessions are sampled, and setting it to 0.1 means that 10% of user sessions are sampled.

If you omit this parameter, the default of 0.1 is used, and 10% of sessions will be sampled.

pub fn guest_role_arn(&self) -> Option<&str>

The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.

It is possible that an app monitor does not have a value for GuestRoleArn. For example, this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to create a new identity pool for Authorization. In this case, GuestRoleArn is not present in the GetAppMonitor response because it is not stored by the service.

If this issue affects you, you can take one of the following steps:

• Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM role, and use that for your app monitor.

• Make a separate GetIdentityPoolRoles call to Amazon Cognito to retrieve the GuestRoleArn.

pub fn allow_cookies(&self) -> Option<bool>

If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page.

pub fn telemetries(&self) -> &[Telemetry]

An array that lists the types of telemetry data that this app monitor is to collect.

• errors indicates that RUM collects data about unhandled JavaScript errors raised by your application.

• performance indicates that RUM collects performance data about how your application and its resources are loaded and rendered. This includes Core Web Vitals.

• http indicates that RUM collects data about HTTP errors thrown by your application.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .telemetries.is_none().

pub fn enable_x_ray(&self) -> Option<bool>

If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. You can see traces and segments from these user sessions in the X-Ray console and the CloudWatch ServiceLens console. For more information, see What is X-Ray?

impl AppMonitorConfiguration

pub fn builder() -> AppMonitorConfigurationBuilder

Creates a new builder-style object to manufacture AppMonitorConfiguration.

Trait Implementations

impl Clone for AppMonitorConfiguration

fn clone(&self) -> AppMonitorConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppMonitorConfiguration

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

Formats the value using the given formatter.

impl PartialEq for AppMonitorConfiguration

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AppMonitorConfiguration