loadmill/agent repository overview

⁠Docker image for Loadmill's agent

⁠What is Loadmill Agent

Loadmill⁠ is an API testing tool that helps you create and run tests from real users traffic. By default Loadmill runs the test on it own servers. However, when one want to run his tests from his own servers he can use Loadmill's agent⁠ who wrapped in this Docker image.

⁠Running

First, you must create an API token⁠. After obtaining an an API token run the following:

docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> loadmill/agent

Optional environment variables:

• LOADMILL_AGENT_LOADS_CAPACITY : (default = 50). Optionally you can supply the number of users this agent can simulate. can be 0 in order to not run load tests
• LOADMILL_AGENT_NO_API: (boolean, default = false) Can be supplied in order to prevent the agent from running API tests (allow only load tests)
• LOADMILL_AGENT_POOL: (default = null) Can be supplied in order to set a pool name for the private agent.
• LOADMILL_AGENT_ALLOW_TEAM: (boolean, default = null) Allow other members of your team to run tests on this agent.
• LOADMILL_AGENT_SENSITIVE_DATA: (boolean, default = false) Redact data from request body, response body and parameters values.
• OVERRIDE_PARAMETERS: (default = null) Set Loadmill parameter values that will override any value in any run for the desired parameters. Pass 'name=value' pairs separated by comma: host=test.myapp.com,port=4443

For example:

docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> -e LOADMILL_AGENT_LOADS_CAPACITY='100'  loadmill/agent
docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> -e LOADMILL_AGENT_NO_API='true'  loadmill/agent
docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> -e LOADMILL_AGENT_POOL='myPool'  loadmill/agent
docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> -e LOADMILL_AGENT_ALLOW_TEAM='true'  loadmill/agent
docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> -e LOADMILL_AGENT_SENSITIVE_DATA='true'  loadmill/agent
docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> -e OVERRIDE_PARAMETERS='host=test.myapp.com,port=4443'  loadmill/agent

⁠Note

In case you ran into connectivity issues please try to:

• Check whether a local anti-virus, firewall or some security measures blocks the traffic
• Try run the docker command using --net=host.

If that didn't help - please contact us at [email protected]⁠