#[non_exhaustive]pub struct EnhancedMetricsConfigBuilder { /* private fields */ }
Expand description
A builder for EnhancedMetricsConfig
.
Implementations§
Source§impl EnhancedMetricsConfigBuilder
impl EnhancedMetricsConfigBuilder
Sourcepub fn resolver_level_metrics_behavior(
self,
input: ResolverLevelMetricsBehavior,
) -> Self
pub fn resolver_level_metrics_behavior( self, input: ResolverLevelMetricsBehavior, ) -> Self
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
-
GraphQL errors: The number of GraphQL errors that occurred.
-
Requests: The number of invocations that occurred during a request.
-
Latency: The time to complete a resolver invocation.
-
Cache hits: The number of cache hits during a request.
-
Cache misses: The number of cache misses during a request.
These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior
accepts one of these values at a time:
-
FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the request. -
PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have themetricsConfig
value set toENABLED
.
Sourcepub fn set_resolver_level_metrics_behavior(
self,
input: Option<ResolverLevelMetricsBehavior>,
) -> Self
pub fn set_resolver_level_metrics_behavior( self, input: Option<ResolverLevelMetricsBehavior>, ) -> Self
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
-
GraphQL errors: The number of GraphQL errors that occurred.
-
Requests: The number of invocations that occurred during a request.
-
Latency: The time to complete a resolver invocation.
-
Cache hits: The number of cache hits during a request.
-
Cache misses: The number of cache misses during a request.
These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior
accepts one of these values at a time:
-
FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the request. -
PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have themetricsConfig
value set toENABLED
.
Sourcepub fn get_resolver_level_metrics_behavior(
&self,
) -> &Option<ResolverLevelMetricsBehavior>
pub fn get_resolver_level_metrics_behavior( &self, ) -> &Option<ResolverLevelMetricsBehavior>
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
-
GraphQL errors: The number of GraphQL errors that occurred.
-
Requests: The number of invocations that occurred during a request.
-
Latency: The time to complete a resolver invocation.
-
Cache hits: The number of cache hits during a request.
-
Cache misses: The number of cache misses during a request.
These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior
accepts one of these values at a time:
-
FULL_REQUEST_RESOLVER_METRICS
: Records and emits metric data for all resolvers in the request. -
PER_RESOLVER_METRICS
: Records and emits metric data for resolvers that have themetricsConfig
value set toENABLED
.
Sourcepub fn data_source_level_metrics_behavior(
self,
input: DataSourceLevelMetricsBehavior,
) -> Self
pub fn data_source_level_metrics_behavior( self, input: DataSourceLevelMetricsBehavior, ) -> Self
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
-
Requests: The number of invocations that occured during a request.
-
Latency: The time to complete a data source invocation.
-
Errors: The number of errors that occurred during a data source invocation.
These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
accepts one of these values at a time:
-
FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources in the request. -
PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have themetricsConfig
value set toENABLED
.
Sourcepub fn set_data_source_level_metrics_behavior(
self,
input: Option<DataSourceLevelMetricsBehavior>,
) -> Self
pub fn set_data_source_level_metrics_behavior( self, input: Option<DataSourceLevelMetricsBehavior>, ) -> Self
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
-
Requests: The number of invocations that occured during a request.
-
Latency: The time to complete a data source invocation.
-
Errors: The number of errors that occurred during a data source invocation.
These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
accepts one of these values at a time:
-
FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources in the request. -
PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have themetricsConfig
value set toENABLED
.
Sourcepub fn get_data_source_level_metrics_behavior(
&self,
) -> &Option<DataSourceLevelMetricsBehavior>
pub fn get_data_source_level_metrics_behavior( &self, ) -> &Option<DataSourceLevelMetricsBehavior>
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
-
Requests: The number of invocations that occured during a request.
-
Latency: The time to complete a data source invocation.
-
Errors: The number of errors that occurred during a data source invocation.
These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior
accepts one of these values at a time:
-
FULL_REQUEST_DATA_SOURCE_METRICS
: Records and emits metric data for all data sources in the request. -
PER_DATA_SOURCE_METRICS
: Records and emits metric data for data sources that have themetricsConfig
value set toENABLED
.
Sourcepub fn operation_level_metrics_config(
self,
input: OperationLevelMetricsConfig,
) -> Self
pub fn operation_level_metrics_config( self, input: OperationLevelMetricsConfig, ) -> Self
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
-
Requests: The number of times a specified GraphQL operation was called.
-
GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.
Metrics will be recorded by API ID and operation name. You can set the value to ENABLED
or DISABLED
.
Sourcepub fn set_operation_level_metrics_config(
self,
input: Option<OperationLevelMetricsConfig>,
) -> Self
pub fn set_operation_level_metrics_config( self, input: Option<OperationLevelMetricsConfig>, ) -> Self
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
-
Requests: The number of times a specified GraphQL operation was called.
-
GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.
Metrics will be recorded by API ID and operation name. You can set the value to ENABLED
or DISABLED
.
Sourcepub fn get_operation_level_metrics_config(
&self,
) -> &Option<OperationLevelMetricsConfig>
pub fn get_operation_level_metrics_config( &self, ) -> &Option<OperationLevelMetricsConfig>
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
-
Requests: The number of times a specified GraphQL operation was called.
-
GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.
Metrics will be recorded by API ID and operation name. You can set the value to ENABLED
or DISABLED
.
Sourcepub fn build(self) -> Result<EnhancedMetricsConfig, BuildError>
pub fn build(self) -> Result<EnhancedMetricsConfig, BuildError>
Consumes the builder and constructs a EnhancedMetricsConfig
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EnhancedMetricsConfigBuilder
impl Clone for EnhancedMetricsConfigBuilder
Source§fn clone(&self) -> EnhancedMetricsConfigBuilder
fn clone(&self) -> EnhancedMetricsConfigBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EnhancedMetricsConfigBuilder
impl Debug for EnhancedMetricsConfigBuilder
Source§impl Default for EnhancedMetricsConfigBuilder
impl Default for EnhancedMetricsConfigBuilder
Source§fn default() -> EnhancedMetricsConfigBuilder
fn default() -> EnhancedMetricsConfigBuilder
Source§impl PartialEq for EnhancedMetricsConfigBuilder
impl PartialEq for EnhancedMetricsConfigBuilder
Source§fn eq(&self, other: &EnhancedMetricsConfigBuilder) -> bool
fn eq(&self, other: &EnhancedMetricsConfigBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for EnhancedMetricsConfigBuilder
Auto Trait Implementations§
impl Freeze for EnhancedMetricsConfigBuilder
impl RefUnwindSafe for EnhancedMetricsConfigBuilder
impl Send for EnhancedMetricsConfigBuilder
impl Sync for EnhancedMetricsConfigBuilder
impl Unpin for EnhancedMetricsConfigBuilder
impl UnwindSafe for EnhancedMetricsConfigBuilder
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);