(Optional) Manually Configuring the Agent (Linux)

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.

Prerequisites

The Agent has been installed.

Checking the Version of the Agent In Use

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

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

   • If old agent is returned, the early version of the Agent is used. For details about how to manually configure the Agent, see Procedure (for the Early Version of the Agent).
   • If a version is returned, the new version of the Agent is used. For details about how to manually configure the Agent, see Procedure (for the New Version of the Agent).
   • If 0 is returned, the Agent is not installed.

Procedure (for the New Version of the Agent)

1. Log in to an ECS as user root.
2. Modify the conf.json file in the bin directory.
   1. Open conf.json:

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

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

      Storing plaintext AKs and SKs poses great security risks. You are advised to delegate all ECS or BMS Agents in the region. For details, see How Do I Configure an Agency?

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

      Table 1 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	Specifies the project ID. You do not need to configure ProjectId. Retain "ProjectId": "". If you wish to 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	To obtain the AK and SK, perform the following operations: Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials, and 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, use an IAM username with the CES Administrator and LTS Administrator permissions. 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 the CN-Hong Kong region, RegionId is ap-southeast-1. For IDs of other regions, see https://developer.huaweicloud.com/intl/en-us/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 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.

Procedure (for the Early Version of the Agent)

1. Log in to an ECS as user root.
2. Go to the Agent installation path bin:

   cd /usr/local/uniagent/extension/install/telescope/bin

3. Modify configuration file conf.json.
   1. 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": "ap-southeast-1",
          "ClientPort": 0,
          "PortNum": 200
      }

      BMS parameters

      {
          "InstanceId":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "ProjectId": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "AccessKey": "XXXXXXXXXXXXXXXXXXXX",
          "SecretKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "RegionId": "ap-southeast-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	Specifies the project ID. You do not need to configure ProjectId. Retain "ProjectId": "". If you wish to 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	To obtain the AK and SK, perform the following operations: Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials, and 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, use an IAM username with the CES Administrator and LTS Administrator permissions.. 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 the CN-Hong Kong region, RegionId is ap-southeast-1. For IDs of other regions, see https://developer.huaweicloud.com/intl/en-us/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 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.ap-southeast-1.myhuaweicloud.com"
      }

      Table 3 Parameter setting of the metric collection module

      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 in the CN-Hong Kong region, Endpoint is ces.ap-southeast-1.myhwclouds.com. For the endpoint values of other regions, see https://developer.huaweicloud.com/intl/en-us/endpoint.

      

      • After you configure the Agent, its status is still displayed as Uninstalled because the monitoring data is not 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.