AppMonitorConfiguration

import type { AppMonitorConfiguration } from "https://aws-api.deno.dev/v0.3/services/rum.ts?docs=full";

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

interface AppMonitorConfiguration {

AllowCookies?: boolean | null;

EnableXRay?: boolean | null;

ExcludedPages?: string[] | null;

FavoritePages?: string[] | null;

GuestRoleArn?: string | null;

IdentityPoolId?: string | null;

IncludedPages?: string[] | null;

SessionSampleRate?: number | null;

Telemetries?: Telemetry[] | null;

}

§Properties

AllowCookies?: boolean | null

[src]

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.

EnableXRay?: boolean | null

[src]

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?

ExcludedPages?: string[] | null

[src]

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.

FavoritePages?: string[] | null

[src]

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

GuestRoleArn?: string | null

[src]

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.

IdentityPoolId?: string | null

[src]

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

IncludedPages?: string[] | null

[src]

TODO: Failed to render documentation: unhandled top level doc tag pre

SessionSampleRate?: number | null

[src]

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.

Telemetries?: Telemetry[] | null

[src]

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.