Package software.amazon.awssdk.services.rum.model

Class MetricDefinitionRequest

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<MetricDefinitionRequest.Builder,​MetricDefinitionRequest>
    @Generated("software.amazon.awssdk:codegen")
public final class MetricDefinitionRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MetricDefinitionRequest.Builder,​MetricDefinitionRequest>

    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

    See Also:
    Serialized Form

    • Method Detail

      • hasDimensionKeys

        public final boolean hasDimensionKeys()
        For responses, this returns true if the service returned a value for the DimensionKeys property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • dimensionKeys

        public final Map<String,​String> dimensionKeys()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensionKeys() method.

        Returns:
        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.

      • eventPattern

        public final String eventPattern()

        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.

        Returns:
        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.

      • name

        public final String name()

        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

        Returns:
        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

      • namespace

        public final String namespace()

        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.

        Returns:
        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.

      • unitLabel

        public final String unitLabel()

        The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

        Returns:
        The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.

      • valueKey

        public final String valueKey()

        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 just 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 and Evidently will handle data extraction from the event.

        Returns:
        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 just 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 and Evidently will handle data extraction from the event.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)