(Optional) Manually Configuring the Agent (Windows)

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.

Constraints

The Agent cannot be installed on the Windows BMSs.

Only Windows and Linux OSs are supported. For details, see What OSs Does the Agent Support?

Prerequisites

The Agent has been installed.

Procedure

  1. Log in to an ECS as user root.
  2. Check the installation path and the Telescope version.

Procedure (New Telescope)

  1. Log in to the ECS.
  2. Open the conf.json file in the C:\Program Files\uniagent\conf folder.
  3. Set the following parameters. 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:

    1. Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials.
    2. 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.

  4. Open the conf.json file in the C:\Program Files\uniagent\extension\install\telescope\bin folder.
  5. Set the following parameters. 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
    }
    • 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.

Procedure (Old Telescope)

  1. Log in to the ECS.
  2. Open the conf.json file in the telescope_windows_amd64\bin folder.
  3. Set the following parameters. For details, see Table 2.
    {
        "InstanceId":"",
        "ProjectId": "",
        "AccessKey": "",
        "SecretKey": "",
        "RegionId": "cn-north-1",
        "ClientPort": 0,
        "PortNum": 200
    }

    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:

    1. Log in to the Cloud Eye console, click the username in the upper right corner, and choose My Credentials.
    2. 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. Wait for a few minutes, if Agent Status is Running, the Agent has been installed and starts to collect fine-grained metric data.