class Aws::CloudWatchRUM::Types::AppMonitorConfiguration

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

@note When making an API call, you may pass AppMonitorConfiguration

data as a hash:

    {
      allow_cookies: false,
      enable_x_ray: false,
      excluded_pages: ["Url"],
      favorite_pages: ["String"],
      guest_role_arn: "Arn",
      identity_pool_id: "IdentityPoolId",
      included_pages: ["Url"],
      session_sample_rate: 1.0,
      telemetries: ["errors"], # accepts errors, performance, http
    }

@!attribute [rw] allow_cookies

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.
@return [Boolean]

@!attribute [rw] enable_x_ray

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?][1]

[1]: https://docs.aws.amazon.com/xray/latest/devguide/aws-xray.html
@return [Boolean]

@!attribute [rw] excluded_pages

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.
@return [Array<String>]

@!attribute [rw] favorite_pages

A list of pages in the CloudWatch RUM console that are to be
displayed with a "favorite" icon.
@return [Array<String>]

@!attribute [rw] guest_role_arn

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.
@return [String]

@!attribute [rw] identity_pool_id

The ID of the Amazon Cognito identity pool that is used to authorize
the sending of data to RUM.
@return [String]

@!attribute [rw] included_pages

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

     <p>You can't include both <code>ExcludedPages</code> and <code>IncludedPages</code> in the same operation.</p>
@return [Array<String>]

@!attribute [rw] session_sample_rate

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

The number you specify is the percentage of user sessions that will
be used.

If you omit this parameter, the default of 10 is used.
@return [Float]

@!attribute [rw] 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.
@return [Array<String>]

@see docs.aws.amazon.com/goto/WebAPI/rum-2018-05-10/AppMonitorConfiguration AWS API Documentation

Constants

SENSITIVE