Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

(Optional) Manually Configuring the Agent (Linux)

Updated on 2025-01-14 GMT+08:00

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

You have installed the Agent.

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

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.
      NOTICE:

      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

      (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

      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 (Agent of the Earlier Version)

  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

      (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

      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.

      NOTE:
      • 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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback