Skip to content

Commit 0d42f90

Browse files
committed
docs: added info about x-ray tracing
1 parent da5edab commit 0d42f90

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This is the Serverless Framework plugin for AWS Step Functions.
1818
- [Pre-deployment validation](#pre-deployment-validation)
1919
- [Express Workflow](#express-workflow)
2020
- [CloudWatch Logs](#cloudwatch-logs)
21+
- [X-Ray](#x-ray)
2122
- [Current Gotcha](#current-gotcha)
2223
- [Events](#events)
2324
- [API Gateway](#api-gateway)
@@ -407,6 +408,18 @@ stepFunctions:
407408
- Fn::GetAtt: [MyLogGroup, Arn]
408409
```
409410

411+
### X-Ray
412+
413+
You can enable X-Ray for your state machine, specify `tracingConfig` as shown below.
414+
415+
```yaml
416+
stepFunctions:
417+
stateMachines:
418+
hellostepfunc1:
419+
tracingConfig:
420+
enabled: true
421+
```
422+
410423
## Current Gotcha
411424

412425
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.

0 commit comments

Comments
 (0)