Skip to content

Configuration Manual for Collector "Huawei Cloud - Gaussdb - Mysql"

Before reading this article, please read the following first:

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 complete list

The collector will automatically fetch all IAM projects under the region and then retrieve 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 a list of project IDs to collect data from within that region
Refer to the appendix for the complete list

2. Configuration Example

Specified Region

Collecting Gaussdb-Mysql instance data for projects in the cn-north-4 region.

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

3. Data Reporting Format

After data synchronization is successful, you can view the data in the 'Infrastructure - Resource Catalog' section of {{( brand_name )}}.

An example of reported data is as follows:

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_gaussdb_mysql",
  "tags": {
    "RegionId"                : "cn-north-4",
    "project_id"              : "c631f046252d4xxxxxxx5f253c62d48585",
    "name"                    : "2e10f990e139xxxxxx5fac6b59de7eein07",
    "enterprise_project_id"   : "0",
    "instance_id"             : "2e10f990e139xxxxxx5fac6b59de7eein07",
    "instance_name"           : "nosql-efa7",
    "status"                  : "BUILD"

  },
  "fields": {
    "db_user_name"            : "root",
    "port"                    : "3306",
    "type"                    : "Cluster",
    "vpc_id"                  : "f6bc2c55-2a95-xxxx-xxxx-7b09e9a8de13",
    "charge_info"             : "{Billing type information, supports annual/monthly subscription and pay-as-you-go, default is pay-as-you-go}",
    "create_time"             : "2023-08-01T14:17:40+0800",
    "update_time"             : "2023-08-01T14:17:42+0800",
    "private_ips"             : "[\"192.168.0.223\"]",
    "proxy_ips"               : "[]",
    "readonly_private_ips"    : "[Instance read internal IP address list]",
    "message"                 : "{Instance JSON data}"
  }
}

Fields in tags and fields may change with subsequent updates

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

The following fields are strings serialized in JSON format

  • fields.message
  • fields.charge_info
  • fields.private_ips
  • fields.proxy_ips
  • fields.readonly_private_ips

X. Appendix

Huawei Cloud Gaussdb-Mysql "Region ID"

Please refer to the official Huawei Cloud documentation: