Use different y-axes for metrics of different units

- Tidy up the branch

README.md

@@ -8,7 +8,7 @@
 
 Automatic, best-practice CloudWatch **Dashboards** and **Alarms** for your SAM, CloudFormation, CDK and Serverless Framework applications.
 
-SLIC Watch supports: _AWS Lambda, API Gateway, DynamoDB, Kinesis Data Streams, SQS Queues, Step Functions, ECS (Fargate or EC2), SNS, EventBridge and Application Load Balancer._  
+SLIC Watch supports: _AWS Lambda, API Gateway, DynamoDB, Kinesis Data Streams, SQS Queues, Step Functions, ECS (Fargate or EC2), SNS, EventBridge, Application Load Balancer and AppSync._  
 
 Supported tools include:
  * ⚡️ **Serverless Framework** v2 and v3 via the [_SLIC Watch Serverless Plugin_](#getting-started-with-serverless-framework)
@@ -33,6 +33,7 @@ Supported tools include:
     - [SNS](#sns)
     - [EventBridge](#eventbridge)
     - [Application Load Balancer](#application-load-balancer)
+    - [AppSync](#appsync) 
   - [Configuration](#configuration)
     - [Top-level configuration](#top-level-configuration)
     - [Function-level configuration](#function-level-configuration)
@@ -303,6 +304,18 @@ Application Load Balancer dashboard widgets show:
 |**UnHealthy Host Count**|**Lambda User Error**|**Lambda Internal Error**|
 |![UnHealthyHostCount](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/unHealthyHostCount.png) |![LambdaUserError](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/lambdaUserError.png)| |
 
+### AppSync
+AppSync alarms are created for:
+1. 5XX Error
+2. Latency
+
+AppSync dashboard widgets show:
+
+|5XX Error, Latency, 4XX Error, Request|
+|--|
+|![API Widget](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/appsyncAPI.png)|
+|**Connect Server Error**, **Disconnect Server Error**, **Subscribe Server Error**, **Unsubscribe Server Error**,**PublishDataMessageServerError**|
+|![Real-time Subscriptions Widget](https://raw.githubusercontent.com/fourtheorem/slic-watch/main/docs/appsyncRealTimeSubscriptions.png)|
 ## Configuration
 
 Configuration is entirely optional - SLIC Watch provides defaults that work out of the box.

core/config-schema.js

@@ -115,6 +115,7 @@ const commonWidgetProperties = {
   width: { type: ['integer', 'null'], minimum: 1, maximum: 24 },
   height: { type: ['integer', 'null'], minimum: 1, maximum: 1000 },
   metricPeriod: { type: ['integer', 'null'], minimum: 60, multipleOf: 60 },
+  yAxis: { type: ['string', 'null'], enum: ['left', 'right'] },
   Statistic: {
     type: 'array',
     items: {

core/dashboard.js

@@ -146,17 +146,16 @@ module.exports = function dashboard (dashboardConfig, functionDashboardConfigs,
    */
   function createMetricWidget (title, metricDefs, config) {
     const metrics = metricDefs.map(
-      ({ namespace, metric, dimensions, stat }) => [
+      ({ namespace, metric, dimensions, stat, yAxis }) => [
         namespace,
         metric,
         ...Object.entries(dimensions).reduce(
           (acc, [name, value]) => [...acc, name, value],
           []
         ),
-        { stat }
+        { stat, yAxis }
       ]
     )
-
     return {
       type: 'metric',
       properties: {
@@ -654,7 +653,7 @@ module.exports = function dashboard (dashboardConfig, functionDashboardConfigs,
   function createAppSyncWidgets (appSyncResources) {
     const appSyncWidgets = []
     const metricGroups = {
-      CloudWatch: ['5XXError', '4XXError', 'Latency', 'Requests'],
+      API: ['5XXError', '4XXError', 'Latency', 'Requests'],
       'Real-time Subscriptions': ['ConnectServerError', 'DisconnectServerError', 'SubscribeServerError', 'UnsubscribeServerError', 'PublishDataMessageServerError']
     }
     const metricConfigs = getConfiguredMetrics(appSyncDashConfig)
@@ -672,7 +671,8 @@ module.exports = function dashboard (dashboardConfig, functionDashboardConfigs,
                   namespace: 'AWS/AppSync',
                   metric,
                   dimensions: { GraphQLAPIId: graphQLAPIId },
-                  stat
+                  stat,
+                  yAxis: metricConfig.yAxis
                 })
               }
             }

core/default-config.js

@@ -207,6 +207,7 @@ const defaultConfig = {
       metricPeriod: 300,
       width: 8,
       height: 6,
+      yAxis: 'left',
       Lambda: {
         // Metrics per Lambda Function
         Errors: {
@@ -362,7 +363,8 @@ const defaultConfig = {
           Statistic: ['Sum']
         },
         Latency: {
-          Statistic: ['Average']
+          Statistic: ['Average'],
+          yAxis: 'right'
         },
         Requests: {
           Statistic: ['Maximum']

core/tests/dashboard.test.js

@@ -325,6 +325,38 @@ test('A dashboard includes metrics for ALB', (t) => {
     )
     t.same(actualTitles, expectedTitles)
     t.end()
+
+    test('No widgets are created if all AppSync metrics are disabled', (t) => {
+      const services = ['Lambda', 'ApiGateway', 'States', 'DynamoDB', 'SQS', 'Kinesis', 'ECS', 'SNS', 'Events', 'ApplicationELB', 'ApplicationELBTarget', 'AppSync']
+      const dashConfig = cloneDeep(defaultConfig.dashboard)
+      for (const service of services) {
+        for (const metricConfig of Object.values(dashConfig.widgets[service])) {
+          metricConfig.enabled = false
+        }
+      }
+      const dash = dashboard(dashConfig, emptyFuncConfigs, context)
+      const cfTemplate = createTestCloudFormationTemplate(appSyncCfTemplate)
+      dash.addDashboard(cfTemplate)
+      const dashResources = cfTemplate.getResourcesByType('AWS::CloudWatch::Dashboard')
+      t.same(dashResources, {})
+      t.end()
+    })
+
+    test('No widgets are created if all Application Load Balancer metrics are disabled', (t) => {
+      const services = ['Lambda', 'ApiGateway', 'States', 'DynamoDB', 'SQS', 'Kinesis', 'ECS', 'SNS', 'Events', 'ApplicationELB', 'ApplicationELBTarget', 'AppSync']
+      const dashConfig = cloneDeep(defaultConfig.dashboard)
+      for (const service of services) {
+        for (const metricConfig of Object.values(dashConfig.widgets[service])) {
+          metricConfig.enabled = false
+        }
+      }
+      const dash = dashboard(dashConfig, emptyFuncConfigs, context)
+      const cfTemplate = createTestCloudFormationTemplate(albCfTemplate)
+      dash.addDashboard(cfTemplate)
+      const dashResources = cfTemplate.getResourcesByType('AWS::CloudWatch::Dashboard')
+      t.same(dashResources, {})
+      t.end()
+    })
   })
 
   t.test('target groups with no Lambda targets are excluded from metrics', (t) => {
@@ -393,7 +425,7 @@ test('A dashboard includes metrics for ALB', (t) => {
       }
       t.same(namespaces, new Set(['AWS/AppSync']))
       const expectedTitles = new Set([
-        'AppSync CloudWatch awesome-appsync',
+        'AppSync API awesome-appsync',
         'AppSync Real-time Subscriptions awesome-appsync'
       ])
       // eslint-disable-next-line no-template-curly-in-string
@@ -458,7 +490,7 @@ test('DynamoDB widgets are created without GSIs', (t) => {
 })
 
 test('No dashboard is created if all widgets are disabled', (t) => {
-  const services = ['Lambda', 'ApiGateway', 'States', 'DynamoDB', 'SQS', 'Kinesis', 'ECS', 'SNS', 'Events', 'ApplicationELB', 'ApplicationELBTarget']
+  const services = ['Lambda', 'ApiGateway', 'States', 'DynamoDB', 'SQS', 'Kinesis', 'ECS', 'SNS', 'Events', 'ApplicationELB', 'ApplicationELBTarget', 'AppSync']
   const dashConfig = cloneDeep(defaultConfig.dashboard)
   for (const service of services) {
     dashConfig.widgets[service].enabled = false
@@ -472,7 +504,7 @@ test('No dashboard is created if all widgets are disabled', (t) => {
 })
 
 test('No dashboard is created if all metrics are disabled', (t) => {
-  const services = ['Lambda', 'ApiGateway', 'States', 'DynamoDB', 'SQS', 'Kinesis', 'ECS', 'SNS', 'Events', 'ApplicationELB', 'ApplicationELBTarget']
+  const services = ['Lambda', 'ApiGateway', 'States', 'DynamoDB', 'SQS', 'Kinesis', 'ECS', 'SNS', 'Events', 'ApplicationELB', 'ApplicationELBTarget', 'AppSync']
   const dashConfig = cloneDeep(defaultConfig.dashboard)
   for (const service of services) {
     for (const metricConfig of Object.values(dashConfig.widgets[service])) {

serverless-test-project-appsync/serverless-v2.yml

@@ -53,6 +53,7 @@ resources:
             Value: books-table
 
     #cognito users pool
+
     CognitoUserPool:
       Type: AWS::Cognito::UserPool
       Properties:
@@ -86,6 +87,7 @@ resources:
         PreventUserExistenceErrors: ENABLED
 
     #Cognito users pool Admin group
+
     CognitoAdminGroup:
       Type: AWS::Cognito::UserPoolGroup
       Properties:
@@ -95,6 +97,7 @@ resources:
         Description: "Admin users belong to this group"
 
     #Cognito Admin IAM role
+
     CognitoAdminIAMrole:
       Type: AWS::IAM::Role
       Properties: 
@@ -121,6 +124,7 @@ resources:
         RoleName: "bookstore-admin-role"
 
     #Cognito users pool Customer group
+
     CognitoCustomerGroup:
       Type: AWS::Cognito::UserPoolGroup
       Properties:
@@ -130,6 +134,7 @@ resources:
         Description: "Customer belongs to this group"
 
     #Cognito Customer IAM role
+
     CognitoUserIAMrole:
       Type: AWS::IAM::Role
       Properties: 

serverless-test-project-appsync/serverless.yml

@@ -21,7 +21,7 @@ custom:
   appSync:
     - ${file(serverless.appsync-api.yml)}
   slicWatch:
-    # topicArn: ${env:ALARM_TOPIC}
+    topicArn: ${env:ALARM_TOPIC}
     alarms:
       Lambda:
         Invocations:
@@ -64,6 +64,7 @@ resources:
             Value: books-table
 
     #cognito users pool
+
     CognitoUserPool:
       Type: AWS::Cognito::UserPool
       Properties:
@@ -97,6 +98,7 @@ resources:
         PreventUserExistenceErrors: ENABLED
 
     #Cognito users pool Admin group
+
     CognitoAdminGroup:
       Type: AWS::Cognito::UserPoolGroup
       Properties:
@@ -106,6 +108,7 @@ resources:
         Description: "Admin users belong to this group"
 
     #Cognito Admin IAM role
+
     CognitoAdminIAMrole:
       Type: AWS::IAM::Role
       Properties: 
@@ -132,6 +135,7 @@ resources:
         RoleName: "bookstore-admin-role"
 
     #Cognito users pool Customer group
+
     CognitoCustomerGroup:
       Type: AWS::Cognito::UserPoolGroup
       Properties:
@@ -141,6 +145,7 @@ resources:
         Description: "Customer belongs to this group"
 
     #Cognito Customer IAM role
+
     CognitoUserIAMrole:
       Type: AWS::IAM::Role
       Properties: