Class: AWS.RUM
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.RUM
- Identifier:
- rum
- API Version:
- 2018-05-10
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service 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.
<p>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.</p>
Sending a Request Using RUM
var rum = new AWS.RUM();
rum.createAppMonitor(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the RUM object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var rum = new AWS.RUM({apiVersion: '2018-05-10'});
You can also set the API version globally in AWS.config.apiVersions
using
the rum service identifier:
AWS.config.apiVersions = {
rum: '2018-05-10',
// other service API versions
};
var rum = new AWS.RUM();
Constructor Summary collapse
-
new AWS.RUM(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createAppMonitor(params = {}, callback) ⇒ AWS.Request
Creates a Amazon CloudWatch RUM app monitor, which collects telemetry data from your application and sends that data to RUM.
-
deleteAppMonitor(params = {}, callback) ⇒ AWS.Request
Deletes an existing app monitor.
-
getAppMonitor(params = {}, callback) ⇒ AWS.Request
Retrieves the complete configuration information for one app monitor.
.
-
getAppMonitorData(params = {}, callback) ⇒ AWS.Request
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.
.
-
listAppMonitors(params = {}, callback) ⇒ AWS.Request
Returns a list of the Amazon CloudWatch RUM app monitors in the account.
.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Displays the tags associated with a CloudWatch RUM resource.
.
-
putRumEvents(params = {}, callback) ⇒ AWS.Request
Sends telemetry events about your application performance and user behavior to CloudWatch RUM.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes one or more tags from the specified resource.
.
-
updateAppMonitor(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing app monitor.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.RUM(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
createAppMonitor(params = {}, callback) ⇒ AWS.Request
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 UpdateAppMonitor 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?
deleteAppMonitor(params = {}, callback) ⇒ AWS.Request
Deletes an existing app monitor. This immediately stops the collection of data.
getAppMonitor(params = {}, callback) ⇒ AWS.Request
Retrieves the complete configuration information for one app monitor.
getAppMonitorData(params = {}, callback) ⇒ AWS.Request
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.
listAppMonitors(params = {}, callback) ⇒ AWS.Request
Returns a list of the Amazon CloudWatch RUM app monitors in the account.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Displays the tags associated with a CloudWatch RUM resource.
putRumEvents(params = {}, callback) ⇒ AWS.Request
Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents
operations to send this data to RUM.
Each PutRumEvents
operation can send a batch of events from one user session.
tagResource(params = {}, callback) ⇒ AWS.Request
Assigns one or more tags (key-value pairs) to the specified CloudWatch RUM resource. Currently, the only resources that can be tagged app monitors.
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 use the TagResource
action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource.
For more information, see Tagging Amazon Web Services resources.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes one or more tags from the specified resource.
updateAppMonitor(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an existing app monitor. When you use this operation, only the parts of the app monitor configuration that you specify in this operation are changed. For any parameters that you omit, the existing values are kept.
You can't use this operation to change the tags of an existing app monitor. To change the tags of an existing app monitor, use TagResource.
To create a new app monitor, use CreateAppMonitor.
After you update an app monitor, sign in to the CloudWatch RUM console to get the updated 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?