Help Center/ Cloud Eye/ User Guide/ Cloud Resource Monitoring/ Server Monitoring/ Cloud Eye Plug-in (Agent)/ Installing the Agent
Updated on 2025-08-07 GMT+08:00
View PDF
Share

Installing the Agent

The Agent can collect metric data from the target host OS and send it to Cloud Eye for analysis. You can view such data in graphs to monitor metrics in real time. You can also set alarm rules for key metrics to quickly identify faults.

After the Agent is installed, Cloud Eye can provide proactive and fine-grained OS monitoring for servers. This section describes how to install the Agent automatically across all servers or using a custom method, as well as how to manually install it on a single server or in batches.

Applicable scenarios

Table 1 Applicable scenarios

Installation Method

Scenario

Constraints

Automatically Installing the Agent on All Servers

Cloud Eye supports one-click Agent installation on the console. If you want to install the Agent for all servers in the server monitoring list, you are advised to choose this installation method.

After the installation is complete, you can manually install the Agent for servers that do not support one-click installation or those failed automatic installation.

Mainstream OSs support one-click installation. For details about supported OSs, see What OSs Does the Agent Support?

Customizing the Automatic Agent Installation

Cloud Eye supports one-click Agent installation for servers on the console. If you only need to install the Agent for some servers that support one-click installation, you can use Cloud Eye to automate the process.

Installing the Agent on a Single Server

If a server does not support or failed one-click installation, you can manually install the Agent for it.

For details about supported OSs, see What OSs Does the Agent Support?

None

Manually Installing the Agents in Batches

If you have multiple Linux servers in the same VPC and they do not support one-click installation, you can install the Agent for them in batches.

  • Remote batch installation: Enter the IP address, port No., and root password or key of the servers on the management console, and then run the installation commands.
  • Local batch installation: Log in to a server and run the installation command to install the Agents for servers in batches.
  • Only Linux servers are supported.
  • The servers for batch Agent installation must be deployed in the same VPC.

Automatically Installing the Agent on All Servers

Prerequisites

Procedure

  1. Log in to the Cloud Eye console.
  2. In the navigation pane, choose Server Monitoring > Elastic Cloud Server.
  3. Choose Install & Upgrade the Agent > Install and Upgrade Agent on All Servers. The Agent installation and upgrade guidelines will be displayed on the right pane.
    Figure 1 Installing and upgrading the Agent on all servers
  4. Install the Agent as instructed.
    1. Select an installation method.
      • Install or upgrade the Agent to the latest version on all ECSs: Install the Agent for all ECSs that support one-click installation but without the Agent installed, and upgrade the Agent for all ECSs with the Agent installed.
      • Install the Agent: Install the Agent on all ECSs that support one-click installation but without the Agent installed.
      • Upgrade the Agent: Upgrade the Agent for all ECSs with the Agent installed.
    2. Select an Agent edition.
      • Basic edition provides basic OS monitoring metrics, including CPU, memory, file system, disk, NIC, and network metrics.
      • Enhanced edition provides GPU and BMS hardware monitoring, in addition to the capabilities provided in the basic edition.

      Install the Agent enhanced edition if you indeed need it, because it collects more metrics, which may occupy more server resources.

  5. Click OK.
  6. Check the Agent installation results.
    1. In the navigation pane, choose Task Center.
    2. In the right pane, click the Agent Maintenance tab to view the task status.
      • If Status is Successful, the Agent is installed. On the Server Monitoring page, check that the Agent status is Running and the Agent version is the latest.
      • If Status is Timeout, click Retry in the Operation column.

Customizing the Automatic Agent Installation

Prerequisites

Procedure

  1. Log in to the Cloud Eye console.
  2. In the navigation pane, choose Server Monitoring > Elastic Cloud Server.
  3. Select the target servers and choose Install & Upgrade the Agent > Batch Install and Upgrade Agent. The Agent installation and upgrade guide will be displayed on the right.
    Figure 2 Batch installing and upgrading the Agent
  4. On the Batch Modify Servers page, check the servers with ongoing tasks. If any inoperable servers are identified, rectify the fault by referring to Why Cannot I Install or Upgrade Agents in Batch?
  5. Click Next. The Install & Upgrade the Agent page is displayed.
    1. Select an installation method.
      • Install or upgrade the Agent to the latest version on all ECSs: Install the Agent for all ECSs that support one-click installation but without the Agent installed, and upgrade the Agent for all ECSs with the Agent installed.
      • Install the Agent: Install the Agent on all ECSs that support one-click installation but without the Agent installed.
      • Upgrade the Agent: Upgrade the Agent for all ECSs with the Agent installed.
    2. Select an Agent edition.
      • Basic edition provides basic OS monitoring metrics, including CPU, memory, file system, disk, NIC, and network metrics.
      • Enhanced edition provides GPU and BMS hardware monitoring, in addition to the capabilities provided in the basic edition.

      Install the Agent enhanced edition if you indeed need it, because it collects more metrics, which may occupy more server resources.

  6. Click OK.
  7. Check the Agent installation results.
    1. In the navigation pane, choose Task Center.
    2. In the right pane, click the Agent Maintenance tab to view the task status.
      • If Status is Successful, the Agent is installed. On the Server Monitoring page, check that the Agent status is Running and the Agent version is the latest.
      • If Status is Timeout, click Retry in the Operation column.

Installing the Agent on a Single Server

Prerequisites

  • You have modified DNS server addresses and added security group rules. For details, see How Do I Configure DNS and Security Groups?
  • You have configured an agency. For details, see How Do I Configure an Agency?
  • Ensure that you have the read and write permissions for the installation directory and the Telescope process is not stopped by other software after the installation (user root for Linux servers and user Administrator for Windows servers).

    You can only use the administrator account to install the Cloud Eye Agent. Any improper use of this account may cause system stability or data security issues. Exercise caution when using this account.

Procedure

  1. Log in to the Cloud Eye console.
  2. In the navigation pane, choose Server Monitoring > Elastic Cloud Server.
  3. Click Install Manually above the server list. The installation guide is displayed on the right.
    Figure 3 Agent installation guide
  4. Obtain the installation command.
    1. Select an OS for the server where the Agent is to be installed.
    2. Select Normal.
    3. Click next to the installation command to copy the command.
  5. Log in to a server.

    For Linux servers, see . For Windows servers, see Login Overview (Windows).

  6. Run the installation command obtained in 4.
    • Linux: Run the installation command as the root user.
    • Windows: Run the installation command as the Administrator user.
  7. Check the Agent installation results.
    • Linux: If Telescope process starts successfully. is displayed, the installation is successful. Wait for 3 to 5 minutes until the Agent collects monitoring data.
    • Windows: If the Agent status is Running, the Agent is installed and started.

Manually Installing the Agents in Batches

If multiple Linux servers are deployed in the same VPC and they do not support one-click installation, you can install the Agents for these servers in batches.

Constraints
  • Batch installation cannot be performed across regions.
  • The servers where the Agent is to be installed in a batch must be in the same VPC.
  • Agents cannot be installed on Windows servers in batches.

Prerequisites

To batch install the Agents, you can enter the IP address, port No., and root password or key of the servers on the management console, and then run the installation command.

  1. Log in to the Cloud Eye console.
  2. In the navigation pane, choose Server Monitoring > Elastic Cloud Server.
  1. Click Install Remotely to switch to the remote installation guide.
  2. Install the Agent as instructed.
    1. Select an Agent edition.
      • Basic edition provides basic OS monitoring metrics, including CPU, memory, file system, disk, NIC, and network metrics.
      • Enhanced edition provides GPU and BMS hardware monitoring, in addition to the capabilities provided in the basic edition.
    2. Select an installation server.
      • In the given VPC, select the server with the Agent installed as the installation server. Then use this server to install Agents on other servers in the same VPC. If there is no such an installation server, you can locate a server and choose More > Set Installation Server in the Operation column.
      • If none of the servers in the VPC has the Agent installed, select one to manually install the Agent. For details, see Installing the Agent on a Single Server.
    3. Set parameters for the servers for installing the Agent based on Table 2.
    Figure 4 Remote installation
    Table 2 Parameters for configuring servers

    Parameter

    Description

    Example Value

    Server IP Address

    IP address of the server for remotely installing the Agent.

    192.168.72.229

    Login Username

    Account for logging in to the server. The default value is root and cannot be changed.

    root

    Login Port

    Number of the port for remotely logging in to the server. The default value is 22. To change the remote login port, see How Can I Change a Remote Login Port?

    22

    Authentication

    Authentication mode for logging in to the server. You can select Password or SSH key.

    SSH key

    Password/SSH Key

    Enter the password or SSH key for logging in to the server.

    Example key:

    -----BEGIN RSA PRIVATE KEY-----

    ******

    -----END RSA PRIVATE KEY-----

    Operation

    Operations on server configurations. You can delete or copy the information.

    Copy
  3. After the configuration is complete, click OK.
  4. Check the Agent installation results.
    1. In the navigation pane, choose Task Center.
    2. In the right pane, click the Agent Maintenance tab to view the task status.
      • If Status is Successful, the Agent is installed. On the Server Monitoring page, check that the Agent status is Running and the Agent version is the latest.
      • If Status is Timeout, click Retry in the Operation column.

In the given VPC, you can log in to the server with the Agent installed and run the batch installation command to install the Agents.

  1. Log in to the Cloud Eye console.
  2. In the navigation pane, choose Server Monitoring > Elastic Cloud Server.
  3. Click Install Manually above the server list. The installation guide is displayed on the right.
  4. Obtain the installation command.
    1. Select Linux.
    2. Select Batch Installation.
    3. Click next to the installation command to copy the command.
      Figure 5 Obtaining the batch Agent installation command
  5. Log in to the ECS with the Agent installed as user root.

    For details, see Login Overview (Linux).

  6. After the login is successful, upload prepared files based on the login mode.
    • Username and password: As you have collected IP addresses of all ECSs and the password of user root, keep them in the iplist.txt file and upload them to the /usr/local directory on the first ECS.

      In the iplist.txt file, each line contains only one IP address in the IP address,Password of user root format.

      In the following example, abcd is the password.

      192.168.1.1,abcd
192.168.1.2,abcd
    • Key: As you have collected IP addresses of all ECSs, keep them in the iplist.txt file, upload them to the /usr/local directory on the first ECS, and uploaded the key file user.pem to the /usr/local directory on the ECS.

      In the iplist.txt file, each line contains only one IP address.

      Example:

      192.168.1.1
192.168.1.2
  7. Run the command obtained in 4 to install the Agents in batches.
  8. Check the Agent installation results.

    If the message "Telescope process starts successfully." is displayed, the installation is successful. Wait for 3 to 5 minutes, the Agent starts collecting monitoring data.

Helpful Links

What Are Agent Statuses and Troubleshooting Methods?

Why Is OS Monitoring Data Not Displayed Immediately After the Agent Is Installed and Configured or Not Displayed at All?

Parent Topic: Cloud Eye Plug-in (Agent)