Getting Started on macOS

Follow these steps to start using Flood Agent on macOS

In this guide we'll get Flood Agent running on your macOS computer.

The guide shows you how to run ad-hoc instances, suitable for exploration and prototyping floods. For production-scale installations please see Running with systemd (linux).

Download Flood Agent

Grab the latest binary from the Flood Agent Releases page. We recommend downloading the agent into its own directory. Once the binary has been downloaded, make it executable.

Download: flood-agent v1.0 for macOS

Here are the steps above as you might use them via the terminal:

mkdir -p ~/flood-agent
cd ~/flood-agent
curl -L https://github.com/flood-io/flood-agent/releases/download/v1.0/flood-agent-v1.0-macos-64bit \
> flood-agent
chmod +x ./flood-agent

If you're having trouble starting Flood Agent on macOS Catalina, please see macOS Catalina Notarization workaround below.

In the terminal, to run a binary from the current directory, don't forget the ./

For example, to run Flood Agent: ./flood-agent

Decide how to run your load generator

From here you need to decide whether you want to run your load generator as a Docker container, or from a local installation of JMeter or Gatling.

Docker is a good option if you'd like to

  • try out Flood with a minimum of setup.

  • get up and running quickly and are happy to use default configuration.

  • start prototyping & tuning load test plans.

  • use Flood Agent with a load generator not yet supported as a local installation (Flood Element & Selenium)

Alternatively, using a locally installed load generator is a good option to

  • operate in environments where docker is not available or not allowed.

  • apply custom libraries and configuration.

  • reuse existing resources.

macOS Catalina Notarization workaround

Using flood-agent on macOS Catalina requires a workaround for the new "notarization" feature.

Notarization is designed to protect Mac users from malicious software. While we support this initiative, it will take us some time to integrate with flood-agent. Until then, please follow these steps when first running the agent.

For more information about notarization please see Apple's documentation.

  1. When you first run flood-agent you'll see a dialog like this:

2. Hit Cancel.

3. Open System Preferences and go to Security & Privacy.

4. Look for the text explaining that "flood-agent" was blocked from use. Click Allow Anyway.

5. Run flood-agent again and you should see another dialog like this:

6. Click Open. flood-agent should now start!