Client

cloudwatchrum

R Documentation

CloudWatch RUM¶

Description¶

With Amazon CloudWatch RUM, you can perform real-user monitoring to collect client-side data about your web application performance from actual user sessions in real time. The data collected includes page load times, client-side errors, and user behavior. When you view this data, you can see it all aggregated together and also see breakdowns by the browsers and devices that your customers use.

You can use the collected data to quickly identify and debug client-side performance issues. CloudWatch RUM helps you visualize anomalies in your application performance and find relevant debugging data such as error messages, stack traces, and user sessions. You can also use RUM to understand the range of end-user impact including the number of users, geolocations, and browsers used.

Usage¶

cloudwatchrum(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- cloudwatchrum(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

batch_create_rum_metric_definitions: Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination
batch_delete_rum_metric_definitions: Removes the specified metrics from being sent to an extended metrics destination
batch_get_rum_metric_definitions: Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination
create_app_monitor: Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM
delete_app_monitor: Deletes an existing app monitor
delete_rum_metrics_destination: Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination
get_app_monitor: Retrieves the complete configuration information for one app monitor
get_app_monitor_data: Retrieves the raw performance events that RUM has collected from your web application, so that you can do your own processing or analysis of this data
list_app_monitors: Returns a list of the Amazon CloudWatch RUM app monitors in the account
list_rum_metrics_destinations: Returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor
list_tags_for_resource: Displays the tags associated with a CloudWatch RUM resource
put_rum_events: Sends telemetry events about your application performance and user behavior to CloudWatch RUM
put_rum_metrics_destination: Creates or updates a destination to receive extended metrics from CloudWatch RUM
tag_resource: Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource
untag_resource: Removes one or more tags from the specified resource
update_app_monitor: Updates the configuration of an existing app monitor
update_rum_metric_definition: Modifies one existing metric definition for CloudWatch RUM extended metrics

Examples¶

## Not run: 
svc <- cloudwatchrum()
svc$batch_create_rum_metric_definitions(
  Foo = 123
)

## End(Not run)