feat(appsync): implements configuration that utilizes enhanced metrics for data source and resolver

Author: aki-kii

packages/@aws-cdk-testing/framework-integ/test/aws-appsync/test/integ.appsync-enhanced-metrics.js.snapshot/manifest.json

@@ -38,7 +38,7 @@
     "EnhancedMetricsSchema3325364E"
    ]
   },
-  "EnhancedMetricsNoneDS6C39D5BE": {
+  "EnhancedMetricsnoneEB4FD168": {
    "Type": "AWS::AppSync::DataSource",
    "Properties": {
     "ApiId": {
@@ -47,9 +47,30 @@
       "ApiId"
      ]
     },
-    "Name": "NoneDS",
+    "Name": "None",
     "Type": "NONE"
    }
+  },
+  "EnhancedMetricsQuerygetServiceVersionD7E03714": {
+   "Type": "AWS::AppSync::Resolver",
+   "Properties": {
+    "ApiId": {
+     "Fn::GetAtt": [
+      "EnhancedMetricsBBD0CBEA",
+      "ApiId"
+     ]
+    },
+    "DataSourceName": "None",
+    "FieldName": "getTests",
+    "Kind": "UNIT",
+    "RequestMappingTemplate": "{\"version\":\"2017-02-28\"}",
+    "ResponseMappingTemplate": "{\"version\":\"v1\"}",
+    "TypeName": "Query"
+   },
+   "DependsOn": [
+    "EnhancedMetricsnoneEB4FD168",
+    "EnhancedMetricsSchema3325364E"
+   ]
   }
  },
  "Parameters": {

packages/@aws-cdk-testing/framework-integ/test/aws-appsync/test/integ.appsync-enhanced-metrics.js.snapshot/stack.assets.json

@@ -1,4 +1,4 @@
-import * as path from 'path';
+import { join } from 'path';
 import * as cdk from 'aws-cdk-lib';
 import * as appsync from 'aws-cdk-lib/aws-appsync';
 import { IntegTest } from '@aws-cdk/integ-tests-alpha';
@@ -8,16 +8,30 @@ const stack = new cdk.Stack(app, 'stack');
 
 const api = new appsync.GraphqlApi(stack, 'EnhancedMetrics', {
   name: 'EnhancedMetrics',
-  definition: appsync.Definition.fromSchema(appsync.SchemaFile.fromAsset(path.join(__dirname, 'appsync.test.graphql'))),
+  definition: appsync.Definition.fromFile(join(__dirname, 'appsync.test.graphql')),
   enhancedMetricsConfig: {
     dataSourceLevelMetricsBehavior: appsync.DataSourceLevelMetricsBehavior.PER_DATA_SOURCE_METRICS,
     operationLevelMetricsEnabled: true,
     resolverLevelMetricsBehavior: appsync.ResolverLevelMetricsBehavior.PER_RESOLVER_METRICS,
   },
 });
 
-api.addNoneDataSource('NoneDS', {
-  name: cdk.Lazy.string({ produce(): string { return 'NoneDS'; } }),
+
+const noneDS = api.addNoneDataSource('none', {
+   name: 'None',
+   enhancedMetricsEnabled: true,
+});
+
+noneDS.createResolver('QuerygetServiceVersion', {
+  typeName: 'Query',
+  fieldName: 'getTests',
+  requestMappingTemplate: appsync.MappingTemplate.fromString(JSON.stringify({
+    version: '2017-02-28',
+  })),
+  responseMappingTemplate: appsync.MappingTemplate.fromString(JSON.stringify({
+    version: 'v1',
+  })),
+  enhancedMetricsEnabled: true,
 });
 
 new IntegTest(app, 'api', {

packages/@aws-cdk-testing/framework-integ/test/aws-appsync/test/integ.appsync-enhanced-metrics.js.snapshot/stack.template.json

@@ -937,6 +937,22 @@ const api = new appsync.GraphqlApi(this, 'OwnerContact', {
 
 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.
 
+```ts
+const schema = new appsync.SchemaFile({ filePath: 'mySchemaFile' })
+new appsync.GraphqlApi(this, 'api', {
+  name: 'myApi',
+  definition: appsync.Definition.fromSchema(schema),
+  enhancedMetricsConfig: {
+    dataSourceLevelMetricsBehavior: appsync.DataSourceLevelMetricsBehavior.FULL_REQUEST_DATA_SOURCE_METRICS,
+    operationLevelMetricsEnabled: true,
+    resolverLevelMetricsBehavior: appsync.ResolverLevelMetricsBehavior.    dataSourceLevelMetricsBehavior: appsync.DataSourceLevelMetricsBehavior.FULL_REQUEST_RESOLVER_METRICS,
+,
+  },
+});
+```
+
+If you wish to enable enhanced monitoring only for subset of data sources or resolvers you are use following configuration
+
 ```ts
 const schema = new appsync.SchemaFile({ filePath: 'mySchemaFile' })
 new appsync.GraphqlApi(this, 'api', {
@@ -948,6 +964,16 @@ new appsync.GraphqlApi(this, 'api', {
     resolverLevelMetricsBehavior: appsync.ResolverLevelMetricsBehavior.PER_RESOLVER_METRICS,
   },
 });
+
+const noneDS = api.addNoneDataSource('none', {
+  enhancedMetricsEnabled: true,
+});
+
+noneDS.createResolver('noneResolver', {
+  typeName: 'Mutation',
+  fieldName: 'addDemoMetricsConfig',
+  enhancedMetricsEnabled: true,
+});
 ```
 
 ## Events

packages/@aws-cdk-testing/framework-integ/test/aws-appsync/test/integ.appsync-enhanced-metrics.js.snapshot/tree.json

@@ -34,6 +34,14 @@ export interface BaseDataSourceProps {
    * @default - None
    */
   readonly description?: string;
+
+  /**
+   * the whether to enable enhanced metrics of the data source
+   * Value will be ignored, if `enhancedMetricsConfig.dataSourceLevelMetricsBehavior` on AppSync GraphqlApi construct is set to `FULL_REQUEST_DATA_SOURCE_METRICS`
+   *
+   * @default - Enhance metrics are disabled
+   */
+  readonly enhancedMetricsEnabled?: boolean;
 }
 
 /**
@@ -128,11 +136,14 @@ export abstract class BaseDataSource extends Construct {
     // Replace unsupported characters from DataSource name. The only allowed pattern is: {[_A-Za-z][_0-9A-Za-z]*}
     const name = (props.name ?? id);
     const supportedName = Token.isUnresolved(name) ? name : name.replace(/[\W]+/g, '');
+    const metricsConfig = props.enhancedMetricsEnabled === undefined ? undefined
+      : (props.enhancedMetricsEnabled ? 'ENABLED': 'DISABLED');
     this.ds = new CfnDataSource(this, 'Resource', {
       apiId: props.api.apiId,
       name: supportedName,
       description: props.description,
       serviceRoleArn: this.serviceRole?.roleArn,
+      metricsConfig: metricsConfig,
       ...extended,
     });
     this.name = supportedName;

packages/@aws-cdk-testing/framework-integ/test/aws-appsync/test/integ.appsync-enhanced-metrics.ts

@@ -37,6 +37,14 @@ export interface DataSourceOptions {
    * @default - No description
    */
   readonly description?: string;
+
+  /**
+   * The whether to enable enhanced metrics of the data source
+   * Value will be ignored, if `enhancedMetricsConfig.dataSourceLevelMetricsBehavior` on AppSync GraphqlApi construct is set to `FULL_REQUEST_DATA_SOURCE_METRICS`
+   *
+   * @default - Enhance metrics are disabled
+   */
+  readonly enhancedMetricsEnabled?: boolean;
 }
 
 /**
@@ -377,6 +385,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       api: this,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
     });
   }
 
@@ -393,6 +402,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       table,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
     });
   }
 
@@ -409,6 +419,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       endpoint,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
       authorizationConfig: options?.authorizationConfig,
     });
   }
@@ -426,6 +437,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       lambdaFunction,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
     });
   }
 
@@ -448,6 +460,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       api: this,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
       serverlessCluster,
       secretStore,
       databaseName,
@@ -473,6 +486,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       api: this,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
       serverlessCluster,
       secretStore,
       databaseName,
@@ -492,6 +506,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       api: this,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
       domain,
     });
   }
@@ -508,6 +523,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       eventBus,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
     });
   }
 
@@ -523,6 +539,7 @@ export abstract class GraphqlApiBase extends Resource implements IGraphqlApi {
       api: this,
       name: options?.name,
       description: options?.description,
+      enhancedMetricsEnabled: options?.enhancedMetricsEnabled,
       domain,
     });
   }