AppMonitorConfiguration - CloudWatch RUM

AppMonitorConfiguration

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

Contents

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.

Type: Boolean

Required: No

EnableXRay

If you set this to true, RUM enables AWS 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 AWS X-Ray?

Type: Boolean

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 1260.

Pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)

Required: No

FavoritePages

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

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.

Type: String

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*

Required: No

IdentityPoolId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+:[0-9a-f-]+

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 1260.

Pattern: https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)

Required: No

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.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1.

Required: No

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.

Type: Array of strings

Valid Values: errors | performance | http

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: