#[non_exhaustive]pub struct ServiceLevelIndicatorMetricConfig {
pub key_attributes: Option<HashMap<String, String>>,
pub operation_name: Option<String>,
pub metric_type: Option<ServiceLevelIndicatorMetricType>,
pub metric_name: Option<String>,
pub statistic: Option<String>,
pub period_seconds: Option<i32>,
pub metric_data_queries: Option<Vec<MetricDataQuery>>,
pub dependency_config: Option<DependencyConfig>,
}
Expand description
Use this structure to specify the information for the metric that a period-based SLO will monitor.
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.key_attributes: Option<HashMap<String, String>>
If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type
, Name
, and Environment
attributes.
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
operation_name: Option<String>
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
metric_type: Option<ServiceLevelIndicatorMetricType>
If the SLO is to monitor either the LATENCY
or AVAILABILITY
metric that Application Signals collects, use this field to specify which of those metrics is used.
metric_name: Option<String>
The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.
statistic: Option<String>
The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.
period_seconds: Option<i32>
The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.
metric_data_queries: Option<Vec<MetricDataQuery>>
If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.
dependency_config: Option<DependencyConfig>
Identifies the dependency using the DependencyKeyAttributes
and DependencyOperationName
.
Implementations§
Source§impl ServiceLevelIndicatorMetricConfig
impl ServiceLevelIndicatorMetricConfig
Sourcepub fn key_attributes(&self) -> Option<&HashMap<String, String>>
pub fn key_attributes(&self) -> Option<&HashMap<String, String>>
If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type
, Name
, and Environment
attributes.
This is a string-to-string map. It can include the following fields.
-
Type
designates the type of object this is. -
ResourceType
specifies the type of the resource. This field is used only when the value of theType
field isResource
orAWS::Resource
. -
Name
specifies the name of the object. This is used only if the value of theType
field isService
,RemoteService
, orAWS::Service
. -
Identifier
identifies the resource objects of this resource. This is used only if the value of theType
field isResource
orAWS::Resource
. -
Environment
specifies the location where this object is hosted, or what it belongs to.
Sourcepub fn operation_name(&self) -> Option<&str>
pub fn operation_name(&self) -> Option<&str>
If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
Sourcepub fn metric_type(&self) -> Option<&ServiceLevelIndicatorMetricType>
pub fn metric_type(&self) -> Option<&ServiceLevelIndicatorMetricType>
If the SLO is to monitor either the LATENCY
or AVAILABILITY
metric that Application Signals collects, use this field to specify which of those metrics is used.
Sourcepub fn metric_name(&self) -> Option<&str>
pub fn metric_name(&self) -> Option<&str>
The name of the CloudWatch metric to use for the SLO, when using a custom metric rather than Application Signals standard metrics.
Sourcepub fn statistic(&self) -> Option<&str>
pub fn statistic(&self) -> Option<&str>
The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see CloudWatch statistics definitions.
Sourcepub fn period_seconds(&self) -> Option<i32>
pub fn period_seconds(&self) -> Option<i32>
The number of seconds to use as the period for SLO evaluation. Your application's performance is compared to the SLI during each period. For each period, the application is determined to have either achieved or not achieved the necessary performance.
Sourcepub fn metric_data_queries(&self) -> &[MetricDataQuery]
pub fn metric_data_queries(&self) -> &[MetricDataQuery]
If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .metric_data_queries.is_none()
.
Sourcepub fn dependency_config(&self) -> Option<&DependencyConfig>
pub fn dependency_config(&self) -> Option<&DependencyConfig>
Identifies the dependency using the DependencyKeyAttributes
and DependencyOperationName
.
Source§impl ServiceLevelIndicatorMetricConfig
impl ServiceLevelIndicatorMetricConfig
Sourcepub fn builder() -> ServiceLevelIndicatorMetricConfigBuilder
pub fn builder() -> ServiceLevelIndicatorMetricConfigBuilder
Creates a new builder-style object to manufacture ServiceLevelIndicatorMetricConfig
.
Trait Implementations§
Source§impl Clone for ServiceLevelIndicatorMetricConfig
impl Clone for ServiceLevelIndicatorMetricConfig
Source§fn clone(&self) -> ServiceLevelIndicatorMetricConfig
fn clone(&self) -> ServiceLevelIndicatorMetricConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for ServiceLevelIndicatorMetricConfig
impl PartialEq for ServiceLevelIndicatorMetricConfig
Source§fn eq(&self, other: &ServiceLevelIndicatorMetricConfig) -> bool
fn eq(&self, other: &ServiceLevelIndicatorMetricConfig) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ServiceLevelIndicatorMetricConfig
Auto Trait Implementations§
impl Freeze for ServiceLevelIndicatorMetricConfig
impl RefUnwindSafe for ServiceLevelIndicatorMetricConfig
impl Send for ServiceLevelIndicatorMetricConfig
impl Sync for ServiceLevelIndicatorMetricConfig
impl Unpin for ServiceLevelIndicatorMetricConfig
impl UnwindSafe for ServiceLevelIndicatorMetricConfig
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);