Skip to content

Configuration Manual for the "Huawei Cloud-SFS" Collector

Before reading this article, 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. For example: 'cn-north-4'
Refer to the appendix for the full list

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

Configuration Two (Backward 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 (for example: 'cn-north-4')
Value represents the list of project IDs to be collected in that region
Refer to the appendix for the full list

2. Configuration Example

Specify Region

Collect SFS instance data for projects corresponding to the cn-north-4 region.

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

3. Data Reporting Format

After the data is synchronized successfully, you can view it 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
{
  "measurement": "huaweicloud_sfs",
  "tags": {
    "RegionId"             : "cn-north-4",
    "project_id"           : "15c6ce1c12da4059a8382076643ac2b9",
    "enterprise_project_id": "0",
    "name"                 : "54d0bac6-45c8-471c-bf0d-16ffd81ef88a",
    "instance_id"          : "54d0bac6-45c8-471c-bf0d-16ffd81ef88a",
    "instance_name"        : "cl01",
    "status"               : "available"
  },
  "fields": {
    "availability_zone"    : "az1.dc1",
    "description"          : "test description",
    "host"                 : "xxx",
    "is_public"            : "False",
    "share_proto"          : "NFS",
    "share_type"           : "default",
    "volume_type"          : "default",
    "share_server_id"      : "9656beb1-7ce2-4c46-9911-ecd51ab632bf",
    "created_at"           : "2017-07-07T03:15:06.858662",
    "links"                : "{Shared Link JSON Data}",
    "size"                 : 1,
    "message"              : "{Instance JSON Data}"
  }
}

Fields in tags and fields may change with subsequent updates

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

The following fields are serialized JSON strings

  • fields.message
  • fields.links

X. Appendix

Please refer to the official Huawei Cloud documentation: