feat: add ExecutionSucceeded as a valid metric

Author: Vishal Bhavsar

README.md

@@ -126,6 +126,7 @@ stepFunctions:
           - executionsAborted
           - metric: executionThrottled
             treatMissingData: breaching # overrides below default
+          - executionsSucceeded
         treatMissingData: ignore # optional
     hellostepfunc2:
       definition:
@@ -254,6 +255,7 @@ stepFunctions:
           - executionsFailed
           - executionsAborted
           - executionThrottled
+          - executionSucceeded
         treatMissingData: missing
 ```
 
@@ -298,6 +300,7 @@ alarms:
     - executionsAborted
     - metric: executionThrottled
       treatMissingData: breaching # override
+    - executionsSucceeded
   treatMissingData: ignore # default
 ```
 

lib/deploy/stepFunctions/compileAlarms.js

@@ -10,13 +10,15 @@ const cloudWatchMetricNames = {
   executionsFailed: 'ExecutionsFailed',
   executionsAborted: 'ExecutionsAborted',
   executionThrottled: 'ExecutionThrottled',
+  executionSucceeded: 'ExecutionSucceeded',
 };
 
 const alarmDescriptions = {
   executionsTimedOut: 'executions timed out',
   executionsFailed: 'executions failed',
   executionsAborted: 'executions were aborted',
   executionThrottled: 'execution were throttled',
+  executionSucceeded: 'execution succeeded',
 };
 
 function getCloudWatchAlarms(

lib/deploy/stepFunctions/compileAlarms.schema.js

@@ -21,7 +21,8 @@ const treatMissingData = Joi.string()
   .default('missing');
 
 const simpleMetric = Joi.string()
-  .allow('executionsTimedOut', 'executionsFailed', 'executionsAborted', 'executionThrottled');
+  .allow('executionsTimedOut', 'executionsFailed', 'executionsAborted', 'executionThrottled',
+    'executionSucceeded');
 
 const complexMetric = Joi.object().keys({
   metric: simpleMetric.required(),

lib/deploy/stepFunctions/compileAlarms.test.js

@@ -64,6 +64,7 @@ describe('#compileAlarms', () => {
           'executionsFailed',
           'executionsAborted',
           'executionThrottled',
+          'executionSucceeded',
         ],
       },
     });
@@ -296,6 +297,7 @@ describe('#compileAlarms', () => {
           'executionsFailed',
           'executionsAborted',
           'executionThrottled',
+          'executionSucceeded',
         ],
         treatMissingData: 'ignore',
       },
@@ -352,6 +354,7 @@ describe('#compileAlarms', () => {
           { metric: 'executionsFailed', treatMissingData: 'breaching' },
           'executionsAborted',
           'executionThrottled',
+          'executionSucceeded',
         ],
         treatMissingData: 'ignore',
       },

package.json

@@ -40,8 +40,8 @@
     "mocha-param": "^2.0.0",
     "nyc": "^15.0.0",
     "semantic-release": "^15.14.0",
-    "sinon": "^1.17.5",
-    "serverless": "^1.72.0"
+    "serverless": "^1.72.0",
+    "sinon": "^1.17.5"
   },
   "dependencies": {
     "@hapi/joi": "^15.0.2",