@aws-sdk/client-rum 3.272.0 → 3.277.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/protocols/Aws_restJson1.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/protocols/Aws_restJson1.js +3 -0
- package/dist-types/RUM.d.ts +23 -6
- package/dist-types/commands/BatchCreateRumMetricDefinitionsCommand.d.ts +22 -5
- package/dist-types/commands/PutRumMetricsDestinationCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +198 -59
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +2 -2
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rum-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rum-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rum.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://rum.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1363,6 +1363,7 @@ const serializeAws_restJson1MetricDefinitionRequest = (input, context) => {
|
|
|
1363
1363
|
}),
|
|
1364
1364
|
...(input.EventPattern != null && { EventPattern: input.EventPattern }),
|
|
1365
1365
|
...(input.Name != null && { Name: input.Name }),
|
|
1366
|
+
...(input.Namespace != null && { Namespace: input.Namespace }),
|
|
1366
1367
|
...(input.UnitLabel != null && { UnitLabel: input.UnitLabel }),
|
|
1367
1368
|
...(input.ValueKey != null && { ValueKey: input.ValueKey }),
|
|
1368
1369
|
};
|
|
@@ -1587,6 +1588,7 @@ const deserializeAws_restJson1MetricDefinition = (output, context) => {
|
|
|
1587
1588
|
EventPattern: (0, smithy_client_1.expectString)(output.EventPattern),
|
|
1588
1589
|
MetricDefinitionId: (0, smithy_client_1.expectString)(output.MetricDefinitionId),
|
|
1589
1590
|
Name: (0, smithy_client_1.expectString)(output.Name),
|
|
1591
|
+
Namespace: (0, smithy_client_1.expectString)(output.Namespace),
|
|
1590
1592
|
UnitLabel: (0, smithy_client_1.expectString)(output.UnitLabel),
|
|
1591
1593
|
ValueKey: (0, smithy_client_1.expectString)(output.ValueKey),
|
|
1592
1594
|
};
|
|
@@ -1609,6 +1611,7 @@ const deserializeAws_restJson1MetricDefinitionRequest = (output, context) => {
|
|
|
1609
1611
|
: undefined,
|
|
1610
1612
|
EventPattern: (0, smithy_client_1.expectString)(output.EventPattern),
|
|
1611
1613
|
Name: (0, smithy_client_1.expectString)(output.Name),
|
|
1614
|
+
Namespace: (0, smithy_client_1.expectString)(output.Namespace),
|
|
1612
1615
|
UnitLabel: (0, smithy_client_1.expectString)(output.UnitLabel),
|
|
1613
1616
|
ValueKey: (0, smithy_client_1.expectString)(output.ValueKey),
|
|
1614
1617
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const q = "required", r = "fn", s = "argv", t = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rum-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rum-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rum.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://rum.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -1326,6 +1326,7 @@ const serializeAws_restJson1MetricDefinitionRequest = (input, context) => {
|
|
|
1326
1326
|
}),
|
|
1327
1327
|
...(input.EventPattern != null && { EventPattern: input.EventPattern }),
|
|
1328
1328
|
...(input.Name != null && { Name: input.Name }),
|
|
1329
|
+
...(input.Namespace != null && { Namespace: input.Namespace }),
|
|
1329
1330
|
...(input.UnitLabel != null && { UnitLabel: input.UnitLabel }),
|
|
1330
1331
|
...(input.ValueKey != null && { ValueKey: input.ValueKey }),
|
|
1331
1332
|
};
|
|
@@ -1550,6 +1551,7 @@ const deserializeAws_restJson1MetricDefinition = (output, context) => {
|
|
|
1550
1551
|
EventPattern: __expectString(output.EventPattern),
|
|
1551
1552
|
MetricDefinitionId: __expectString(output.MetricDefinitionId),
|
|
1552
1553
|
Name: __expectString(output.Name),
|
|
1554
|
+
Namespace: __expectString(output.Namespace),
|
|
1553
1555
|
UnitLabel: __expectString(output.UnitLabel),
|
|
1554
1556
|
ValueKey: __expectString(output.ValueKey),
|
|
1555
1557
|
};
|
|
@@ -1572,6 +1574,7 @@ const deserializeAws_restJson1MetricDefinitionRequest = (output, context) => {
|
|
|
1572
1574
|
: undefined,
|
|
1573
1575
|
EventPattern: __expectString(output.EventPattern),
|
|
1574
1576
|
Name: __expectString(output.Name),
|
|
1577
|
+
Namespace: __expectString(output.Namespace),
|
|
1575
1578
|
UnitLabel: __expectString(output.UnitLabel),
|
|
1576
1579
|
ValueKey: __expectString(output.ValueKey),
|
|
1577
1580
|
};
|
package/dist-types/RUM.d.ts
CHANGED
|
@@ -29,22 +29,39 @@ import { RUMClient } from "./RUMClient";
|
|
|
29
29
|
*/
|
|
30
30
|
export declare class RUM extends RUMClient {
|
|
31
31
|
/**
|
|
32
|
-
* <p>Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid
|
|
32
|
+
* <p>Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid
|
|
33
33
|
* destinations include CloudWatch and Evidently.</p>
|
|
34
34
|
* <p>By default, RUM app monitors send some metrics to CloudWatch. These default metrics
|
|
35
35
|
* are listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html">CloudWatch metrics that you can collect
|
|
36
36
|
* with CloudWatch RUM</a>.</p>
|
|
37
|
-
* <p>
|
|
38
|
-
*
|
|
39
|
-
*
|
|
37
|
+
* <p>In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.</p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>Extended metrics enable you to send metrics with additional dimensions not included
|
|
41
|
+
* in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch.
|
|
42
|
+
* The valid dimension names for the additional dimensions for extended metrics are
|
|
40
43
|
* <code>BrowserName</code>, <code>CountryCode</code>, <code>DeviceType</code>,
|
|
41
44
|
* <code>FileType</code>, <code>OSName</code>, and <code>PageId</code>. For more information, see
|
|
42
45
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
|
|
43
46
|
* Extended metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or
|
|
50
|
+
* to CloudWatch Evidently or to both. With custom metrics,
|
|
51
|
+
* you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events,
|
|
52
|
+
* custom attributes, or default attributes. </p>
|
|
53
|
+
* <p>You can't send custom metrics to the <code>AWS/RUM</code> namespace. You must send custom metrics to a
|
|
54
|
+
* custom namespace that you define. The namespace that you use can't start with <code>AWS/</code>.
|
|
55
|
+
* CloudWatch RUM prepends <code>RUM/CustomMetrics/</code> to the custom namespace that you define,
|
|
56
|
+
* so the final namespace for your metrics in CloudWatch is
|
|
57
|
+
* <code>RUM/CustomMetrics/<i>your-custom-namespace</i>
|
|
58
|
+
* </code>.</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* </ul>
|
|
44
61
|
* <p>The maximum number of metric definitions that you can specify in one
|
|
45
62
|
* <code>BatchCreateRumMetricDefinitions</code> operation is 200.</p>
|
|
46
63
|
* <p>The maximum number of metric definitions that one destination can contain is 2000.</p>
|
|
47
|
-
* <p>Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension
|
|
64
|
+
* <p>Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension
|
|
48
65
|
* value counts as a custom metric. For more information, see
|
|
49
66
|
* <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
|
|
50
67
|
* <p>You must have
|
|
@@ -145,7 +162,7 @@ export declare class RUM extends RUMClient {
|
|
|
145
162
|
/**
|
|
146
163
|
* <p>Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send
|
|
147
164
|
* extended metrics to CloudWatch or to a CloudWatch Evidently experiment.</p>
|
|
148
|
-
* <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/
|
|
165
|
+
* <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html">BatchCreateRumMetricDefinitions</a>.</p>
|
|
149
166
|
*/
|
|
150
167
|
putRumMetricsDestination(args: PutRumMetricsDestinationCommandInput, options?: __HttpHandlerOptions): Promise<PutRumMetricsDestinationCommandOutput>;
|
|
151
168
|
putRumMetricsDestination(args: PutRumMetricsDestinationCommandInput, cb: (err: any, data?: PutRumMetricsDestinationCommandOutput) => void): void;
|
|
@@ -8,22 +8,39 @@ export interface BatchCreateRumMetricDefinitionsCommandInput extends BatchCreate
|
|
|
8
8
|
export interface BatchCreateRumMetricDefinitionsCommandOutput extends BatchCreateRumMetricDefinitionsResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Specifies the extended metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid
|
|
11
|
+
* <p>Specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. Valid
|
|
12
12
|
* destinations include CloudWatch and Evidently.</p>
|
|
13
13
|
* <p>By default, RUM app monitors send some metrics to CloudWatch. These default metrics
|
|
14
14
|
* are listed in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-metrics.html">CloudWatch metrics that you can collect
|
|
15
15
|
* with CloudWatch RUM</a>.</p>
|
|
16
|
-
* <p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
16
|
+
* <p>In addition to these default metrics, you can choose to send extended metrics or custom metrics or both.</p>
|
|
17
|
+
* <ul>
|
|
18
|
+
* <li>
|
|
19
|
+
* <p>Extended metrics enable you to send metrics with additional dimensions not included
|
|
20
|
+
* in the default metrics. You can also send extended metrics to Evidently as well as CloudWatch.
|
|
21
|
+
* The valid dimension names for the additional dimensions for extended metrics are
|
|
19
22
|
* <code>BrowserName</code>, <code>CountryCode</code>, <code>DeviceType</code>,
|
|
20
23
|
* <code>FileType</code>, <code>OSName</code>, and <code>PageId</code>. For more information, see
|
|
21
24
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
|
|
22
25
|
* Extended metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
|
|
26
|
+
* </li>
|
|
27
|
+
* <li>
|
|
28
|
+
* <p>Custom metrics are metrics that you define. You can send custom metrics to CloudWatch or
|
|
29
|
+
* to CloudWatch Evidently or to both. With custom metrics,
|
|
30
|
+
* you can use any metric name and namespace, and to derive the metrics you can use any custom events, built-in events,
|
|
31
|
+
* custom attributes, or default attributes. </p>
|
|
32
|
+
* <p>You can't send custom metrics to the <code>AWS/RUM</code> namespace. You must send custom metrics to a
|
|
33
|
+
* custom namespace that you define. The namespace that you use can't start with <code>AWS/</code>.
|
|
34
|
+
* CloudWatch RUM prepends <code>RUM/CustomMetrics/</code> to the custom namespace that you define,
|
|
35
|
+
* so the final namespace for your metrics in CloudWatch is
|
|
36
|
+
* <code>RUM/CustomMetrics/<i>your-custom-namespace</i>
|
|
37
|
+
* </code>.</p>
|
|
38
|
+
* </li>
|
|
39
|
+
* </ul>
|
|
23
40
|
* <p>The maximum number of metric definitions that you can specify in one
|
|
24
41
|
* <code>BatchCreateRumMetricDefinitions</code> operation is 200.</p>
|
|
25
42
|
* <p>The maximum number of metric definitions that one destination can contain is 2000.</p>
|
|
26
|
-
* <p>Extended metrics sent are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension
|
|
43
|
+
* <p>Extended metrics sent to CloudWatch and RUM custom metrics are charged as CloudWatch custom metrics. Each combination of additional dimension name and dimension
|
|
27
44
|
* value counts as a custom metric. For more information, see
|
|
28
45
|
* <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
|
|
29
46
|
* <p>You must have
|
|
@@ -10,7 +10,7 @@ export interface PutRumMetricsDestinationCommandOutput extends PutRumMetricsDest
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send
|
|
12
12
|
* extended metrics to CloudWatch or to a CloudWatch Evidently experiment.</p>
|
|
13
|
-
* <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/
|
|
13
|
+
* <p>For more information about extended metrics, see <a href="https://docs.aws.amazon.com/cloudwatchrum/latest/APIReference/API_BatchCreateRumMetricDefinitions.html">BatchCreateRumMetricDefinitions</a>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -217,106 +217,233 @@ export declare enum MetricDestination {
|
|
|
217
217
|
Evidently = "Evidently"
|
|
218
218
|
}
|
|
219
219
|
/**
|
|
220
|
-
* <p>Use this structure to define one extended metric that RUM will send
|
|
220
|
+
* <p>Use this structure to define one extended metric or custom metric that RUM will send
|
|
221
221
|
* to CloudWatch or CloudWatch Evidently. For more information, see
|
|
222
222
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-vended-metrics.html">
|
|
223
223
|
* Additional metrics that you can send to CloudWatch and CloudWatch Evidently</a>.</p>
|
|
224
|
-
* <p>
|
|
224
|
+
* <p>This structure is validated differently for extended metrics and custom metrics. For extended metrics
|
|
225
|
+
* that are sent to the <code>AWS/RUM</code> namespace, the following validations apply:</p>
|
|
226
|
+
* <ul>
|
|
227
|
+
* <li>
|
|
228
|
+
* <p>The <code>Namespace</code> parameter must be omitted or set to <code>AWS/RUM</code>.</p>
|
|
229
|
+
* </li>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p>Only certain combinations of values for <code>Name</code>, <code>ValueKey</code>, and <code>EventPattern</code>
|
|
225
232
|
* are valid. In addition to what is displayed in the list below, the <code>EventPattern</code> can also include information
|
|
226
233
|
* used by the <code>DimensionKeys</code> field.</p>
|
|
234
|
+
* <ul>
|
|
235
|
+
* <li>
|
|
236
|
+
* <p>If <code>Name</code> is <code>PerformanceNavigationDuration</code>, then
|
|
237
|
+
* <code>ValueKey</code>must be <code>event_details.duration</code> and the <code>EventPattern</code>
|
|
238
|
+
* must include <code>{"event_type":["com.amazon.rum.performance_navigation_event"]}</code>
|
|
239
|
+
* </p>
|
|
240
|
+
* </li>
|
|
241
|
+
* <li>
|
|
242
|
+
* <p>If <code>Name</code> is <code>PerformanceResourceDuration</code>, then
|
|
243
|
+
* <code>ValueKey</code>must be <code>event_details.duration</code> and the <code>EventPattern</code>
|
|
244
|
+
* must include <code>{"event_type":["com.amazon.rum.performance_resource_event"]}</code>
|
|
245
|
+
* </p>
|
|
246
|
+
* </li>
|
|
247
|
+
* <li>
|
|
248
|
+
* <p>If <code>Name</code> is <code>NavigationSatisfiedTransaction</code>, then
|
|
249
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
250
|
+
* must include <code>{
|
|
251
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
252
|
+
* "event_details": {
|
|
253
|
+
* "duration": [{
|
|
254
|
+
* "numeric": [">",2000]
|
|
255
|
+
* }]
|
|
256
|
+
* }
|
|
257
|
+
* }</code>
|
|
258
|
+
* </p>
|
|
259
|
+
* </li>
|
|
260
|
+
* <li>
|
|
261
|
+
* <p>If <code>Name</code> is <code>NavigationToleratedTransaction</code>, then
|
|
262
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
263
|
+
* must include <code>{
|
|
264
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
265
|
+
* "event_details": {
|
|
266
|
+
* "duration": [{
|
|
267
|
+
* "numeric": [">=",2000,"<"8000]
|
|
268
|
+
* }]
|
|
269
|
+
* }
|
|
270
|
+
* }</code>
|
|
271
|
+
* </p>
|
|
272
|
+
* </li>
|
|
273
|
+
* <li>
|
|
274
|
+
* <p>If <code>Name</code> is <code>NavigationFrustratedTransaction</code>, then
|
|
275
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
276
|
+
* must include <code>{
|
|
277
|
+
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
278
|
+
* "event_details": {
|
|
279
|
+
* "duration": [{
|
|
280
|
+
* "numeric": [">=",8000]
|
|
281
|
+
* }]
|
|
282
|
+
* }
|
|
283
|
+
* }</code>
|
|
284
|
+
* </p>
|
|
285
|
+
* </li>
|
|
286
|
+
* <li>
|
|
287
|
+
* <p>If <code>Name</code> is <code>WebVitalsCumulativeLayoutShift</code>, then
|
|
288
|
+
* <code>ValueKey</code>must be <code>event_details.value</code> and the <code>EventPattern</code>
|
|
289
|
+
* must include <code>{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}</code>
|
|
290
|
+
* </p>
|
|
291
|
+
* </li>
|
|
292
|
+
* <li>
|
|
293
|
+
* <p>If <code>Name</code> is <code>WebVitalsFirstInputDelay</code>, then
|
|
294
|
+
* <code>ValueKey</code>must be <code>event_details.value</code> and the <code>EventPattern</code>
|
|
295
|
+
* must include <code>{"event_type":["com.amazon.rum.first_input_delay_event"]}</code>
|
|
296
|
+
* </p>
|
|
297
|
+
* </li>
|
|
298
|
+
* <li>
|
|
299
|
+
* <p>If <code>Name</code> is <code>WebVitalsLargestContentfulPaint</code>, then
|
|
300
|
+
* <code>ValueKey</code>must be <code>event_details.value</code> and the <code>EventPattern</code>
|
|
301
|
+
* must include <code>{"event_type":["com.amazon.rum.largest_contentful_paint_event"]}</code>
|
|
302
|
+
* </p>
|
|
303
|
+
* </li>
|
|
304
|
+
* <li>
|
|
305
|
+
* <p>If <code>Name</code> is <code>JsErrorCount</code>, then
|
|
306
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
307
|
+
* must include <code>{"event_type":["com.amazon.rum.js_error_event"]}</code>
|
|
308
|
+
* </p>
|
|
309
|
+
* </li>
|
|
310
|
+
* <li>
|
|
311
|
+
* <p>If <code>Name</code> is <code>HttpErrorCount</code>, then
|
|
312
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
313
|
+
* must include <code>{"event_type":["com.amazon.rum.http_event"]}</code>
|
|
314
|
+
* </p>
|
|
315
|
+
* </li>
|
|
316
|
+
* <li>
|
|
317
|
+
* <p>If <code>Name</code> is <code>SessionCount</code>, then
|
|
318
|
+
* <code>ValueKey</code>must be null and the <code>EventPattern</code>
|
|
319
|
+
* must include <code>{"event_type":["com.amazon.rum.session_start_event"]}</code>
|
|
320
|
+
* </p>
|
|
321
|
+
* </li>
|
|
322
|
+
* </ul>
|
|
323
|
+
* </li>
|
|
324
|
+
* </ul>
|
|
325
|
+
* <p>For custom metrics, the following validation rules apply:</p>
|
|
227
326
|
* <ul>
|
|
228
327
|
* <li>
|
|
229
|
-
* <p>
|
|
230
|
-
*
|
|
231
|
-
*
|
|
328
|
+
* <p>The namespace can't be omitted and can't be <code>AWS/RUM</code>. You can use the <code>AWS/RUM</code>
|
|
329
|
+
* namespace only for extended metrics.</p>
|
|
330
|
+
* </li>
|
|
331
|
+
* <li>
|
|
332
|
+
* <p>All dimensions listed in the <code>DimensionKeys</code> field must be present in the value
|
|
333
|
+
* of <code>EventPattern</code>.</p>
|
|
334
|
+
* </li>
|
|
335
|
+
* <li>
|
|
336
|
+
* <p>The values that you specify for <code>ValueKey</code>, <code>EventPattern</code>, and
|
|
337
|
+
* <code>DimensionKeys</code> must be fields in RUM events, so all first-level keys in these fields must
|
|
338
|
+
* be one of the keys in the list later in this section.</p>
|
|
339
|
+
* </li>
|
|
340
|
+
* <li>
|
|
341
|
+
* <p>If you set a value for <code>EventPattern</code>, it must be a JSON object.</p>
|
|
342
|
+
* </li>
|
|
343
|
+
* <li>
|
|
344
|
+
* <p>For every non-empty <code>event_details</code>, there must be a non-empty <code>event_type</code>.</p>
|
|
345
|
+
* </li>
|
|
346
|
+
* <li>
|
|
347
|
+
* <p>If <code>EventPattern</code> contains an <code>event_details</code> field,
|
|
348
|
+
* it must also contain an <code>event_type</code>. For every built-in <code>event_type</code> that you use, you must use
|
|
349
|
+
* a value for <code>event_details</code> that corresponds to that
|
|
350
|
+
* <code>event_type</code>. For information about event details that correspond to event types, see
|
|
351
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM-datacollected.html#CloudWatch-RUM-datacollected-eventDetails">
|
|
352
|
+
* RUM event details</a>.</p>
|
|
353
|
+
* </li>
|
|
354
|
+
* <li>
|
|
355
|
+
* <p>In <code>EventPattern</code>, any JSON array must contain only one value.</p>
|
|
356
|
+
* </li>
|
|
357
|
+
* </ul>
|
|
358
|
+
* <p>Valid key values for first-level keys in the <code>ValueKey</code>, <code>EventPattern</code>, and
|
|
359
|
+
* <code>DimensionKeys</code> fields:</p>
|
|
360
|
+
* <ul>
|
|
361
|
+
* <li>
|
|
362
|
+
* <p>
|
|
363
|
+
* <code>account_id</code>
|
|
364
|
+
* </p>
|
|
365
|
+
* </li>
|
|
366
|
+
* <li>
|
|
367
|
+
* <p>
|
|
368
|
+
* <code>application_Id</code>
|
|
369
|
+
* </p>
|
|
370
|
+
* </li>
|
|
371
|
+
* <li>
|
|
372
|
+
* <p>
|
|
373
|
+
* <code>application_version</code>
|
|
374
|
+
* </p>
|
|
375
|
+
* </li>
|
|
376
|
+
* <li>
|
|
377
|
+
* <p>
|
|
378
|
+
* <code>application_name</code>
|
|
232
379
|
* </p>
|
|
233
380
|
* </li>
|
|
234
381
|
* <li>
|
|
235
|
-
* <p>
|
|
236
|
-
*
|
|
237
|
-
* must include <code>{"event_type":["com.amazon.rum.performance_resource_event"]}</code>
|
|
382
|
+
* <p>
|
|
383
|
+
* <code>batch_id</code>
|
|
238
384
|
* </p>
|
|
239
385
|
* </li>
|
|
240
386
|
* <li>
|
|
241
|
-
* <p>
|
|
242
|
-
*
|
|
243
|
-
* must include <code>{
|
|
244
|
-
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
245
|
-
* "event_details": {
|
|
246
|
-
* "duration": [{
|
|
247
|
-
* "numeric": [">",2000]
|
|
248
|
-
* }]
|
|
249
|
-
* }
|
|
250
|
-
* }</code>
|
|
387
|
+
* <p>
|
|
388
|
+
* <code>event_details</code>
|
|
251
389
|
* </p>
|
|
252
390
|
* </li>
|
|
253
391
|
* <li>
|
|
254
|
-
* <p>
|
|
255
|
-
*
|
|
256
|
-
* must include <code>{
|
|
257
|
-
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
258
|
-
* "event_details": {
|
|
259
|
-
* "duration": [{
|
|
260
|
-
* "numeric": [">=",2000,"<"8000]
|
|
261
|
-
* }]
|
|
262
|
-
* }
|
|
263
|
-
* }</code>
|
|
392
|
+
* <p>
|
|
393
|
+
* <code>event_id</code>
|
|
264
394
|
* </p>
|
|
265
395
|
* </li>
|
|
266
396
|
* <li>
|
|
267
|
-
* <p>
|
|
268
|
-
*
|
|
269
|
-
* must include <code>{
|
|
270
|
-
* "event_type": ["com.amazon.rum.performance_navigation_event"],
|
|
271
|
-
* "event_details": {
|
|
272
|
-
* "duration": [{
|
|
273
|
-
* "numeric": [">=",8000]
|
|
274
|
-
* }]
|
|
275
|
-
* }
|
|
276
|
-
* }</code>
|
|
397
|
+
* <p>
|
|
398
|
+
* <code>event_interaction</code>
|
|
277
399
|
* </p>
|
|
278
400
|
* </li>
|
|
279
401
|
* <li>
|
|
280
|
-
* <p>
|
|
281
|
-
*
|
|
282
|
-
* must include <code>{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}</code>
|
|
402
|
+
* <p>
|
|
403
|
+
* <code>event_timestamp</code>
|
|
283
404
|
* </p>
|
|
284
405
|
* </li>
|
|
285
406
|
* <li>
|
|
286
|
-
* <p>
|
|
287
|
-
*
|
|
288
|
-
* must include <code>{"event_type":["com.amazon.rum.first_input_delay_event"]}</code>
|
|
407
|
+
* <p>
|
|
408
|
+
* <code>event_type</code>
|
|
289
409
|
* </p>
|
|
290
410
|
* </li>
|
|
291
411
|
* <li>
|
|
292
|
-
* <p>
|
|
293
|
-
*
|
|
294
|
-
* must include <code>{"event_type":["com.amazon.rum.largest_contentful_paint_event"]}</code>
|
|
412
|
+
* <p>
|
|
413
|
+
* <code>event_version</code>
|
|
295
414
|
* </p>
|
|
296
415
|
* </li>
|
|
297
416
|
* <li>
|
|
298
|
-
* <p>
|
|
299
|
-
*
|
|
300
|
-
* must include <code>{"event_type":["com.amazon.rum.js_error_event"]}</code>
|
|
417
|
+
* <p>
|
|
418
|
+
* <code>log_stream</code>
|
|
301
419
|
* </p>
|
|
302
420
|
* </li>
|
|
303
421
|
* <li>
|
|
304
|
-
* <p>
|
|
305
|
-
*
|
|
306
|
-
* must include <code>{"event_type":["com.amazon.rum.http_event"]}</code>
|
|
422
|
+
* <p>
|
|
423
|
+
* <code>metadata</code>
|
|
307
424
|
* </p>
|
|
308
425
|
* </li>
|
|
309
426
|
* <li>
|
|
310
|
-
* <p>
|
|
311
|
-
*
|
|
312
|
-
*
|
|
427
|
+
* <p>
|
|
428
|
+
* <code>sessionId</code>
|
|
429
|
+
* </p>
|
|
430
|
+
* </li>
|
|
431
|
+
* <li>
|
|
432
|
+
* <p>
|
|
433
|
+
* <code>user_details</code>
|
|
434
|
+
* </p>
|
|
435
|
+
* </li>
|
|
436
|
+
* <li>
|
|
437
|
+
* <p>
|
|
438
|
+
* <code>userId</code>
|
|
313
439
|
* </p>
|
|
314
440
|
* </li>
|
|
315
441
|
* </ul>
|
|
316
442
|
*/
|
|
317
443
|
export interface MetricDefinitionRequest {
|
|
318
444
|
/**
|
|
319
|
-
* <p>The name for the metric that is defined in this structure.
|
|
445
|
+
* <p>The name for the metric that is defined in this structure. For custom metrics, you can specify
|
|
446
|
+
* any name that you like. For extended metrics, valid values are the following:</p>
|
|
320
447
|
* <ul>
|
|
321
448
|
* <li>
|
|
322
449
|
* <p>
|
|
@@ -393,7 +520,7 @@ export interface MetricDefinitionRequest {
|
|
|
393
520
|
/**
|
|
394
521
|
* <p>Use this field only if you are sending the metric to CloudWatch.</p>
|
|
395
522
|
* <p>This field is a map of field paths to dimension names. It defines the dimensions to associate with this
|
|
396
|
-
* metric in CloudWatch.
|
|
523
|
+
* metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:</p>
|
|
397
524
|
* <ul>
|
|
398
525
|
* <li>
|
|
399
526
|
* <p>
|
|
@@ -426,7 +553,8 @@ export interface MetricDefinitionRequest {
|
|
|
426
553
|
* </p>
|
|
427
554
|
* </li>
|
|
428
555
|
* </ul>
|
|
429
|
-
* <p>
|
|
556
|
+
* <p> For both extended metrics and custom metrics,
|
|
557
|
+
* all dimensions listed in this field
|
|
430
558
|
* must also be included in <code>EventPattern</code>.</p>
|
|
431
559
|
*/
|
|
432
560
|
DimensionKeys?: Record<string, string>;
|
|
@@ -482,6 +610,12 @@ export interface MetricDefinitionRequest {
|
|
|
482
610
|
* also matches a value in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
|
|
483
611
|
*/
|
|
484
612
|
EventPattern?: string;
|
|
613
|
+
/**
|
|
614
|
+
* <p>If this structure is for a custom metric instead of an extended metrics, use this parameter to define the
|
|
615
|
+
* metric namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.</p>
|
|
616
|
+
* <p>You cannot use any string that starts with <code>AWS/</code> for your namespace.</p>
|
|
617
|
+
*/
|
|
618
|
+
Namespace?: string;
|
|
485
619
|
}
|
|
486
620
|
export interface BatchCreateRumMetricDefinitionsRequest {
|
|
487
621
|
/**
|
|
@@ -564,6 +698,11 @@ export interface MetricDefinition {
|
|
|
564
698
|
* also matches a value in <code>DimensionKeys</code>, then the metric is published with the specified dimensions. </p>
|
|
565
699
|
*/
|
|
566
700
|
EventPattern?: string;
|
|
701
|
+
/**
|
|
702
|
+
* <p>If this metric definition is for a custom metric instead of an extended metric, this field displays
|
|
703
|
+
* the metric namespace that the custom metric is published to.</p>
|
|
704
|
+
*/
|
|
705
|
+
Namespace?: string;
|
|
567
706
|
}
|
|
568
707
|
export interface BatchCreateRumMetricDefinitionsResponse {
|
|
569
708
|
/**
|
|
@@ -72,6 +72,7 @@ export interface MetricDefinitionRequest {
|
|
|
72
72
|
UnitLabel?: string;
|
|
73
73
|
DimensionKeys?: Record<string, string>;
|
|
74
74
|
EventPattern?: string;
|
|
75
|
+
Namespace?: string;
|
|
75
76
|
}
|
|
76
77
|
export interface BatchCreateRumMetricDefinitionsRequest {
|
|
77
78
|
AppMonitorName: string | undefined;
|
|
@@ -91,6 +92,7 @@ export interface MetricDefinition {
|
|
|
91
92
|
UnitLabel?: string;
|
|
92
93
|
DimensionKeys?: Record<string, string>;
|
|
93
94
|
EventPattern?: string;
|
|
95
|
+
Namespace?: string;
|
|
94
96
|
}
|
|
95
97
|
export interface BatchCreateRumMetricDefinitionsResponse {
|
|
96
98
|
Errors: BatchCreateRumMetricDefinitionsError[] | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-rum",
|
|
3
3
|
"description": "AWS SDK for JavaScript Rum Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.277.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
+
"@aws-sdk/client-sts": "3.276.0",
|
|
24
24
|
"@aws-sdk/config-resolver": "3.272.0",
|
|
25
25
|
"@aws-sdk/credential-provider-node": "3.272.0",
|
|
26
26
|
"@aws-sdk/fetch-http-handler": "3.272.0",
|