Skip to content

Create App Monitor

cloudwatchrum_create_app_monitor R Documentation

Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM

Description

Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM. The data includes performance and reliability information such as page load time, client-side errors, and user behavior.

You use this operation only to create a new app monitor. To update an existing app monitor, use update_app_monitor instead.

After you create an app monitor, sign in to the CloudWatch RUM console to get the JavaScript code snippet to add to your web application. For more information, see How do I find a code snippet that I've already generated?

Usage

cloudwatchrum_create_app_monitor(AppMonitorConfiguration, CustomEvents,
  CwLogEnabled, Domain, Name, Tags)

Arguments

AppMonitorConfiguration

A structure that contains much of the configuration data for the app monitor. If you are using Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the Amazon Cognito identity pool to use for authorization. If you don't include AppMonitorConfiguration, you must set up your own authorization method. For more information, see Authorize your application to send data to Amazon Web Services.

If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.

CustomEvents

Specifies whether this app monitor allows the web client to define and send custom events. If you omit this parameter, custom events are DISABLED.

For more information about custom events, see Send custom events.

CwLogEnabled

Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges.

If you omit this parameter, the default is false.

Domain

[required] The top-level internet domain name for which your application has administrative authority.

Name

[required] A name for the app monitor.

Tags

Assigns one or more tags (key-value pairs) to the app monitor.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can associate as many as 50 tags with an app monitor.

For more information, see Tagging Amazon Web Services resources.

Value

A list with the following syntax: 

list(
  Id = "string"
)

Request syntax

svc$create_app_monitor(
  AppMonitorConfiguration = list(
    AllowCookies = TRUE|FALSE,
    EnableXRay = TRUE|FALSE,
    ExcludedPages = list(
      "string"
    ),
    FavoritePages = list(
      "string"
    ),
    GuestRoleArn = "string",
    IdentityPoolId = "string",
    IncludedPages = list(
      "string"
    ),
    SessionSampleRate = 123.0,
    Telemetries = list(
      "errors"|"performance"|"http"
    )
  ),
  CustomEvents = list(
    Status = "ENABLED"|"DISABLED"
  ),
  CwLogEnabled = TRUE|FALSE,
  Domain = "string",
  Name = "string",
  Tags = list(
    "string"
  )
)