Getting Started

Perform the following steps on your laptop or development machine


  1. Install Python 2.7 and pip
  2. Install Terraform
  3. Download StreamAlert:
$ git clone --branch stable
  1. Install and activate Virtualenv:
$ cd streamalert
$ pip install --user virtualenv
$ virtualenv -p python2.7 venv
$ source venv/bin/activate
  1. Install dependencies:
$ pip install -r requirements.txt


If you run into issues with psutil installation, make sure you have the python-dev dependencies installed. debian: sudo apt install python-dev`, CentOS/RHEL: sudo yum install python-devel`

Quick Start

  1. Define your AWS account
  2. Define your clusters
  3. Define your datasources
  4. Define your schemas
  5. Configure your kinesis stream/firehose
  6. Configure your lambda settings
  7. Write your rules
  8. Configure your outputs

Now it’s time to deploy!