Class: Aws::CloudWatchRUM::Types::AppMonitorConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchRUM::Types::AppMonitorConfiguration

Defined in:

gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allow_cookies ⇒ Boolean

  If you set this to true, the RUM web client sets two cookies, a session cookie and a user cookie.

• #enable_x_ray ⇒ Boolean

  If you set this to true, RUM enables X-Ray tracing for the user sessions that RUM samples.

• #excluded_pages ⇒ Array<String>

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

• #favorite_pages ⇒ Array<String>

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

• #guest_role_arn ⇒ 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.

• #identity_pool_id ⇒ String

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

• #included_pages ⇒ Array<String>

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

• #session_sample_rate ⇒ Float

  Specifies the portion of user sessions to use for RUM data collection.

• #telemetries ⇒ Array<String>

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

Instance Attribute Details

#allow_cookies ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#enable_x_ray ⇒ Boolean

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?

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#excluded_pages ⇒ Array<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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#favorite_pages ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#guest_role_arn ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#included_pages ⇒ Array<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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#session_sample_rate ⇒ Float

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.

Returns:

• (Float)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end

#telemetries ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 209

class AppMonitorConfiguration < Struct.new(
  :allow_cookies,
  :enable_x_ray,
  :excluded_pages,
  :favorite_pages,
  :guest_role_arn,
  :identity_pool_id,
  :included_pages,
  :session_sample_rate,
  :telemetries)
  SENSITIVE = []
  include Aws::Structure
end