#[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>,
}
Expand description
This structure contains much of the configuration data for the app monitor.
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.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
.
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§
Source§impl AppMonitorConfiguration
impl AppMonitorConfiguration
Sourcepub fn identity_pool_id(&self) -> Option<&str>
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.
Sourcepub fn excluded_pages(&self) -> &[String]
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()
.
Sourcepub fn included_pages(&self) -> &[String]
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()
.
Sourcepub fn favorite_pages(&self) -> &[String]
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()
.
Sourcepub fn session_sample_rate(&self) -> f64
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.
Sourcepub fn guest_role_arn(&self) -> Option<&str>
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
.
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.
Sourcepub fn telemetries(&self) -> &[Telemetry]
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()
.
Sourcepub fn enable_x_ray(&self) -> Option<bool>
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?
Source§impl AppMonitorConfiguration
impl AppMonitorConfiguration
Sourcepub fn builder() -> AppMonitorConfigurationBuilder
pub fn builder() -> AppMonitorConfigurationBuilder
Creates a new builder-style object to manufacture AppMonitorConfiguration
.
Trait Implementations§
Source§impl Clone for AppMonitorConfiguration
impl Clone for AppMonitorConfiguration
Source§fn clone(&self) -> AppMonitorConfiguration
fn clone(&self) -> AppMonitorConfiguration
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AppMonitorConfiguration
impl Debug for AppMonitorConfiguration
Source§impl PartialEq for AppMonitorConfiguration
impl PartialEq for AppMonitorConfiguration
Source§fn eq(&self, other: &AppMonitorConfiguration) -> bool
fn eq(&self, other: &AppMonitorConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AppMonitorConfiguration
Auto Trait Implementations§
impl Freeze for AppMonitorConfiguration
impl RefUnwindSafe for AppMonitorConfiguration
impl Send for AppMonitorConfiguration
impl Sync for AppMonitorConfiguration
impl Unpin for AppMonitorConfiguration
impl UnwindSafe for AppMonitorConfiguration
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);