#[non_exhaustive]pub struct MetricDefinitionRequest {
pub name: String,
pub value_key: Option<String>,
pub unit_label: Option<String>,
pub dimension_keys: Option<HashMap<String, String>>,
pub event_pattern: Option<String>,
pub namespace: Option<String>,
}
Expand description
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
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.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
value_key: Option<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.
unit_label: Option<String>
The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
dimension_keys: Option<HashMap<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
.
event_pattern: Option<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.
namespace: Option<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.
Implementations§
Source§impl MetricDefinitionRequest
impl MetricDefinitionRequest
Sourcepub fn name(&self) -> &str
pub fn name(&self) -> &str
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
Sourcepub fn value_key(&self) -> Option<&str>
pub fn value_key(&self) -> Option<&str>
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.
Sourcepub fn unit_label(&self) -> Option<&str>
pub fn unit_label(&self) -> Option<&str>
The CloudWatch metric unit to use for this metric. If you omit this field, the metric is recorded with no unit.
Sourcepub fn dimension_keys(&self) -> Option<&HashMap<String, String>>
pub fn dimension_keys(&self) -> Option<&HashMap<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
.
Sourcepub fn event_pattern(&self) -> Option<&str>
pub fn event_pattern(&self) -> Option<&str>
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.
Sourcepub fn namespace(&self) -> Option<&str>
pub fn namespace(&self) -> Option<&str>
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.
Source§impl MetricDefinitionRequest
impl MetricDefinitionRequest
Sourcepub fn builder() -> MetricDefinitionRequestBuilder
pub fn builder() -> MetricDefinitionRequestBuilder
Creates a new builder-style object to manufacture MetricDefinitionRequest
.
Trait Implementations§
Source§impl Clone for MetricDefinitionRequest
impl Clone for MetricDefinitionRequest
Source§fn clone(&self) -> MetricDefinitionRequest
fn clone(&self) -> MetricDefinitionRequest
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for MetricDefinitionRequest
impl Debug for MetricDefinitionRequest
Source§impl PartialEq for MetricDefinitionRequest
impl PartialEq for MetricDefinitionRequest
Source§fn eq(&self, other: &MetricDefinitionRequest) -> bool
fn eq(&self, other: &MetricDefinitionRequest) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for MetricDefinitionRequest
Auto Trait Implementations§
impl Freeze for MetricDefinitionRequest
impl RefUnwindSafe for MetricDefinitionRequest
impl Send for MetricDefinitionRequest
impl Sync for MetricDefinitionRequest
impl Unpin for MetricDefinitionRequest
impl UnwindSafe for MetricDefinitionRequest
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);