Skip to content

Commit

Permalink
updated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
alexcasalboni committed Jul 22, 2019
1 parent 5d0afc2 commit 2d3c4d8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README-SAR.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ The AWS Step Functions state machine will return the following outputs:
* **cost**: the corresponding average cost (per invocation)
* **duration**: the corresponding average duration (per invocation)

## Error handling

If something goes wrong during the initialization or execution states, the `CleanUpOnError` step will be executed. All versions and alises will be deleted as expected (the same happens in the `Cleaner` step).

### How do I know which executor failed and why?

You can inspect the "Execution event history" and look for the corresponding `TaskStateAborted` event type.

Additionally, you can inspect the `CleanUpOnError` state input. Here you will find the stack trace of the error.

## State Machine Internals

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ You can inspect the "Execution event history" and look for the corresponding `Ta

![state-aborted](imgs/step-aborted-screenshot.png?raw=true)

Additionally, you can inspect the `CleanUpOnError` status input. Here you will find the stack trace of the error.
Additionally, you can inspect the `CleanUpOnError` state input. Here you will find the stack trace of the error.

The following screenshots show what the visual workflow will look like in case of errors:

Expand Down

0 comments on commit 2d3c4d8

Please sign in to comment.