Flood Agent
Getting Started - Docker
Start using Flood Agent with Docker based load generators
If your system has Docker installed, using Flood's pretuned Docker images is the simplest way to start using Flood Agent.
These Docker images are the exact same images used when running on the Flood platform.

Docker Desktop System Requirements


Currently Docker Desktop is available for Windows with a WSL 2 and Hyper-V backends (Updated October 2021).

WSL 2 backend

  • Windows 10 64-bit: Home or Pro 2004 (build 19041) or higher, or Enterprise or Education 1909 (build 18363) or higher.
  • Enable the WSL 2 feature on Windows. For detailed instructions, refer to the Microsoft documentation.
  • The following hardware prerequisites are required to successfully run WSL 2 on Windows 10:
  • Download and install the Linux kernel update package.
For updated Docker Desktop Windows system requirements - please visit: https://docs.docker.com/desktop/windows/install/#system-requirements


(Intel Chipset) macOS must be version 10.14 or newer. That is, Mojave, Catalina, or Big Sur. We recommend upgrading to the latest version of macOS.
(Apple Silicon) You must install Rosetta 2 as some binaries are still Darwin/AMD64.
For updated Docker Desktop macOS system requirements - please visit: https://docs.docker.com/desktop/mac/install/#system-requirement

Copy your Flood API token

The first step is to copy your Flood API token from the Flood dashboard.
  1. 1.
    Click here to visit the Flood API Access page.
  2. 2.
    Click on Reveal token under Flood IO API v2.0. You should see something like this:
3. Copy the string beginning with flood_live to your clipboard; you'll need it in the next step.

Run the agent

Run the flood-agent binary that you downloaded in the previous section of the Getting Started guide. Use the token that you copied in the previous step:
Linux & Mac
./flood-agent --token flood_live_f100d1e9a8e...
.\flood-agent.exe --token flood_live_f100d1e9a8e...
Flood Agent will use a random grid name like submerged-dolphin.
You can also specify a custom name for your grid. For example, mygrid
Linux & Mac
./flood-agent --token flood_live_f100d1e9a8e... --grid mygrid1
.\flood-agent.exe --token flood_live_f100d1e9a8e... --grid mygrid1
If you repeat these steps on a second machine, your grid mygrid1 will now have two nodes. Any floods you run on mygrid1 will now run on both machines.
For more information, please see How it Works.

Verify the agent

Once the agent has started you should start seeing some informational logging:
~# Flood Agent #~
==> Contacting Flood API...
--> checking Flood API token
[√] token valid
--> syncing with API as mygrid1
[√] sync done
==> Bootstrapping Flood agent...
[2s] ~ starting Flood Agent ~ version: dev build: dev
[5s] Using stdout-only logs
[5s][mygrid1] load generator config summary
[5s][mygrid1] java-selenium-firefox:
[5s][mygrid1] as docker container
[5s][mygrid1] jmeter:
[5s][mygrid1] as docker container
[5s][mygrid1] gatling:
[5s][mygrid1] as docker container
[5s][mygrid1] floodchrome:
[5s][mygrid1] as docker container
[5s][mygrid1] floodelement:
[5s][mygrid1] as docker container
[5s][mygrid1] java-selenium-chrome:
[5s][mygrid1] as docker container
[8s][mygrid1][agent] ready, awaiting Flood jobs
[8s][mygrid1][job-worker] awaiting next job
If you're still having trouble starting flood-agent, try the flood-agent check‌ command. For more details see the "Check your Configuration" section on the Getting Started - Local JMeter & Gatling page.
If you're running flood-agent from within a corporate network, you may need to perform additional steps to get started. For more information, please see the Networking page.

Next, run a load test

To continue to launch a load test, check out Running a flood on your grid.