The following article explains how to install, uninstall, and regenerate BlazeMeter's on premise agent on your server/instance behind your firewall.
First, make sure your server/instance meets the minimum requirements as described in this article.
Installation Process:
- Navigate to the Harbor where you want to create the ship: going to your Account Settings -> Workspaces -> Private Locations and choose the harbor.
- Choose "Add agent".
- Provide a name for the new Agent, and optionally, the IP address of the machine.
- An installation script will be generated - Copy the script and run it on your private engine
NOTE: Installing the agent inside the Docker requires sufficient permissions.
NOTE: When installing an agent behind a corporate proxy, follow these additional steps
NOTE: When installing an agent that uses a CA certificate, follow these additional steps - Once the script has finished running, a 4GB file will be downloaded in the background.
Downloads can take up to 30 minutes - during this time, the new agent will be listed in the Harbor, but will not have a heartbeat.
Once the download has finished, the ship will show a live heartbeat and will be available for use. - Optional: You can check the downloaded docker images using the following command:
$ sudo docker ps -a
You should see the something similar to the following if you have all the needed images:
REPOSITORY TAG IMAGE ID CREATED SIZE taurus-cloud 61 b96d0e5b4821 11 days ago 3.76GB taurus-cloud latest b96d0e5b4821 11 days ago 3.76GB apm-image 1.0.42 675382697ac6 2 weeks ago 281MB apm-image latest 675382697ac6 2 weeks ago 281MB blazemeter/crane 1.0.98 63d6406c5dab 5 weeks ago 700MB blazemeter/crane latest 63d6406c5dab 5 weeks ago 700MB blazemeter-quicktest 1.0.2 1d071a63e53f 5 weeks ago 98.1MB blazemeter-quicktest latest 1d071a63e53f 5 weeks ago 98.1MB blazemeter 1.0.16 f0cbfb17c75b 5 weeks ago 5.46GB blazemeter latest f0cbfb17c75b 5 weeks ago 5.46GB blazemeter/proxy-recorder 1.3.3-345 2b188b359b0a 3 weeks ago 1.13GB blazemeter/proxy-recorder latest 2b188b359b0a 3 weeks ago 1.13GB
How to Uninstall/Remove Ship:
- Log in to the machine containing the agent you want to uninstall/remove, and run the following command to list all the containers:
$ sudo docker ps -a
You will see a response similar to the one below:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
You should see the status as running.
54c0b773a855 blazemeter/crane "bash" 2 days ago Up 2 days 2 days ago blazemeter-crane - If you are seeing an 'Idle' status in BlazeMeter, you will need to use the following command to stop the container:
$ sudo docker stop <Container_ID>
You need the container ID from the previous step to run this command, which will change the container to an 'Exited' status. - Remove the <blazemeter/crane> container using the following command:
$ sudo docker rm <Container_ID>
- To remove all the images for the OPL, list out all the images on the machine using the following command:
$ sudo docker images
You will see something like the following:
REPOSITORY TAG IMAGE ID CREATED SIZE taurus-cloud 61 b96d0e5b4821 11 days ago 3.76GB taurus-cloud latest b96d0e5b4821 11 days ago 3.76GB apm-image 1.0.42 675382697ac6 2 weeks ago 281MB apm-image latest 675382697ac6 2 weeks ago 281MB blazemeter/crane 1.0.98 63d6406c5dab 5 weeks ago 700MB blazemeter/crane latest 63d6406c5dab 5 weeks ago 700MB blazemeter-quicktest 1.0.2 1d071a63e53f 5 weeks ago 98.1MB blazemeter-quicktest latest 1d071a63e53f 5 weeks ago 98.1MB blazemeter 1.0.16 f0cbfb17c75b 5 weeks ago 5.46GB blazemeter latest f0cbfb17c75b 5 weeks ago 5.46GB blazemeter/proxy-recorder 1.3.3-345 2b188b359b0a 3 weeks ago 1.13GB blazemeter/proxy-recorder latest 2b188b359b0a 3 weeks ago 1.13GB
- To remove all the images, use the following command:
$ sudo docker rmi $(docker images -a -q)
OR
If there is an issue with removing one or more of the images, you can use the following command to force delete it:
$ sudo docker rmi --force $(docker images -a -q)
OR
If you have other images on your Docker instance and you want to only remove the images used for BlazeMeter, you can use the following command:
$ sudo docker rmi <Image ID of apm-image> <Image ID of blazemeter/proxy-recorder> <Image ID of taurus-cloud> <Image ID of blazemeter-quicktest> <Image ID of blazemeter> <Image ID of blazemeter/crane>
- Finally, go to the Private Location containing this agent and click the 'Delete' button, as shown in the screenshot below:
You will be prompted if you would like to complete this action, which you can complete by clicking 'OK'.
Regenerating a Ship:
Sometimes, you will need to regenerate a ship if something goes wrong with the initial install. The following steps describe what you will need to do:
- Navigate to the Private Location of the agent in question and click the 'Regenerate' button, as shown below:
You will receive a prompt to continue, which you can complete by clicking 'OK'. You will then see another docker run command come up, similar to the one below:
Copy this command and save in a safe place for later. If you are using a proxy, you will need to add the necessary information, as discussed in this article. - Log on to the agent machine, and run the following command:
$ sudo docker ps -a
If you see a response that lists a <blazemeter/crane> container, then continue to next step. If you do not see a <blazemeter/crane> container, skip to Step 4. - Remove the container with the following commands (the Container_ID is found from the previous steps command):
$ sudo docker stop <Container_ID>
$ sudo docker rm <Container_ID> - Optional: If you are having issues with the images for your installation, you will need to run the following command to remove the images:
Removes all Docker images
$ sudo docker rmi $(docker images -a -q)
OR
Force removes all Docker images (in case of failure to delete)
$ sudo docker rmi -f $(docker images -a -q) (In case the images fail to delete)
OR
Remove all BlazeMeter related images (in case of non-BlazeMeter images in Docker instance)
$ sudo docker rmi <Image ID of apm-image> <Image ID of blazemeter/proxy-recorder> <Image ID of taurus-cloud> <Image ID of blazemeter-quicktest> <Image ID of blazemeter> <Image ID of blazemeter/crane>
- Run the docker run command that was generated in Step 1, and wait a few moments for the test to give an idle status, as shown below:
0 Comments