/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace CloudWatchRUM { namespace Model { /** *

Use this structure to define one extended metric or custom metric that RUM * will send to CloudWatch or CloudWatch Evidently. For more information, see * Additional 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 to * AWS/RUM.
Only certain combinations of values for * Name, ValueKey, and EventPattern are * valid. In addition to what is displayed in the list below, the * EventPattern can also include information used by the * DimensionKeys field.
- If Name is * PerformanceNavigationDuration, then ValueKeymust be * event_details.duration and the EventPattern must * include * {"event_type":["com.amazon.rum.performance_navigation_event"]}
  *
- If Name is PerformanceResourceDuration, * then ValueKeymust be event_details.duration and the * EventPattern must include * {"event_type":["com.amazon.rum.performance_resource_event"]}
  *
- If Name is * NavigationSatisfiedTransaction, then ValueKeymust be * null and the EventPattern must include { "event_type": * ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": * [{ "numeric": [">",2000] }] } }
- If * Name is NavigationToleratedTransaction, then * ValueKeymust be null and the EventPattern must include * { "event_type": ["com.amazon.rum.performance_navigation_event"], * "event_details": { "duration": [{ "numeric": [">=",2000,"<"8000] }] } * }
- If Name is * NavigationFrustratedTransaction, then ValueKeymust be * null and the EventPattern must include { "event_type": * ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": * [{ "numeric": [">=",8000] }] } }
- If * Name is WebVitalsCumulativeLayoutShift, then * ValueKeymust be event_details.value and the * EventPattern must include * {"event_type":["com.amazon.rum.cumulative_layout_shift_event"]} *
- If Name is * WebVitalsFirstInputDelay, then ValueKeymust be * event_details.value and the EventPattern must include * {"event_type":["com.amazon.rum.first_input_delay_event"]}
  *
- If Name is * WebVitalsLargestContentfulPaint, then ValueKeymust be * event_details.value and the EventPattern must include * {"event_type":["com.amazon.rum.largest_contentful_paint_event"]} *
- If Name is JsErrorCount, then * ValueKeymust be null and the EventPattern must include * {"event_type":["com.amazon.rum.js_error_event"]}
- *
  If Name is HttpErrorCount, then * ValueKeymust be null and the EventPattern must include * {"event_type":["com.amazon.rum.http_event"]}
- If * Name is SessionCount, then ValueKeymust * be null and the EventPattern must include * {"event_type":["com.amazon.rum.session_start_event"]}

For custom metrics, the following validation rules * apply:

The namespace can't be omitted and can't be * AWS/RUM. You can use the AWS/RUM namespace only for * extended metrics.
All dimensions listed in the * DimensionKeys field must be present in the value of * EventPattern.
The values that you specify for * ValueKey, EventPattern, and DimensionKeys * 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-empty * event_type.
If EventPattern contains * an event_details field, it must also contain an * event_type. For every built-in event_type that you * use, you must use a value for event_details that corresponds to * that event_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

*/ class MetricDefinitionRequest { public: AWS_CLOUDWATCHRUM_API MetricDefinitionRequest(); AWS_CLOUDWATCHRUM_API MetricDefinitionRequest(Aws::Utils::Json::JsonView jsonValue); AWS_CLOUDWATCHRUM_API MetricDefinitionRequest& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_CLOUDWATCHRUM_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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"