Scenarios

After you install the Agent, configure it by clicking Restore Agent Configurations on the Cloud Eye console. If the Agent fails to be configured by clicking Restore Agent Configurations or due to other reasons, manually configure it by following the instructions provided in this topic.

This topic takes an ECS as an example. The operations for BMSs are similar.

Prerequisites

The Agent has been installed.

Procedure

1. Log in to an ECS as user root.
2. Run the following command to check the Telescope version:

   if [[ -f /usr/local/uniagent/extension/install/telescope/bin/telescope ]]; then /usr/local/uniagent/extension/install/telescope/bin/telescope -v; else echo 0; fi

   • If 0 is returned, the old Agent is used. For details about how to manually configure the Agent, see Procedure (Old Agent).
   • If other values are returned, the new Agent is used. For details about how to manually configure the Agent, see Procedure (New Agent).

Procedure (New Agent)

1. Log in to an ECS as user root.
2. Modify the conf.json file in the conf directory.
   1. Run the following command to open conf.json:

      vi /usr/local/uniagent/conf/conf.json

   2. Modify the parameters in the file. For details, see Table 1.

      ECS parameters

      {
          "Endpoint":"https://ces.XXXXXXXX.XXX.com",
          "InstanceId": "",
          "ProjectId": "",
          "AccessKey": "",
          "SecretKey": "",
          "AesSecretKey": "rfvt_huawei_iommuylpimafj1dagskm",   
      }

      Table 1 conf.json parameter description

      Parameter	Description
      Endpoint	Specifies the Cloud Eye endpoint URL in the region where the ECS or BMS is located. For example, if the ECS or BMS is located in region CN North-Beijing1, the value of Endpoint is ces.cn-north-1.myhuaweicloud.com.
      InstanceId	If you have logged in to a HUAWEI CLOUD ECS, retain the default value of InstanceId. If the server is not running on HUAWEI CLOUD, set this parameter to the server ID. The server ID must be able to identify the server and must be compliant with the following format: b96e7af6-afa6-469c-8532-201f1f93b233.
      ProjectId	If you have logged in to a HUAWEI CLOUD ECS, retain the default value of ProjectId. For other servers, obtain the value for this parameter by performing the following operations: Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials. Under Projects, obtain the project ID for the region where the ECS or BMS is located.
      AccessKey/SecretKey	If you have logged in to a HUAWEI CLOUD ECS, you do not need to set this parameter. For other servers, obtain the value for this parameter by performing the following operations: Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials. In the navigation pane on the left, choose Access Keys. If you have obtained the access key, obtain the AccessKey value and the SecretKey value in the credentials.csv file saved when you create Access Keys. If no access keys are available, click Create Access Key to create one. Save the credentials.csv file and obtain the AccessKey value and the SecretKey value in it. NOTICE: For the security purpose, you are advised to use an IAM username with the CES Administrator and LTS Administrator permissions. For details, see Creating a User Group and Assigning Permissions and Create IAM Users and Log In. The configured access key must be within the Access Keys list on the My Credentials page. Otherwise its authentication will fail and you cannot view OS monitoring data on Cloud Eye.
      AesSecretKey	Retain the default value rfvt_huawei_iommuylpimafj1dagskm.

3. Modify the conf.json file in the bin directory.
   1. Run the following command to open conf.json:

      vi /usr/local/uniagent/extension/install/telescope/bin/conf.json

   2. Modify the parameters in the file. For details, see Table 2.

      ECS parameters

      {
          "InstanceId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "ProjectId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "AccessKey": "XXXXXXXXXXXXXXXXXXXX",
          "SecretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "RegionId": "cn-east-3",
          "ClientPort": 0,
          "PortNum": 200
      }

Procedure (Old Agent)

1. Log in to an ECS as user root.
2. Run the following command to go to the Agent installation path bin:

   cd /usr/local/telescope/bin

3. Modify configuration file conf.json.
   1. Run the following command to open conf.json:

      vi conf.json

   2. Modify the parameters in the file. For details, see Table 2.
      ECS parameters

      {
          "InstanceId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "ProjectId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "AccessKey": "XXXXXXXXXXXXXXXXXXXX",
          "SecretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "RegionId": "cn-north-1",
          "ClientPort": 0,
          "PortNum": 200
      }

      BMS parameters

      {
          "InstanceId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "ProjectId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "AccessKey": "XXXXXXXXXXXXXXXXXXXX",
          "SecretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "RegionId": "cn-north-1",
          "ClientPort": 0,
          "PortNum": 200,
          "BmsFlag": true
      }

      Table 2 Public parameters

      Parameter	Description
      InstanceId	(Optional) Specifies the ECS ID. You can log in to the management console and view the ECS ID in the ECS list. NOTE: If you do not configure InstanceId, retain "InstanceId":"". If you configure it, ensure that the following two requirements are met: The ECS ID must be unique at all sites, that is, in the same region, InstanceId used by the Agent cannot be the same. Otherwise, errors may occur. The InstanceId value must be consistent with the actual ECS or BMS ID. Otherwise, you cannot see the OS monitoring data on Cloud Eye.
      ProjectId	(Optional) Specifies the project ID. If you do not configure ProjectId, retain "ProjectId": "". If you configure it, perform the following operations: Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials. Under Projects, obtain the project ID for the region where the ECS or BMS is located.
      AccessKey/SecretKey	Specifies the access keys, which can be obtained by performing the following operations: Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials. In the navigation pane on the left, choose Access Keys. If you have obtained the access key, obtain the AccessKey value and the SecretKey value in the credentials.csv file saved when you create Access Keys. If no access keys are available, click Create Access Key to create one. Save the credentials.csv file and obtain the AccessKey value and the SecretKey value in it. NOTICE: For the security purpose, you are advised to use an IAM username with the CES Administrator and LTS Administrator permissions. For details, see Creating a User Group and Assigning Permissions and Create IAM Users and Log In. The configured access key must be within the Access Keys list on the My Credentials page. Otherwise its authentication will fail and you cannot view OS monitoring data on Cloud Eye.
      RegionId	Specifies the region ID. For example, if the ECS or BMS is located in region CN North-Beijing1, the value of RegionId is cn-north-1. For IDs of other regions, see https://developer.huaweicloud.com/endpoint.
      ClientPort	Specifies the start port number used by the Agent. NOTE: The default value is 0, indicating that the Agent will randomly use any port. Ports 1 to 1023 are reserved. You are advised not to specify a port in this range for the Agent.
      PortNum	Specifies the number of ports configured for the Agent. NOTE: The default value is 200. If the value of ClientPort is 5000, the port range will be 5000 to 5199.
      BmsFlag	Set this parameter to true for a BMS. This parameter is not required by an ECS. You do not need to set this parameter for the Windows OS.

4. Modify configuration file conf_ces.json for the Cloud Eye metric collection module.
   1. Run the following command to open public configuration file conf_ces.json:

      vi conf_ces.json

   2. Modify the endpoint in conf_ces.json, and save the conf_ces.json file. For details, see Table 3.

      {
        "Endpoint": "https://ces.cn-north-1.myhuaweicloud.com"
      }

      Table 3 Parameter setting of the metric collection module

      Parameter	Description
      Endpoint	Specifies the Cloud Eye endpoint URL in the region of the ECS or BMS. For example, if the ECS or BMS is in the CN North-Beijing1 region, the URL is ces.cn-north-1.myhuaweicloud.com. For the endpoint values of other regions, log in at https://developer.huaweicloud.com/endpoint.

      

      • After the Agent is configured, its status is still displayed as Uninstalled because no monitoring data is reported yet. Wait 3 to 5 minutes and refresh the page.
      • If the Agent is in the Running state, the Agent has been installed and has started to collect fine-grained metric data.