interface EnhancedMetricsConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AppSync.CfnGraphQLApi.EnhancedMetricsConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnGraphQLApi_EnhancedMetricsConfigProperty`
Java	`software.amazon.awscdk.services.appsync.CfnGraphQLApi.EnhancedMetricsConfigProperty`
Python	`aws_cdk.aws_appsync.CfnGraphQLApi.EnhancedMetricsConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_appsync` » `CfnGraphQLApi` » `EnhancedMetricsConfigProperty`

Describes an enhanced metrics configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const enhancedMetricsConfigProperty: appsync.CfnGraphQLApi.EnhancedMetricsConfigProperty = {
  dataSourceLevelMetricsBehavior: 'dataSourceLevelMetricsBehavior',
  operationLevelMetricsConfig: 'operationLevelMetricsConfig',
  resolverLevelMetricsBehavior: 'resolverLevelMetricsBehavior',
};

Properties

Name	Type	Description
dataSourceLevelMetricsBehavior	`string`	Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:.
operationLevelMetricsConfig	`string`	Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:.
resolverLevelMetricsBehavior	`string`	Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:.

dataSourceLevelMetricsBehavior

Type: 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 the MetricsConfig value set to ENABLED .

operationLevelMetricsConfig

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

resolverLevelMetricsBehavior

Type: 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 the MetricsConfig value set to ENABLED .