AWS AmazonCloudWatch documentation change
Summary
Updated documentation for creating CloudWatch RUM app monitors with clearer step-by-step instructions, specifically focused on web applications. Changes include reorganized steps, updated terminology ('web client' to 'client'), and improved navigation.
Security assessment
The changes are editorial improvements and reorganization of existing content. No security vulnerabilities or weaknesses are addressed. The security-related steps (cookies, resource policies) remain unchanged except for step numbering.
Diff
diff --git a/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-create-app-monitor.md b/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-create-app-monitor.md index ff6afeedd..b8cb72b9c 100644 --- a//AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-create-app-monitor.md +++ b//AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-create-app-monitor.md @@ -5 +5 @@ -# Creating a CloudWatch RUM app monitor +To create an app monitor for a web platform @@ -7 +7 @@ -To start using CloudWatch RUM with your application, you create an _app monitor_. When the app monitor is created, RUM generates a JavaScript snippet for you to paste into your application. The snippet pulls in the RUM web client code. The RUM web client captures data from a percentage of your application's user sessions and sends it to RUM. +# Creating a CloudWatch RUM app monitor for a web application @@ -9 +9,3 @@ To start using CloudWatch RUM with your application, you create an _app monitor_ -###### To create an app monitor +To start using CloudWatch RUM with your application, you create an _app monitor_. When the app monitor is created, RUM generates a code snippet for you to paste into your application. The snippet pulls in the RUM client code. The RUM client captures data from your application's user sessions and sends it to RUM. + +## To create an app monitor for a web platform @@ -17 +19 @@ To start using CloudWatch RUM with your application, you create an _app monitor_ - 4. Enter the information and settings for your application: + 4. For **App monitor name** , enter a name to be used to identify this app monitor within the CloudWatch RUM console. @@ -19 +21 @@ To start using CloudWatch RUM with your application, you create an _app monitor_ - * For **App monitor name** , enter a name to be used to identify this app monitor within the CloudWatch RUM console. + 5. Select **Web** as the platform. @@ -21 +23 @@ To start using CloudWatch RUM with your application, you create an _app monitor_ - * For **Application domain list** , enter the registered domain names where your application has administrative authority. You can also use a wildcard character `*` to allow any sub-domain or top-level domains (for example, *.amazon.com, amazon.*, *.amazon.*). + 6. For **Application domain list** , enter the registered domain names where your application has administrative authority. You can also use a wildcard character `*` to allow any sub-domain or top-level domains (for example, *.amazon.com, amazon.*, *.amazon.*). @@ -23 +25 @@ To start using CloudWatch RUM with your application, you create an _app monitor_ - 5. For **Configure RUM data collection** , specify whether you want the app monitor to collect each of the following: + 7. For **Configure RUM data collection** , specify whether you want the app monitor to collect each of the following: @@ -37 +39 @@ If you don't select any of these, the app monitor still collects session start e - 6. Select **Check this option to allow the CloudWatch RUM Web Client to set cookies** if you want to be able to collect user IDs and session IDs from sampled user sessions. The user IDs are randomly generated by RUM. For more information, see [CloudWatch RUM web client cookies (or similar technologies)](./CloudWatch-RUM-privacy.html#CloudWatch-RUM-cookies). + 8. Select **Check this option to allow the CloudWatch RUM Web Client to set cookies** if you want to be able to collect user IDs and session IDs from sampled user sessions. The user IDs are randomly generated by RUM. For more information, see [CloudWatch RUM web client cookies (or similar technologies)](./CloudWatch-RUM-privacy.html#CloudWatch-RUM-cookies). @@ -39 +41 @@ If you don't select any of these, the app monitor still collects session start e - 7. For **Session samples** , enter the percentage of user sessions that will be used to gather RUM data. The default is 100%. Reducing this number gives you less data, but reduces your charges. For more information about RUM pricing, see [RUM pricing](./CloudWatch-RUM.html#RUMpricing). + 9. For **Session samples** , enter the percentage of user sessions that will be used to gather RUM data. The default is 100%. Reducing this number gives you less data, but reduces your charges. For more information about RUM pricing, see [RUM pricing](./CloudWatch-RUM.html#RUMpricing). @@ -41 +43 @@ If you don't select any of these, the app monitor still collects session start e - 8. End user data that you collect for CloudWatch RUM is retained for 30 days and then deleted. If you want to keep copies of RUM events in CloudWatch Logs and configure how long to retain these copies, choose **Check this option to store your application telemetry data in your CloudWatch Logs account** under **Data storage**. By default, the CloudWatch Logs log group retains the data for 30 days. You can adjust the retention period in the CloudWatch Logs console. + 10. End user data that you collect for CloudWatch RUM is retained for 30 days and then deleted. If you want to keep copies of RUM events in CloudWatch Logs and configure how long to retain these copies, choose **Check this option to store your application telemetry data in your CloudWatch Logs account** under **Data storage**. By default, the CloudWatch Logs log group retains the data for 30 days. You can adjust the retention period in the CloudWatch Logs console. @@ -43 +45 @@ If you don't select any of these, the app monitor still collects session start e - 9. (Optional) Choose to add a resource-based policy to your app monitor to control who can send `PutRumEvents` requests to your app monitor. If you choose **Create public policy** , a resource policy will be attached to your app monitor that enables anyone to send `PutRumEvents` requests to your app monitor. For more information about this method, see [Using resource-based policies with CloudWatch RUM](./CloudWatch-RUM-resource-policies.html). + 11. (Optional) Choose to add a resource-based policy to your app monitor to control who can send `PutRumEvents` requests to your app monitor. If you choose **Create public policy** , a resource policy will be attached to your app monitor that enables anyone to send `PutRumEvents` requests to your app monitor. For more information about this method, see [Using resource-based policies with CloudWatch RUM](./CloudWatch-RUM-resource-policies.html). @@ -45 +47 @@ If you don't select any of these, the app monitor still collects session start e - 10. If you attached a resource-based policy in step 9, then you don't need to sign requests to CloudWatch RUM with AWS credentials, and you can skip setting up authorization. Otherwise, for **Authorization** , specify whether to use a new or existing Amazon Cognito identity pool or use a different identity provider. Creating a new identity pool is the simplest option that requires no other setup steps. For more information, see see [Step 1: Authorize your application to send data to AWS](./CloudWatch-RUM-get-started-authorization.html). + 12. If you attached a resource-based policy in the previous step, then you don't need to sign requests to CloudWatch RUM with AWS credentials, and you can skip setting up authorization. Otherwise, for **Authorization** , specify whether to use a new or existing Amazon Cognito identity pool or use a different identity provider. Creating a new identity pool is the simplest option that requires no other setup steps. For more information, see see [Authorize your web application to send data to AWS](./CloudWatch-RUM-get-started-authorization.html). @@ -49 +51 @@ Creating a new Amazon Cognito identity pool requires administrative permissions. - 11. (Optional) By default, when you add the RUM code snippet to your application, the web client injects the JavaScript tag to monitor usage into the HTML code of all pages of your application. To change this, choose **Configure pages** and then choose either **Include only these pages** or **Exclude these pages**. Then, specify the pages to include or exclude. To specify a page to include or exclude, enter its complete URLs. To specify additional pages, choose **Add URL**. + 13. (Optional) By default, when you add the RUM code snippet to your application, the web client injects the JavaScript tag to monitor usage into the HTML code of all pages of your application. To change this, choose **Configure pages** and then choose either **Include only these pages** or **Exclude these pages**. Then, specify the pages to include or exclude. To specify a page to include or exclude, enter its complete URLs. To specify additional pages, choose **Add URL**. @@ -51 +53 @@ Creating a new Amazon Cognito identity pool requires administrative permissions. - 12. To enable AWS X-Ray tracing of the user sessions that are sampled by the app monitor, choose **Active tracing** and select **Trace my service with AWS X-Ray.** + 14. To enable AWS X-Ray tracing of the user sessions that are sampled by the app monitor, choose **Active tracing** and select **Trace my service with AWS X-Ray.** @@ -57 +59 @@ By making additional configuration changes to the CloudWatch RUM web client, you - 13. (Optional) To add tags to the app monitor, choose **Tags** , **Add new tag**. + 15. (Optional) To add tags to the app monitor, choose **Tags** , **Add new tag**. @@ -65 +67 @@ For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/ge - 14. Choose **Add app monitor**. + 16. Choose **Add app monitor**. @@ -67 +69 @@ For more information, see [Tagging AWS Resources](https://docs.aws.amazon.com/ge - 15. In the **Sample code** section, you can copy the code snippet to use to add to your application. We recommend that you choose **JavaScript** or **TypeScript** and use NPM to install the CloudWatch RUM web client as a JavaScript module. + 17. In the **Sample code** section, you can copy the code snippet to use to add to your application. We recommend that you choose **JavaScript** or **TypeScript** and use NPM to install the CloudWatch RUM web client as a JavaScript module. @@ -71 +73 @@ Alternatively, you can choose **HTML** to use a content delivery network (CDN) t - 16. Choose **Copy** or **Download** , and then choose **Done**. + 18. Choose **Copy** or **Download** , and then choose **Done**. @@ -82 +84 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Step 1: Authorize your application to send data to AWS +Authorize your web application to send data to AWS