Loadmill Agent

Running API and Load tests locally or on your servers.
Running API and load tests locally on your own servers can offer several benefits, including faster test execution, greater control over the testing environment, improved isolation of issues, and enhanced security.
By running tests locally, you can avoid the latency and potential security risks associated with sending requests over the internet, and have more control over the testing environment to simulate different conditions and more effectively identify and fix issues with your API or application.
The Loadmill Agent is a tool that enables you to run load and performance tests on your servers or local environment. It acts as a proxy, intercepting requests made to your API or application and forwarding them to the Loadmill testing platform. The Loadmill Agent can be installed on your servers or locally on your development machine and configured to intercept requests made to specific endpoints or domains.
You can download the Loadmill agent via npm package or use our newly release desktop app for macOS.

MacOS Desktop App

Loadmill has recently released a new desktop app for macOS that allows users to perform regular and local testing using a private agent. The app is designed to be easy to use and provides a convenient way to access Loadmill's powerful testing capabilities from a Mac computer.
One of the key features of the app is the private agent, which allows users to conduct testing on their own devices without having to rely on external servers. This is particularly useful for local testing, as it allows users to test their applications in a controlled environment without having to worry about network connectivity or other external factors.
To use the private agent, users will need to generate a Loadmill security token. Once the token has been generated, it can be used to authenticate the private agent and begin testing.
Agent Installation
Agent Run

NPM Package/Docker Installation

Run the following command if you have Docker installed on your machine:
docker run -it --rm -e LOADMILL_AGENT_TOKEN=<your-api-token> loadmill/agent
For more information, please click here

NPM Package

  1. 1.
    Node version 14 or higher installed.
using npm
using yarn
npm i @loadmill/agent -g
npm i @loadmill/agent // in case you can't install it globally.
yarn add @loadmill/agent -g

Running the Agent

installed globally (-g)
installed locally
loadmill-agent start -t <token>
./node_modules/@loadmill/agent/bin/loadmill-agent start -t <token>


The start command accepts the following options:
  • --token - (REQUIRED) can be retrieved through the UI.
  • --loads-capacity - (default = 50). Optionally you can supply the number of users this agent can simulate. It can be 0 in order not to run load tests.
  • --no-api - can be supplied in order to run Load tests only, API tests will run on Loadmill servers.
  • --pool - can be supplied in order to set the agent pool (the limit is 256 characters). When using multiple Loadmill Agents, this parameter helps you distinguish between running agents. Then, use our npm module with supplying the --pool <pool> parameter to assign test runs to a specific agent.
  • --config - alternatively, you can supply a path to a yaml file that will contain all the options above.

Insecure Certificates

You can set the env var NODE_TLS_REJECT_UNAUTHORIZED=0 at the beginning of the start command when you're testing a system that uses https but has a self-signed or invalid SSL certificate. Just type this: NODE_TLS_REJECT_UNAUTHORIZED=0 loadmill-agent start -t <INSERT_TOKEN_HERE>
IMPORTANT: The Loadmill agent won't be able to verify that it's talking to the right website in this case.