2022/11/17 - CloudWatch RUM - 3 updated api methods
Changes CloudWatch RUM now supports custom events. To use custom events, create an app monitor or update an app monitor with CustomEvent Status as ENABLED.
{'CustomEvents': {'Status': 'ENABLED | DISABLED'}}
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?
See also: AWS API Documentation
Request Syntax
client.create_app_monitor(
AppMonitorConfiguration={
'AllowCookies': True|False,
'EnableXRay': True|False,
'ExcludedPages': [
'string',
],
'FavoritePages': [
'string',
],
'GuestRoleArn': 'string',
'IdentityPoolId': 'string',
'IncludedPages': [
'string',
],
'SessionSampleRate': 123.0,
'Telemetries': [
'errors'|'performance'|'http',
]
},
CustomEvents={
'Status': 'ENABLED'|'DISABLED'
},
CwLogEnabled=True|False,
Domain='string',
Name='string',
Tags={
'string': 'string'
}
)
dict
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.
AllowCookies (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.
EnableXRay (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?
ExcludedPages (list) --
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.
(string) --
FavoritePages (list) --
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
(string) --
GuestRoleArn (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.
IdentityPoolId (string) --
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
IncludedPages (list) --
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.
(string) --
SessionSampleRate (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.
Telemetries (list) --
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.
(string) --
dict
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.
Status (string) --
Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
boolean
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.
string
[REQUIRED]
The top-level internet domain name for which your application has administrative authority.
string
[REQUIRED]
A name for the app monitor.
dict
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.
(string) --
(string) --
dict
Response Syntax
{
'Id': 'string'
}
Response Structure
(dict) --
Id (string) --
The unique ID of the new app monitor.
{'AppMonitor': {'CustomEvents': {'Status': 'ENABLED | DISABLED'}}}
Retrieves the complete configuration information for one app monitor.
See also: AWS API Documentation
Request Syntax
client.get_app_monitor(
Name='string'
)
string
[REQUIRED]
The app monitor to retrieve information for.
dict
Response Syntax
{
'AppMonitor': {
'AppMonitorConfiguration': {
'AllowCookies': True|False,
'EnableXRay': True|False,
'ExcludedPages': [
'string',
],
'FavoritePages': [
'string',
],
'GuestRoleArn': 'string',
'IdentityPoolId': 'string',
'IncludedPages': [
'string',
],
'SessionSampleRate': 123.0,
'Telemetries': [
'errors'|'performance'|'http',
]
},
'Created': 'string',
'CustomEvents': {
'Status': 'ENABLED'|'DISABLED'
},
'DataStorage': {
'CwLog': {
'CwLogEnabled': True|False,
'CwLogGroup': 'string'
}
},
'Domain': 'string',
'Id': 'string',
'LastModified': 'string',
'Name': 'string',
'State': 'CREATED'|'DELETING'|'ACTIVE',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
AppMonitor (dict) --
A structure containing all the configuration information for the app monitor.
AppMonitorConfiguration (dict) --
A structure that contains much of the configuration data for the app monitor.
AllowCookies (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.
EnableXRay (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?
ExcludedPages (list) --
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.
(string) --
FavoritePages (list) --
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
(string) --
GuestRoleArn (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.
IdentityPoolId (string) --
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
IncludedPages (list) --
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.
(string) --
SessionSampleRate (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.
Telemetries (list) --
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.
(string) --
Created (string) --
The date and time that this app monitor was created.
CustomEvents (dict) --
Specifies whether this app monitor allows the web client to define and send custom events.
For more information about custom events, see Send custom events.
Status (string) --
Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
DataStorage (dict) --
A structure that contains information about whether this app monitor stores a copy of the telemetry data that RUM collects using CloudWatch Logs.
CwLog (dict) --
A structure that contains the information about whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs. If it does, this structure also contains the name of the log group.
CwLogEnabled (boolean) --
Indicated whether the app monitor stores copies of the data that RUM collects in CloudWatch Logs.
CwLogGroup (string) --
The name of the log group where the copies are stored.
Domain (string) --
The top-level internet domain name for which your application has administrative authority.
Id (string) --
The unique ID of this app monitor.
LastModified (string) --
The date and time of the most recent changes to this app monitor's configuration.
Name (string) --
The name of the app monitor.
State (string) --
The current state of the app monitor.
Tags (dict) --
The list of tag keys and values associated with this app monitor.
(string) --
(string) --
{'CustomEvents': {'Status': 'ENABLED | DISABLED'}}
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?
See also: AWS API Documentation
Request Syntax
client.update_app_monitor(
AppMonitorConfiguration={
'AllowCookies': True|False,
'EnableXRay': True|False,
'ExcludedPages': [
'string',
],
'FavoritePages': [
'string',
],
'GuestRoleArn': 'string',
'IdentityPoolId': 'string',
'IncludedPages': [
'string',
],
'SessionSampleRate': 123.0,
'Telemetries': [
'errors'|'performance'|'http',
]
},
CustomEvents={
'Status': 'ENABLED'|'DISABLED'
},
CwLogEnabled=True|False,
Domain='string',
Name='string'
)
dict
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.
AllowCookies (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.
EnableXRay (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?
ExcludedPages (list) --
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.
(string) --
FavoritePages (list) --
A list of pages in your application that are to be displayed with a "favorite" icon in the CloudWatch RUM console.
(string) --
GuestRoleArn (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.
IdentityPoolId (string) --
The ID of the Amazon Cognito identity pool that is used to authorize the sending of data to RUM.
IncludedPages (list) --
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.
(string) --
SessionSampleRate (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.
Telemetries (list) --
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.
(string) --
dict
Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
For more information about custom events, see Send custom events.
Status (string) --
Specifies whether this app monitor allows the web client to define and send custom events. The default is for custom events to be DISABLED.
boolean
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.
string
The top-level internet domain name for which your application has administrative authority.
string
[REQUIRED]
The name of the app monitor to update.
dict
Response Syntax
{}
Response Structure
(dict) --