Feat/enhanced metrics

doc/enhancedMetrics.md

@@ -0,0 +1,18 @@
+# Enhanced Metrics
+
+AppSync supports [Enhanced metrics](https://docs.aws.amazon.com/appsync/latest/devguide/monitoring.html#cw-metrics). You can find the metrics  configuration under the `appSync.enhancedMetrics` attribute.
+
+## Quick start
+
+```yaml
+appSync:
+  name: my-api
+  enhancedMetrics:
+    DataSourceLevelMetricsBehavior: 'FULL_REQUEST_DATA_SOURCE_METRICS'
+    OperationLevelMetricsConfig: 'ENABLED'
+```
+
+## Configuration
+See [official documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appsync-graphqlapi-enhancedmetricsconfig.html).
+
+Note `ResolverLevelMetricsBehavior` is fixed to `PER_RESOLVER_METRICS` with each resolver's `MetricsConfig` set to `DISABLED`

doc/general-config.md

@@ -45,7 +45,8 @@ appSync:
 - `resolvers`: See [Resolvers](resolvers.md)
 - `pipelineFunctions`: See [Pipeline functions](pipeline-functions.md)
 - `substitutions`: See [Substitutions](substitutions.md). Deprecated: Use environment variables.
-- `environment`: A list of environment variables for the API. See [Official Documentation](https://docs.aws.amazon.com/appsync/latest/devguide/environment-variables.html)
+- `environment`: A list of environment variables for the API. See [Official Documentation](https://docs.aws.amazon.com/appsync/latest/devguide/environmental-variables.html)
+- `enhancedMetrics`: See [enhanced metrics](enhancedMetrics.md)
 - `caching`: See [Cacing](caching.md)
 - `waf`: See [Web Application Firefall](WAF.md)
 - `logging`: See [Logging](#Logging)

src/__tests__/resolvers.test.ts

@@ -164,6 +164,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": undefined,
+              "MetricsConfig": "DISABLED",
               "RequestMappingTemplate": "Content of path/to/mappingTemplates/Query.user.request.vtl",
               "ResponseMappingTemplate": "Content of path/to/mappingTemplates/Query.user.response.vtl",
               "TypeName": "Query",
@@ -218,6 +219,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": undefined,
+              "MetricsConfig": "DISABLED",
               "Runtime": Object {
                 "Name": "APPSYNC_JS",
                 "RuntimeVersion": "1.0.0",
@@ -272,6 +274,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": undefined,
+              "MetricsConfig": "DISABLED",
               "TypeName": "Query",
             },
             "Type": "AWS::AppSync::Resolver",
@@ -323,6 +326,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": 200,
+              "MetricsConfig": "DISABLED",
               "TypeName": "Query",
             },
             "Type": "AWS::AppSync::Resolver",
@@ -380,6 +384,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": undefined,
+              "MetricsConfig": "DISABLED",
               "SyncConfig": Object {
                 "ConflictDetection": "VERSION",
                 "ConflictHandler": "LAMBDA",
@@ -478,6 +483,7 @@ describe('Resolvers', () => {
         ",
               "FieldName": "user",
               "Kind": "PIPELINE",
+              "MetricsConfig": "DISABLED",
               "PipelineConfig": Object {
                 "Functions": Array [
                   Object {
@@ -547,6 +553,7 @@ describe('Resolvers', () => {
               },
               "FieldName": "user",
               "Kind": "PIPELINE",
+              "MetricsConfig": "DISABLED",
               "PipelineConfig": Object {
                 "Functions": Array [
                   Object {
@@ -615,6 +622,7 @@ describe('Resolvers', () => {
               "Code": "Bundled content of resolvers/getUserFunction.js",
               "FieldName": "user",
               "Kind": "PIPELINE",
+              "MetricsConfig": "DISABLED",
               "PipelineConfig": Object {
                 "Functions": Array [
                   Object {
@@ -1006,6 +1014,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": undefined,
+              "MetricsConfig": "DISABLED",
               "TypeName": "Query",
             },
             "Type": "AWS::AppSync::Resolver",
@@ -1070,6 +1079,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": undefined,
+              "MetricsConfig": "DISABLED",
               "TypeName": "Query",
             },
             "Type": "AWS::AppSync::Resolver",
@@ -1134,6 +1144,7 @@ describe('Resolvers', () => {
               "FieldName": "user",
               "Kind": "UNIT",
               "MaxBatchSize": undefined,
+              "MetricsConfig": "DISABLED",
               "TypeName": "Query",
             },
             "Type": "AWS::AppSync::Resolver",

src/resources/Api.ts

@@ -112,6 +112,18 @@ export class Api {
       });
     }
 
+    if (this.config.enhancedMetrics) {
+      merge(endpointResource.Properties, {
+        EnhancedMetricsConfig: {
+          DataSourceLevelMetricsBehavior:
+            this.config.enhancedMetrics.DataSourceLevelMetricsBehavior,
+          OperationLevelMetricsConfig:
+            this.config.enhancedMetrics.OperationLevelMetricsConfig,
+          ResolverLevelMetricsBehavior: 'PER_RESOLVER_METRICS',
+        },
+      });
+    }
+
     if (this.config.introspection !== undefined) {
       merge(endpointResource.Properties, {
         IntrospectionConfig: this.config.introspection ? 'ENABLED' : 'DISABLED',

src/resources/Resolver.ts

@@ -29,6 +29,7 @@ export class Resolver {
       ApiId: this.api.getApiId(),
       TypeName: this.config.type,
       FieldName: this.config.field,
+      MetricsConfig: 'DISABLED',
     };
 
     const isVTLResolver = 'request' in this.config || 'response' in this.config;

src/types/cloudFormation.ts

@@ -117,6 +117,7 @@ export type CfnResolver = {
       };
     };
     MaxBatchSize?: number;
+    MetricsConfig?: 'ENABLED' | 'DISABLED';
   };
 };
 

src/types/common.ts

@@ -130,6 +130,15 @@ export type SyncConfig = {
 
 export type Substitutions = Record<string, string | IntrinsicFunction>;
 export type EnvironmentVariables = Record<string, string | IntrinsicFunction>;
+export type EnhancedMetricsConfig = {
+  DataSourceLevelMetricsBehavior:
+    | 'FULL_REQUEST_DATA_SOURCE_METRICS'
+    | 'PER_DATA_SOURCE_METRICS';
+  OperationLevelMetricsConfig: 'ENABLED' | ' DISABLED';
+  ResolverLevelMetricsBehavior:
+    | 'FULL_REQUEST_RESOLVER_METRICS'
+    | 'PER_RESOLVER_METRICS';
+};
 
 export type DsDynamoDBConfig = {
   type: 'AMAZON_DYNAMODB';

src/types/plugin.ts

@@ -16,6 +16,7 @@ import {
   DsNone,
   Substitutions,
   EnvironmentVariables,
+  EnhancedMetricsConfig,
 } from './common';
 export * from './common';
 
@@ -31,6 +32,7 @@ export type AppSyncConfig = {
   pipelineFunctions: Record<string, PipelineFunctionConfig>;
   substitutions?: Substitutions;
   environment?: EnvironmentVariables;
+  enhancedMetrics?: EnhancedMetricsConfig;
   xrayEnabled?: boolean;
   logging?: LoggingConfig;
   caching?: CachingConfig;

src/validation.ts

@@ -811,6 +811,22 @@ export const appSyncSchema = {
       },
       required: ['level'],
     },
+    enhancedMetrics: {
+      type: 'object',
+      properties: {
+        DataSourceLevelMetricsBehavior: {
+          type: 'string',
+          enum: ['FULL_REQUEST_DATA_SOURCE_METRICS', 'PER_DATA_SOURCE_METRICS'],
+          errorMessage:
+            "must be 'FULL_REQUEST_DATA_SOURCE_METRICS' or 'PER_DATA_SOURCE_METRICS'",
+        },
+        OperationLevelMetricsConfig: {
+          type: 'string',
+          enum: ['ENABLED', ' DISABLED'],
+          errorMessage: "must be 'ENABLED' or ' DISABLED'",
+        },
+      },
+    },
     dataSources: {
       oneOf: [
         {