Struct aws_sdk_appsync::types::EnhancedMetricsConfig

#[non_exhaustive]
pub struct EnhancedMetricsConfig {
    pub resolver_level_metrics_behavior: ResolverLevelMetricsBehavior,
    pub data_source_level_metrics_behavior: DataSourceLevelMetricsBehavior,
    pub operation_level_metrics_config: OperationLevelMetricsConfig,
}

Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.

Enhanced metrics can be configured at the resolver, data source, and operation levels. EnhancedMetricsConfig contains three required parameters, each controlling one of these categories:

1. 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 the metricsConfig value set to ENABLED.

2. 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 the metricsConfig value set to ENABLED.

3. 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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

resolver_level_metrics_behavior: 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 the metricsConfig value set to ENABLED.

data_source_level_metrics_behavior: 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 the metricsConfig value set to ENABLED.

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

Implementations

impl EnhancedMetricsConfig

pub fn resolver_level_metrics_behavior(&self) -> &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 the metricsConfig value set to ENABLED.

pub fn data_source_level_metrics_behavior( &self, ) -> &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 the metricsConfig value set to ENABLED.

pub fn operation_level_metrics_config(&self) -> &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.

impl EnhancedMetricsConfig

pub fn builder() -> EnhancedMetricsConfigBuilder

Creates a new builder-style object to manufacture EnhancedMetricsConfig.

Trait Implementations

impl Clone for EnhancedMetricsConfig

fn clone(&self) -> EnhancedMetricsConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EnhancedMetricsConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for EnhancedMetricsConfig

fn eq(&self, other: &EnhancedMetricsConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EnhancedMetricsConfig