Installing the ICAgent (Linux)

Prerequisites

Before installing the ICAgent, ensure that the time and time zone of the local browser are consistent with those of the desired server. If multiple servers are deployed, ensure that the local browser and multiple servers use the same time zone and time. Otherwise, the application topology and tracing data on the console may be incorrect.

Installation Methods

There are two methods to install the ICAgent. The two methods are not applicable to container nodes created using ServiceStage, or Cloud Container Engine (CCE). To monitor container nodes through APM, see Application Performance Management Getting Started. Table 1 lists the ICAgent installation methods.

**Table 1** Installation methods
Method	Application Scenario
Initial installation	This installation method is used when the following conditions are met: An Elastic IP Address (EIP) has been bound to the server. For details, see Assigning an EIP and Binding It to an ECS. The ICAgent has never been installed on the server.
Inherited installation	This installation method is used when the following conditions are met: You have multiple servers on which the ICAgent is to be installed. One server is bound to an EIP, but others are not bound to an EIP. The ICAgent has been installed on the server bound to an EIP. You can use this method to install the ICAgent on the servers that are not bound to an EIP.

Initial Installation

After you apply for a server on the cloud and install the ICAgent in the Linux environment, perform the following operations:

Obtain an Access Key ID/Secret Access Key (AK/SK) by using either of the following methods:
- Obtain a temporary AK/SK by creating an agency. For details, see How Do I Obtain the AK/SK by Creating an Agency?.
  
  For each ECS server where the ICAgent is to be installed, you need to bind it to an agency on the ECS console. The agency relationship takes effect 5 minutes later.
- Obtain a permanent AK/SK by adding access keys. For details, see How Do I Obtain the AK/SK and Project ID?.
Log in to the APM console. In the navigation pane, choose Agent > Management.
Click Install ICAgent. On the page that is displayed, set Host to HUAWEI CLOUD host and OS to Linux.
Generate the ICAgent installation command and copy it.
- As shown in Figure 1, if you have obtained the permanent AK/SK, set Installation Mode to Obtain AK/SK and enter the AK/SK in the text box to generate the ICAgent installation command. Then, click Copy Command.
  Figure 1 Entering the AK/SK
  
  Ensure that the AK/SK are correct. Otherwise, the ICAgent cannot be installed.
- If you have obtained the temporary AK/SK, set Installation Mode to Create Agency and click Copy Command to copy the ICAgent installation command.
Use a remote login tool to log in to the server where the ICAgent is to be installed as the root user and run the preceding command to install the ICAgent.
- If the message "ICAgent install success" is displayed, the ICAgent is successfully installed in the /opt/oss/servicemgr/ directory. After the ICAgent is successfully installed, choose Agent > Management in the navigation pane to view the ICAgent status.
- If the installation fails, uninstall the ICAgent according to Uninstalling the ICAgent (Linux) and then install it again. If the problem persists, contact technical support.

Inherited Installation

If the ICAgent has been installed on a server and the installation package ICProbeAgent.tar.gz exists in the /opt/ICAgent/ directory of the server, use this method to install the ICAgent on a remote server with a few clicks.

Run the following command (x.x.x.x indicates the server IP address) on the server where the ICAgent has been installed:
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -ip x.x.x.x
Enter the password of the root user of the server where the ICAgent is to be installed as prompted.
- If both the expect tool and ICAgent have been installed on a server, the ICAgent is successfully installed on the remote server after the preceding command is run. If the ICAgent has been installed on a server, but the expect tool has not, enter the information as prompted.
- Ensure that the root user can run the SSH and SCP commands on the ECS server where the ICAgent has been installed to communicate with the remote ECS server where the ICAgent is to be installed.
- If the message "ICAgent install success" is displayed, the ICAgent is successfully installed in the /opt/oss/servicemgr/ directory. After the ICAgent is successfully installed, choose Agent > Management in the navigation pane to view the ICAgent status.
- If the installation fails, uninstall the ICAgent according to Uninstalling the ICAgent (Linux) and then install it again. If the problem persists, contact technical support.

Inherited Batch Installation

Ensure that you can run the SSH and SCP commands on the ECS server where the ICAgent has been installed to communicate with the remote ECS servers where the ICAgent is to be installed.
If you have installed the ICAgent in a server through an agency, you also need to set an agency for other servers where the ICAgent is to be installed. For details, see Creating an Agency.
Batch installation scripts depend on Python versions. You are advised to implement batch installation on hosts running Python 2.x. Python 3.x does not support batch installation.

Prerequisites

The IP addresses and passwords of all ECS servers where the ICAgent is to be installed have been collected, sorted in the iplist.cfg file, and uploaded to the /opt/ICAgent/ directory on the ECS server where the ICAgent has been installed. As shown in the following example, each IP address and password in the iplist.cfg file must be separated by a space.

192.168.0.109 password (Enter the actual password.)

192.168.0.39 password (Enter the actual password.)

Because the iplist.cfg file contains sensitive information, you are advised to clear it in time.

If the passwords of all servers are the same, you only need to list IP addresses in the iplist.cfg file and enter the password once during execution. If the password of an IP address is different from those of other IP addresses, you need to list both passwords and IP addresses in the iplist.cfg file.
The batch installation function depends on Python 2.7.*. If the system displays a message indicating that Python cannot be found during the installation, install Python 2.7.* and try again.

Procedure

Run the following command on the server where the ICAgent has been installed:
bash /opt/oss/servicemgr/ICAgent/bin/remoteInstall/remote_install.sh -batchModeConfig /opt/ICAgent/iplist.cfg

Enter the default password of the root user of the servers where the ICAgent is to be installed as prompted. If the passwords of all IP addresses have been configured in the iplist.cfg file, press Enter to skip this step. Otherwise, enter the default password.
```
batch install begin
Please input default passwd:
send cmd to 192.168.0.109
send cmd to 192.168.0.39
2 tasks running, please wait...
2 tasks running, please wait...
2 tasks running, please wait...
End of install agent: 192.168.0.39
End of install agent: 192.168.0.109
All hosts install icagent finish.
```
Wait until the message "All hosts install icagent finish." is displayed, which indicates that the ICAgent has been successfully installed on all the hosts listed in the configuration file.
After the ICAgent is successfully installed, choose Agent > Management in the navigation pane to view the ICAgent status.

ICAgent Statuses

The following table lists the ICAgent statuses.

**Table 2** ICAgent statuses
Status	Description
Running	The ICAgent is running properly.
Uninstalled	The ICAgent is not installed. For details about how to install the ICAgent, see Installing the ICAgent (Linux).
Installing	The ICAgent is being installed. This operation takes about 1 minute to complete.
Installation failed	Failed to install the ICAgent. Uninstall the ICAgent according to Uninstalling the ICAgent Through Logging In to a Server and then install it again.
Upgrading	The ICAgent is being upgraded. This operation takes about 1 minute to complete.
Upgrade failed	Failed to upgrade the ICAgent. Uninstall the ICAgent according to Uninstalling the ICAgent Through Logging In to a Server and then install it again.
Offline	The AK/SK or ECS agency configurations are incorrect. Ensure that such configurations are correct.
Faulty	The ICAgent is faulty. Contact technical support.