Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data AppMonitorConfiguration = AppMonitorConfiguration' {
- allowCookies :: Maybe Bool
- enableXRay :: Maybe Bool
- excludedPages :: Maybe [Text]
- favoritePages :: Maybe [Text]
- guestRoleArn :: Maybe Text
- identityPoolId :: Maybe Text
- includedPages :: Maybe [Text]
- sessionSampleRate :: Maybe Double
- telemetries :: Maybe [Telemetry]
- newAppMonitorConfiguration :: AppMonitorConfiguration
- appMonitorConfiguration_allowCookies :: Lens' AppMonitorConfiguration (Maybe Bool)
- appMonitorConfiguration_enableXRay :: Lens' AppMonitorConfiguration (Maybe Bool)
- appMonitorConfiguration_excludedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
- appMonitorConfiguration_favoritePages :: Lens' AppMonitorConfiguration (Maybe [Text])
- appMonitorConfiguration_guestRoleArn :: Lens' AppMonitorConfiguration (Maybe Text)
- appMonitorConfiguration_identityPoolId :: Lens' AppMonitorConfiguration (Maybe Text)
- appMonitorConfiguration_includedPages :: Lens' AppMonitorConfiguration (Maybe [Text])
- appMonitorConfiguration_sessionSampleRate :: Lens' AppMonitorConfiguration (Maybe Double)
- appMonitorConfiguration_telemetries :: Lens' AppMonitorConfiguration (Maybe [Telemetry])
Documentation
data AppMonitorConfiguration Source #
This structure contains much of the configuration data for the app monitor.
See: newAppMonitorConfiguration
smart constructor.
AppMonitorConfiguration' | |
|
Instances
newAppMonitorConfiguration :: AppMonitorConfiguration Source #
Create a value of AppMonitorConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowCookies:AppMonitorConfiguration'
, appMonitorConfiguration_allowCookies
- 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.
$sel:enableXRay:AppMonitorConfiguration'
, appMonitorConfiguration_enableXRay
- 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?
$sel:excludedPages:AppMonitorConfiguration'
, appMonitorConfiguration_excludedPages
- 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.
$sel:favoritePages:AppMonitorConfiguration'
, appMonitorConfiguration_favoritePages
- A list of pages in your application that are to be displayed with a
"favorite" icon in the CloudWatch RUM console.
$sel:guestRoleArn:AppMonitorConfiguration'
, appMonitorConfiguration_guestRoleArn
- 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.
$sel:identityPoolId:AppMonitorConfiguration'
, appMonitorConfiguration_identityPoolId
- The ID of the Amazon Cognito identity pool that is used to authorize the
sending of data to RUM.
$sel:includedPages:AppMonitorConfiguration'
, appMonitorConfiguration_includedPages
- 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.
$sel:sessionSampleRate:AppMonitorConfiguration'
, appMonitorConfiguration_sessionSampleRate
- 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.
$sel:telemetries:AppMonitorConfiguration'
, appMonitorConfiguration_telemetries
- 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.
appMonitorConfiguration_allowCookies :: Lens' AppMonitorConfiguration (Maybe Bool) Source #
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.
appMonitorConfiguration_enableXRay :: Lens' AppMonitorConfiguration (Maybe Bool) Source #
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?
appMonitorConfiguration_excludedPages :: Lens' AppMonitorConfiguration (Maybe [Text]) Source #
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.
appMonitorConfiguration_favoritePages :: Lens' AppMonitorConfiguration (Maybe [Text]) Source #
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
appMonitorConfiguration_guestRoleArn :: Lens' AppMonitorConfiguration (Maybe Text) Source #
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.
appMonitorConfiguration_identityPoolId :: Lens' AppMonitorConfiguration (Maybe Text) Source #
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
appMonitorConfiguration_includedPages :: Lens' AppMonitorConfiguration (Maybe [Text]) Source #
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.
appMonitorConfiguration_sessionSampleRate :: Lens' AppMonitorConfiguration (Maybe Double) Source #
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.
appMonitorConfiguration_telemetries :: Lens' AppMonitorConfiguration (Maybe [Telemetry]) Source #
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.