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

Interface MetricDefinitionRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MetricDefinitionRequest.Builder,MetricDefinitionRequest>, SdkBuilder<MetricDefinitionRequest.Builder,MetricDefinitionRequest>, SdkPojo
Enclosing class:
MetricDefinitionRequest
public static interface MetricDefinitionRequest.Builder extends SdkPojo, CopyableBuilder<MetricDefinitionRequest.Builder,MetricDefinitionRequest>

  • Method Details

    • dimensionKeys

      MetricDefinitionRequest.Builder dimensionKeys(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventPattern

      MetricDefinitionRequest.Builder eventPattern(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • name

      MetricDefinitionRequest.Builder name(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • namespace

      MetricDefinitionRequest.Builder namespace(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • unitLabel

      MetricDefinitionRequest.Builder unitLabel(String unitLabel)

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

      Parameters:
      unitLabel - The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • valueKey

      MetricDefinitionRequest.Builder valueKey(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 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.