Skip to content

Collector Configuration Manual for "Huawei Cloud-CSS"

Before reading this, please first read:

Before using this collector, you must install the 'Integration Core Package' and its associated third-party dependency packages

1. Configuration Structure

The configuration structure of this collector is as follows:

Configuration One (Recommended)

Field Type Required Description
regions list Required List of regions to collect data from
regions[#] str Required Region ID. Example: 'cn-north-4'
Refer to appendix for full list

The collector will automatically retrieve all IAM projects under the region and then obtain resources based on IAM projects

Configuration Two (Legacy Compatibility)

Field Type Required Description
region_projects dict Required List of 'Region - Project ID' pairs for data collection
region_projects[#] str:list Required Key-value pairs where:
Key represents the region (e.g., 'cn-north-4')
Value represents the list of project IDs to be collected under that region
Refer to appendix for full list

2. Configuration Example

Specifying Regions

Collect resources corresponding to projects under the cn-north-4 region.

Python
1
2
3
collector_configs = {
    'regions': ['cn-north-4']
}

3. Data Reporting Format

After data synchronization, it can be viewed in the "Infrastructure - Resource Catalog" section of {{( brand_name }}}.

Example of reported data:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "measurement": "huaweicloud_css",
  "tags": {
    "RegionId"                   : "cn-north-4",
    "project_id"                 : "xxxxxxx",
    "enterpriseProjectId"        : "0",
    "name"                       : "xxxxx",
    "instance_id"                : "xxxxx",
    "instance_name"              : "css-3384",
    "publicIp"                   : "xx.xx.xx.xxx",
    "status"                     : "100",
    "endpoint"                   : "192.168.0.100:9200"
  },
  "fields": {
    "vpc_id"                     : "3dda7d4b-aec0-4838-a91a-28xxxxxxxx",
    "subnetId"                   : "xxxxx",
    "securityGroupId"            : "xxxxxxx",
    "datastore"                  : "{\"supportSecuritymode\": false, \"type\": \"elasticsearch\", \"version\": \"7.6.2\"}",
    "instances"                  : "[{\"azCode\": \"cn-east-3a\", \"id\": \"95f61e90-507b-48d4-8ac5-53dcefd155a3\", \"ip\": \"192.168.0.140\", \"name\": \"css-test-ess-esn-1-1\", \"specCode\": \"ess.spec-kc1.xlarge.2\", \"status\": \"200\", \"type\": \"ess\", \"volume\": {\"size\": 40, \"type\": \"HIGH\"}}]",
    "publicKibanaResp"           : "xxxx",
    "elbWhiteList"               : "xxxx",
    "updated"                    : "2023-06-27T07:35:29",
    "created"                    : "2023-06-27T07:35:29",
    "bandwidthSize"              : "100",
    "actions"                    : "REBOOTING",
    "tags"                       : "xxxx",
    "period"                     : true
  }
}

Descriptions of some parameters are as follows:

Parameter Name Description
status Cluster status value
updated Last modification time of the cluster, ISO8601 format
bandwidthSize Public bandwidth size, unit: Mbit/s
actions Current behavior of the cluster
period Whether it is a subscription-based cluster

Meaning of values for status (cluster status value):

Value Description
100 Creating
200 Available
303 Unavailable

Meaning of values for actions (current cluster behavior):

Value Description
REBOOTING Rebooting
GROWING Scaling up
RESTORING Restoring cluster
SNAPSHOTTING Creating snapshot

Meaning of values for period:

Value Description
true Subscription billing cluster
false Pay-as-you-go billing cluster

Fields in tags and fields may change with subsequent updates

The value of tags.name is the cluster ID, used as a unique identifier

X. Appendix

Huawei Cloud CSS "Region ID"

Refer to Huawei Cloud's official documentation: