Class: Aws::CloudWatchRUM::Types::MetricDefinitionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatchRUM::Types::MetricDefinitionRequest
- Defined in:
- gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb
Overview
Use this structure to define one extended metric or custom metric that RUM will send to CloudWatch or CloudWatch Evidently. For more information, see Custom metrics and extended metrics that you can send to CloudWatch and CloudWatch Evidently.
This structure is validated differently for extended metrics and
custom metrics. For extended metrics that are sent to the AWS/RUM
namespace, the following validations apply:
The
Namespace
parameter must be omitted or set toAWS/RUM
.Only certain combinations of values for
Name
,ValueKey
, andEventPattern
are valid. In addition to what is displayed in the following list, theEventPattern
can also include information used by theDimensionKeys
field.If
Name
isPerformanceNavigationDuration
, thenValueKey
must beevent_details.duration
and theEventPattern
must include{"event_type":["com.amazon.rum.performance_navigation_event"]}
If
Name
isPerformanceResourceDuration
, thenValueKey
must beevent_details.duration
and theEventPattern
must include{"event_type":["com.amazon.rum.performance_resource_event"]}
If
Name
isNavigationSatisfiedTransaction
, thenValueKey
must be null and theEventPattern
must include{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">",2000] }] } }
If
Name
isNavigationToleratedTransaction
, thenValueKey
must be null and theEventPattern
must include{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",2000,"<"8000] }] } }
If
Name
isNavigationFrustratedTransaction
, thenValueKey
must be null and theEventPattern
must include{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",8000] }] } }
If
Name
isWebVitalsCumulativeLayoutShift
, thenValueKey
must beevent_details.value
and theEventPattern
must include{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]}
If
Name
isWebVitalsFirstInputDelay
, thenValueKey
must beevent_details.value
and theEventPattern
must include{"event_type":["com.amazon.rum.first_input_delay_event"]}
If
Name
isWebVitalsLargestContentfulPaint
, thenValueKey
must beevent_details.value
and theEventPattern
must include{"event_type":["com.amazon.rum.largest_contentful_paint_event"]}
If
Name
isJsErrorCount
, thenValueKey
must be null and theEventPattern
must include{"event_type":["com.amazon.rum.js_error_event"]}
If
Name
isHttpErrorCount
, thenValueKey
must be null and theEventPattern
must include{"event_type":["com.amazon.rum.http_event"]}
If
Name
isSessionCount
, thenValueKey
must be null and theEventPattern
must include{"event_type":["com.amazon.rum.session_start_event"]}
If
Name
isPageViewCount
, thenValueKey
must be null and theEventPattern
must include{"event_type":["com.amazon.rum.page_view_event"]}
If
Name
isHttp4xxCount
, thenValueKey
must be null and theEventPattern
must include{"event_type": ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",400,"<",500]}]}}} }
If
Name
isHttp5xxCount
, thenValueKey
must be null and theEventPattern
must include{"event_type": ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",500,"<=",599]}]}}} }
For custom metrics, the following validation rules apply:
The namespace can't be omitted and can't be
AWS/RUM
. You can use theAWS/RUM
namespace only for extended metrics.All dimensions listed in the
DimensionKeys
field must be present in the value ofEventPattern
.The values that you specify for
ValueKey
,EventPattern
, andDimensionKeys
must be fields in RUM events, so all first-level keys in these fields must be one of the keys in the list later in this section.If you set a value for
EventPattern
, it must be a JSON object.For every non-empty
event_details
, there must be a non-emptyevent_type
.If
EventPattern
contains anevent_details
field, it must also contain anevent_type
. For every built-inevent_type
that you use, you must use a value forevent_details
that corresponds to thatevent_type
. For information about event details that correspond to event types, see RUM event details.In
EventPattern
, any JSON array must contain only one value.
Valid key values for first-level keys in the ValueKey
,
EventPattern
, and DimensionKeys
fields:
account_id
application_Id
application_version
application_name
batch_id
event_details
event_id
event_interaction
event_timestamp
event_type
event_version
log_stream
metadata
sessionId
user_details
userId
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#dimension_keys ⇒ Hash<String,String>
Use this field only if you are sending the metric to CloudWatch.
-
#event_pattern ⇒ String
The pattern that defines the metric, specified as a JSON object.
-
#name ⇒ String
The name for the metric that is defined in this structure.
-
#namespace ⇒ String
If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric namespace for that custom metric.
-
#unit_label ⇒ String
The CloudWatch metric unit to use for this metric.
-
#value_key ⇒ String
The field within the event object that the metric value is sourced from.
Instance Attribute Details
#dimension_keys ⇒ Hash<String,String>
Use this field only if you are sending the metric to CloudWatch.
This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch. For extended metrics, valid values for the entries in this field are the following:
"metadata.pageId": "PageId"
"metadata.browserName": "BrowserName"
"metadata.deviceType": "DeviceType"
"metadata.osName": "OSName"
"metadata.countryCode": "CountryCode"
"event_details.fileType": "FileType"
For both extended metrics and custom metrics, all dimensions listed
in this field must also be included in EventPattern
.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 1275 class MetricDefinitionRequest < Struct.new( :dimension_keys, :event_pattern, :name, :namespace, :unit_label, :value_key) SENSITIVE = [] include Aws::Structure end |
#event_pattern ⇒ String
The pattern that defines the metric, specified as a JSON object. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
When you define extended metrics, the metric definition is not valid
if EventPattern
is omitted.
Example event patterns:
'{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }'
'{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }'
'{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
If the metrics destination is CloudWatch
and the event also
matches a value in DimensionKeys
, then the metric is published
with the specified dimensions.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 1275 class MetricDefinitionRequest < Struct.new( :dimension_keys, :event_pattern, :name, :namespace, :unit_label, :value_key) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name for the metric that is defined in this structure. For custom metrics, you can specify any name that you like. For extended metrics, valid values are the following:
PerformanceNavigationDuration
PerformanceResourceDuration
NavigationSatisfiedTransaction
NavigationToleratedTransaction
NavigationFrustratedTransaction
WebVitalsCumulativeLayoutShift
WebVitalsFirstInputDelay
WebVitalsLargestContentfulPaint
JsErrorCount
HttpErrorCount
SessionCount
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 1275 class MetricDefinitionRequest < Struct.new( :dimension_keys, :event_pattern, :name, :namespace, :unit_label, :value_key) SENSITIVE = [] include Aws::Structure end |
#namespace ⇒ String
If this structure is for a custom metric instead of an extended metrics, use this parameter to define the metric namespace for that custom metric. Do not specify this parameter if this structure is for an extended metric.
You cannot use any string that starts with AWS/
for your
namespace.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 1275 class MetricDefinitionRequest < Struct.new( :dimension_keys, :event_pattern, :name, :namespace, :unit_label, :value_key) SENSITIVE = [] include Aws::Structure end |
#unit_label ⇒ String
The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 1275 class MetricDefinitionRequest < Struct.new( :dimension_keys, :event_pattern, :name, :namespace, :unit_label, :value_key) SENSITIVE = [] include Aws::Structure end |
#value_key ⇒ String
The field within the event object that the metric value is sourced from.
If you omit this field, a hardcoded value of 1 is pushed as the metric value. This is useful if you want to count the number of events that the filter catches.
If this metric is sent to CloudWatch Evidently, this field will be passed to Evidently raw. Evidently will handle data extraction from the event.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 |
# File 'gems/aws-sdk-cloudwatchrum/lib/aws-sdk-cloudwatchrum/types.rb', line 1275 class MetricDefinitionRequest < Struct.new( :dimension_keys, :event_pattern, :name, :namespace, :unit_label, :value_key) SENSITIVE = [] include Aws::Structure end |