Class: Aws::AppSync::Types::EnhancedMetricsConfig
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppSync::Types::EnhancedMetricsConfig
- Defined in:
- gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb
Overview
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:
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
.
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
.
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
orDISABLED
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_source_level_metrics_behavior ⇒ String
Controls how data source metrics will be emitted to CloudWatch.
-
#operation_level_metrics_config ⇒ String
Controls how operation metrics will be emitted to CloudWatch.
-
#resolver_level_metrics_behavior ⇒ String
Controls how resolver metrics will be emitted to CloudWatch.
Instance Attribute Details
#data_source_level_metrics_behavior ⇒ String
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
.
2468 2469 2470 2471 2472 2473 2474 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2468 class EnhancedMetricsConfig < Struct.new( :resolver_level_metrics_behavior, :data_source_level_metrics_behavior, :operation_level_metrics_config) SENSITIVE = [] include Aws::Structure end |
#operation_level_metrics_config ⇒ String
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
.
2468 2469 2470 2471 2472 2473 2474 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2468 class EnhancedMetricsConfig < Struct.new( :resolver_level_metrics_behavior, :data_source_level_metrics_behavior, :operation_level_metrics_config) SENSITIVE = [] include Aws::Structure end |
#resolver_level_metrics_behavior ⇒ String
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
.
2468 2469 2470 2471 2472 2473 2474 |
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 2468 class EnhancedMetricsConfig < Struct.new( :resolver_level_metrics_behavior, :data_source_level_metrics_behavior, :operation_level_metrics_config) SENSITIVE = [] include Aws::Structure end |