Skip to content

CLI tool for synchronously running, monitoring and logging step functions

License

Notifications You must be signed in to change notification settings

imankamyabi/stail

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stail

CLI Tool to run and tail a step function synchronously and persist event logs for the state machine execution on disk.

Screenshot (Sample screenshot of terminal output)

Use cases:

  • Running and monitoring step function execution directly from terminal or Jupyter notebook.
  • In case of error, identifying the failed task and cause of error.
  • Debugging by reading events log file and all the metadata about the failed task (for example input and output).

Installation:

pip install stail

Usage

Run

Starts a step function execution synchronously, tails the event history to the console and create a log file with all the events for the execution.

Log file is stored at stail_logs/[execution name (UUID)].log

stail run --arn [state machine arn] --input [input]

Options:

--arn State machine ARN

--input Input JSON to the state machine

Example:
stail run --arn arn:aws:states:<region>:<account_number>:stateMachine:<name> --input "{\"param\":\"hello\"}"

Version

Displays the version.

stail version

Author: Iman Kamyabi

Feedback: [email protected]

About

CLI tool for synchronously running, monitoring and logging step functions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages