The Radar Agent (previously called Runscope Radar) bridges BlazeMeter API Monitoring to private APIs not available over the public internet. By running the agent within your infrastructure, BlazeMeter API monitors can run against endpoints that are otherwise inaccessible to the cloud agents. The agent is particularly useful if you're looking to test or monitor an API in the following situations:
- Monitoring private or internal APIs that reside behind a firewall.
- Testing APIs on localhost or in a private staging environment.
- Accessing APIs that require a fixed client IP address (IP whitelisting).
Use of the agent requires a trial or paid subscription.
Note: A Radar Agent is a wholly separate installation apart from a Private Location. Whereas a Private Location serves as an on-premise agent for running Functional Tests or Performance Tests, the Radar Agent serves as an on-premise agent for running API Monitoring tests.
- How it Works
- Downloading and Running the Agent
- Using the Agent for Test Runs
- Command Line / Configuration File Reference
How it Works
Monitoring and testing private APIs with API Monitoring uses a hybrid on-premises approach. The agent runs on a host within your infrastructure but test data is managed and stored in the BlazeMeter cloud. Using the API Monitoring dashboard, you have a single interface for defining tests, viewing results, configuring notifications and enabling 3rd-party integrations.
All communication from the agent to the BlazeMeter cloud is made over outbound requests to the BlazeMeter API via HTTPS on port 443. The agent requests work to be processed and sends back results over a TLS-encrypted connection and is not externally addressable.
Downloading and Running the Agent
Select an operating system to download the agent:
Running the Agent
After downloading the agent, extract the executable from the .zip file so that you can run it from your command line.
The first time you run the agent, you must use the
--token flag to ensure the agent authenticates with an API Monitoring (Runscope) token.
If you do not yet have a token, follow these steps to create one:
- Navigate to the API Monitoring tab in BlazeMeter.
- Click the blue icon in the upper-right corner, then click the Personal Information option from the drop-down menu that appears.
- On the next screen, select the Applications option from the left-hand menu.
- Click the Create Application button in the upper-right corner.
- Name your new app. (You do not necessarily need a real application, as this app may simply serve as a placeholder for generating your token, so consider naming it something such as "Runscope Agent Token".)
- The new app will require a website URL and callback URL. Since this can be a placeholder app, you may enter any URL you like -- even completely imaginary URLs.
- Click the Create Application button, this time found at the bottom of the screen.
- On the next page, scroll down to view your new Personal Access Token.
Note: You may wonder why it's necessary to create a new application. The API Monitoring feature typically requires a token be associated with an application for general use cases, but in this context, we simply need a token to authenticate the agent with, so creating a fake "dummy" application in order to generate one will suffice.
Once you have a token, run your agent for the first time like so:
Linux and macOS
$ ./runscope-radar --token=your_personal_access_token
C:\> runscope-radar.exe --token=your_personal_access_token
If you are a member of multiple API Monitoring teams, then you will next be prompted to select which team to associate your new agent with.
Once authenticated, you can save a configuration file to be used for subsequent runs of the agent (without having to pass your token each time). To launch the agent with a specific configuration file, use the
-f command line option. This is the recommended way to start the agent.
Linux and macOS
$ ./runscope-radar -f radar.conf
C:\> runscope-radar.exe -f radar.conf
If you examine the contents of this configuration file, you'll find that it contains various parameters, including the API token you provided earlier, along with a unique Agent ID and the Team ID the agent is associated with.
With the agent running, you're now ready to use it for your tests.
Using the Agent for Test Runs
After downloading and launching the agent, head over to the API test editor for the test you'd like to use the agent for. If everything is working correctly, the agent will appear as an option in the Locations section of the environment settings:
If you're testing an API across multiple realms (e.g. local, staging, prod), you may want to selectively enable the agent per-environment. The agent can also be enabled in a shared environment used across tests within a single bucket.
Command Line Flags / Configuration File Reference
You can specify the following parameters in your configuration file, or on the command line, when executing the agent. The configuration file will override the same parameters used in the command line.
||string||API host base URL.|
||string||CA certificate file.|
||string||Start the agent with the configuration contained within the specified configuration file.|
||Enable debugging web server.|
||string||Disconnect timeout. Default: "5".|
||Show all available flags. Only works on the cli.|
||Ignore HTTP_PROXY and HTTPS_PROXY environment variables. Requests to api.runscope.com will still use the proxy.|
||string||Write logfile to an external file.|
||string||The name of the agent to be displayed in the Runscope UI Locations menu.|
||integer||Number of worker threads. Default: 10.|
||integer||Connection idle timeout. Default: 20.|
||string||Runscope Auth Token.|
||Log more information.|
||Get version number. Only works on the cli.|
||string||Web host base url. Default: https://www.runscope.com.|
Running the agent in verbose mode, and ignoring env proxy variables:
$ ./runscope-radar -f radar.conf -v --ignore-env-proxy
Configuration file with increased threads value to support a higher amount of requests, and ignoring environment proxy variables:
api-host=https://api.runscope.com threads=50 agent-id=your_agent_id team-id=your_team_id name=internal-1.local timeout=20 disconnect-timeout=5 cafile= token=your_runscope_token ignore-env-proxy
In the event that the Radar Agent is down or otherwise not available for any reason, BlazeMeter/Runscope will expire any test executing on it and immediately set a status of "Remote Agent Expired" so that the user is alerted to the problem. Automated email and/or Slack notifications may be sent as well. Please refer to the Handling Radar Agent Availability Issues guide for our recommended best practices.
All tests marked with the "Remote Agent Expired" status will be colored orange in the Dashboard, Latest Test Results, and Test Result progress bars in the GUI.
Note: While an on-premise Radar Agent is down and until said agent comes back up (is available again), no scheduled test that tries to run on it will count toward any metrics calculation, nor will it count toward the owning team's test count.
If you run into any issues while setting up or running the agent, such as difficulty connecting to
api.runscope.com, or intermittent test errors, check out the following troubleshooting articles: