Merge pull request #374 from hassaku63/feature/x-ray

feat: X-Ray tracing support for state machine

Author: theburningmonk

README.md

@@ -18,6 +18,7 @@ This is the Serverless Framework plugin for AWS Step Functions.
      - [Pre-deployment validation](#pre-deployment-validation)
      - [Express Workflow](#express-workflow)
      - [CloudWatch Logs](#cloudwatch-logs)
+     - [X-Ray](#x-ray)
  - [Current Gotcha](#current-gotcha)
  - [Events](#events)
      - [API Gateway](#api-gateway)
@@ -407,6 +408,18 @@ stepFunctions:
           - Fn::GetAtt: [MyLogGroup, Arn]
 ```
 
+### X-Ray
+
+You can enable X-Ray for your state machine, specify `tracingConfig` as shown below.
+
+```yaml
+stepFunctions:
+  stateMachines:
+    hellostepfunc1:
+      tracingConfig:
+        enabled: true
+```
+
 ## Current Gotcha
 
 Please keep this gotcha in mind if you want to reference the `name` from the `resources` section. To generate Logical ID for CloudFormation, the plugin transforms the specified name in serverless.yml based on the following scheme.

lib/deploy/stepFunctions/compileStateMachines.js

@@ -99,6 +99,7 @@ module.exports = {
         let RoleArn;
         let DependsOn = [];
         let LoggingConfiguration;
+        let TracingConfiguration;
         let Tags;
         if (stateMachineObj.inheritGlobalTags === false) {
           Tags = [];
@@ -204,6 +205,11 @@ module.exports = {
           };
         }
 
+        if (value.tracingConfig) {
+          TracingConfiguration = {
+            Enabled: value.tracingConfig.enabled,
+          };
+        }
 
         const stateMachineOutputLogicalId = this
           .getStateMachineOutputLogicalId(stateMachineName, stateMachineObj);
@@ -215,6 +221,7 @@ module.exports = {
             RoleArn,
             StateMachineType: stateMachineObj.type,
             LoggingConfiguration,
+            TracingConfiguration,
           },
           DependsOn,
         };

lib/deploy/stepFunctions/compileStateMachines.schema.js

@@ -34,6 +34,10 @@ const loggingConfig = Joi.object().keys({
   destinations: Joi.array().items(arn),
 });
 
+const tracingConfig = Joi.object().keys({
+  enabled: Joi.boolean().default(false),
+});
+
 const id = Joi.string();
 const tags = Joi.object();
 const name = Joi.string();
@@ -58,6 +62,7 @@ const schema = Joi.object().keys({
   type,
   retain,
   loggingConfig,
+  tracingConfig,
   inheritGlobalTags,
 });
 

lib/deploy/stepFunctions/compileStateMachines.test.js

@@ -1434,6 +1434,42 @@ describe('#compileStateMachines', () => {
     });
   });
 
+  it('should compile tracing configuration', () => {
+    serverless.service.stepFunctions = {
+      stateMachines: {
+        myStateMachine1: {
+          name: 'stateMachineBeta1',
+          tracingConfig: {
+            enabled: true,
+          },
+          definition: {
+            StartAt: 'A',
+            States: {
+              A: {
+                Type: 'Task',
+                Resource: 'arn:aws:lambda:#{AWS::Region}:#{AWS::AccountId}:function:hello',
+                End: true,
+              },
+            },
+          },
+        },
+      },
+    };
+
+    serverlessStepFunctions.compileStateMachines();
+    const actual = serverlessStepFunctions
+      .serverless
+      .service
+      .provider
+      .compiledCloudFormationTemplate
+      .Resources
+      .StateMachineBeta1
+      .Properties;
+
+    expect(actual).to.haveOwnProperty('TracingConfiguration');
+    expect(actual.TracingConfiguration.Enabled).to.equal(true);
+  });
+
   it('should output cloudformation outputs section', () => {
     serverless.service.stepFunctions = {
       stateMachines: {