Skip to content

Commit f281e0d

Browse files
author
awstools
committed
docs(client-rum): Doc-only update for new RUM metrics that were added
1 parent 93fdd39 commit f281e0d

File tree

3 files changed

+84
-40
lines changed

3 files changed

+84
-40
lines changed

‎clients/client-rum/src/commands/BatchCreateRumMetricDefinitionsCommand.ts‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,23 @@ export interface BatchCreateRumMetricDefinitionsCommandOutput
3838
* <p>By default, RUM app monitors send some metrics to CloudWatch. These default metrics
3939
* are listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html">CloudWatch metrics that you can collect
4040
* with CloudWatch RUM</a>.</p>
41-
* <p>In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.</p>
41+
* <p>In addition to these default metrics, you can choose to send extended metrics, custom
42+
* metrics, or both.</p>
4243
* <ul>
4344
* <li>
44-
* <p>Extended metrics enable you to send metrics with additional dimensions not included
45-
* in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch.
46-
* The valid dimension names for the additional dimensions for extended metrics are
47-
* <code>BrowserName</code>, <code>CountryCode</code>, <code>DeviceType</code>,
48-
* <code>FileType</code>, <code>OSName</code>, and <code>PageId</code>. For more information, see
49-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
50-
* Extended metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
45+
* <p>Extended metrics let you send metrics with additional dimensions that aren't included in the
46+
* default metrics. You can also send extended metrics to both Evidently and CloudWatch. The valid dimension names for the additional dimensions for extended
47+
* metrics are <code>BrowserName</code>, <code>CountryCode</code>,
48+
* <code>DeviceType</code>, <code>FileType</code>, <code>OSName</code>, and
49+
* <code>PageId</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
50+
* Extended metrics that you can send to CloudWatch and CloudWatch
51+
* Evidently</a>.</p>
5152
* </li>
5253
* <li>
53-
* <p>Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or
54-
* to CloudWatch Evidently or to both. With custom metrics,
55-
* you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events,
56-
* custom attributes, or default attributes. </p>
54+
* <p>Custom metrics are metrics that you define. You can send custom metrics to CloudWatch.
55+
* CloudWatch Evidently, or both. With custom metrics, you can use any metric
56+
* name and namespace. To derive the metrics, you can use any custom events, built-in
57+
* events, custom attributes, or default attributes. </p>
5758
* <p>You can't send custom metrics to the <code>AWS/RUM</code> namespace. You must send custom metrics to a
5859
* custom namespace that you define. The namespace that you use can't start with <code>AWS/</code>.
5960
* CloudWatch RUM prepends <code>RUM/CustomMetrics/</code> to the custom namespace that you define,

‎clients/client-rum/src/models/models_0.ts‎

Lines changed: 62 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,25 @@ export interface AppMonitorConfiguration {
9797
* @public
9898
* <p>The ARN of the guest IAM role that is attached to the Amazon Cognito identity pool
9999
* that is used to authorize the sending of data to RUM.</p>
100+
* <note>
101+
* <p>It is possible that an app monitor does not have a value for <code>GuestRoleArn</code>. For example,
102+
* this can happen when you use the console to create an app monitor and you allow CloudWatch RUM to
103+
* create a new identity pool for Authorization. In this case, <code>GuestRoleArn</code> is not present in the
104+
* <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_GetAppMonitor.html">GetAppMonitor</a>
105+
* response because it is not stored by the service.</p>
106+
* <p>If this issue affects you, you can take one of the following steps:</p>
107+
* <ul>
108+
* <li>
109+
* <p>Use the Cloud Development Kit (CDK) to create an identity pool and the associated IAM
110+
* role, and use that for your app monitor.</p>
111+
* </li>
112+
* <li>
113+
* <p>Make a separate <a href="https://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetIdentityPoolRoles.html">GetIdentityPoolRoles</a>
114+
* call to Amazon Cognito to retrieve
115+
* the <code>GuestRoleArn</code>.</p>
116+
* </li>
117+
* </ul>
118+
* </note>
100119
*/
101120
GuestRoleArn?: string;
102121

@@ -333,18 +352,19 @@ export type MetricDestination = (typeof MetricDestination)[keyof typeof MetricDe
333352
* @public
334353
* <p>Use this structure to define one extended metric or custom metric that RUM will send
335354
* to CloudWatch or CloudWatch Evidently. For more information, see
336-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
337-
* Additional metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
355+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-custom-and-extended-metrics.html">
356+
* Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
338357
* <p>This structure is validated differently for extended metrics and custom metrics. For extended metrics
339358
* that are sent to the <code>AWS/RUM</code> namespace, the following validations apply:</p>
340359
* <ul>
341360
* <li>
342361
* <p>The <code>Namespace</code> parameter must be omitted or set to <code>AWS/RUM</code>.</p>
343362
* </li>
344363
* <li>
345-
* <p>Only certain combinations of values for <code>Name</code>, <code>ValueKey</code>, and <code>EventPattern</code>
346-
* are valid. In addition to what is displayed in the list below, the <code>EventPattern</code> can also include information
347-
* used by the <code>DimensionKeys</code> field.</p>
364+
* <p>Only certain combinations of values for <code>Name</code>, <code>ValueKey</code>, and
365+
* <code>EventPattern</code> are valid. In addition to what is displayed in the
366+
* following list, the <code>EventPattern</code> can also include information used by
367+
* the <code>DimensionKeys</code> field.</p>
348368
* <ul>
349369
* <li>
350370
* <p>If <code>Name</code> is <code>PerformanceNavigationDuration</code>, then
@@ -433,6 +453,24 @@ export type MetricDestination = (typeof MetricDestination)[keyof typeof MetricDe
433453
* must include <code>\{"event_type":["com.amazon.rum.session_start_event"]\}</code>
434454
* </p>
435455
* </li>
456+
* <li>
457+
* <p>If <code>Name</code> is <code>PageViewCount</code>, then
458+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
459+
* must include <code>\{"event_type":["com.amazon.rum.page_view_event"]\}</code>
460+
* </p>
461+
* </li>
462+
* <li>
463+
* <p>If <code>Name</code> is <code>Http4xxCount</code>, then
464+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
465+
* must include <code>\{"event_type": ["com.amazon.rum.http_event"],"event_details":\{"response":\{"status":[\{"numeric":["&gt;=",400,"&lt;",500]\}]\}\}\} \}</code>
466+
* </p>
467+
* </li>
468+
* <li>
469+
* <p>If <code>Name</code> is <code>Http5xxCount</code>, then
470+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
471+
* must include <code>\{"event_type": ["com.amazon.rum.http_event"],"event_details":\{"response":\{"status":[\{"numeric":["&gt;=",500,"&lt;=",599]\}]\}\}\} \}</code>
472+
* </p>
473+
* </li>
436474
* </ul>
437475
* </li>
438476
* </ul>
@@ -623,10 +661,10 @@ export interface MetricDefinitionRequest {
623661
/**
624662
* @public
625663
* <p>The field within the event object that the metric value is sourced from.</p>
626-
* <p>If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you
627-
* just want to count the number of events that the filter catches. </p>
628-
* <p>If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw and Evidently
629-
* will handle data extraction from the event.</p>
664+
* <p>If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is
665+
* useful if you want to count the number of events that the filter catches. </p>
666+
* <p>If this metric is sent to CloudWatch Evidently, this field will be passed to
667+
* Evidently raw. Evidently will handle data extraction from the event.</p>
630668
*/
631669
ValueKey?: string;
632670

@@ -728,9 +766,8 @@ export interface MetricDefinitionRequest {
728766
* </p>
729767
* </li>
730768
* </ul>
731-
* <p>If the metrics destination'
732-
* is <code>CloudWatch</code> and the event
733-
* also matches a value in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
769+
* <p>If the metrics destination is <code>CloudWatch</code> and the event also matches a value
770+
* in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
734771
*/
735772
EventPattern?: string;
736773

@@ -755,10 +792,11 @@ export interface BatchCreateRumMetricDefinitionsRequest {
755792

756793
/**
757794
* @public
758-
* <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and <code>Evidently</code>. If
759-
* you specify <code>Evidently</code>, you must also specify the ARN of the CloudWatchEvidently experiment
760-
* that will receive
761-
* the metrics and an IAM role that has permission to write to the experiment.</p>
795+
* <p>The destination to send the metrics to. Valid values are <code>CloudWatch</code> and
796+
* <code>Evidently</code>. If you specify <code>Evidently</code>, you must also specify the
797+
* Amazon Resource Name (ARN) of the CloudWatchEvidently experiment that will receive
798+
* the metrics and an IAM role that has permission to write to the
799+
* experiment.</p>
762800
*/
763801
Destination: MetricDestination | undefined;
764802

@@ -1233,7 +1271,7 @@ export interface CreateAppMonitorRequest {
12331271
* Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
12341272
* Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
12351273
* authorization method. For more information, see
1236-
* <a href="https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
1274+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
12371275
* to send data to Amazon Web Services</a>.</p>
12381276
* <p>If you omit this argument, the sample rate used for RUM is set to 10% of the user sessions.</p>
12391277
*/
@@ -1617,10 +1655,15 @@ export interface PutRumMetricsDestinationRequest {
16171655
/**
16181656
* @public
16191657
* <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is
1620-
* <code>CloudWatch</code>, do not use this parameter.</p>
1658+
* <code>CloudWatch</code>, don't use this parameter.</p>
16211659
* <p>This parameter specifies
16221660
* the ARN of an IAM role that RUM will assume to write to the Evidently
16231661
* experiment that you are sending metrics to. This role must have permission to write to that experiment.</p>
1662+
* <p>If you specify this parameter, you must be signed on to a role that has <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html">PassRole</a> permissions attached to it, to allow
1663+
* the role to be passed. The <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/auth-and-access-control-cw.html#managed-policies-cloudwatch-RUM">
1664+
* CloudWatchAmazonCloudWatchRUMFullAccess</a>
1665+
* policy doesn't include <code>PassRole</code>
1666+
* permissions.</p>
16241667
*/
16251668
IamRoleArn?: string;
16261669
}
@@ -1652,7 +1695,7 @@ export interface UpdateAppMonitorRequest {
16521695
* Amazon Cognito for authorization, you must include this structure in your request, and it must include the ID of the
16531696
* Amazon Cognito identity pool to use for authorization. If you don't include <code>AppMonitorConfiguration</code>, you must set up your own
16541697
* authorization method. For more information, see
1655-
* <a href="https://docs.aws.amazon.com/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
1698+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-get-started-authorization.html">Authorize your application
16561699
* to send data to Amazon Web Services</a>.</p>
16571700
*/
16581701
AppMonitorConfiguration?: AppMonitorConfiguration;

0 commit comments

Comments
 (0)